Class: Verizon::DeviceResetRequest

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

Overview

Request body to Performs a device reboot.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(account_name = SKIP, action = SKIP, devices = SKIP) ⇒ DeviceResetRequest

Returns a new instance of DeviceResetRequest.



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

def initialize( = SKIP, action = SKIP, devices = SKIP)
  @account_name =  unless  == SKIP
  @action = action unless action == SKIP
  @devices = devices unless devices == SKIP
end

Instance Attribute Details

#account_name ⇒ String

The name of the account. An account name is usually numeric, and must include any leading zeros.

Returns:

  • (String) 


15
16
17
 
# File 'lib/verizon/models/device_reset_request.rb', line 15

def 
  @account_name
end

#action ⇒ String

The action you want to take on the device.

Returns:

  • (String) 


19
20
21
 
# File 'lib/verizon/models/device_reset_request.rb', line 19

def action
  @action
end

#devices ⇒ Array[Device]

The devices for which you want to perform a factory reset or reboot.

Returns:



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

def devices
  @devices
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_reset_request.rb', line 55

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   = hash.key?('accountName') ? hash['accountName'] : SKIP
  action = hash.key?('action') ? hash['action'] : SKIP
  # Parameter is an array, so we need to iterate through it
  devices = nil
  unless hash['devices'].nil?
    devices = []
    hash['devices'].each do |structure|
      devices << (Device.from_hash(structure) if structure)
    end
  end

  devices = SKIP unless hash.key?('devices')

  # Create object from extracted values.
  DeviceResetRequest.new(,
                         action,
                         devices)
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_reset_request.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_name'] = 'accountName'
  @_hash['action'] = 'action'
  @_hash['devices'] = 'devices'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/verizon/models/device_reset_request.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_reset_request.rb', line 35

def self.optionals
  %w[
    account_name
    action
    devices
  ]
end