Class: Verizon::DeleteDevicesRequest

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

Overview

Request to delete a device request.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(devices_to_delete = nil, account_name = SKIP) ⇒ DeleteDevicesRequest

Returns a new instance of DeleteDevicesRequest.



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

def initialize(devices_to_delete = nil,
                = SKIP)
  @devices_to_delete = devices_to_delete
  @account_name =  unless  == SKIP
end

Instance Attribute Details

#account_nameString

The Verizon billing account that the device group belongs to. An account name is usually numeric, and must include any leading zeros.

Returns:

  • (String)


20
21
22
# File 'lib/verizon/models/delete_devices_request.rb', line 20

def 
  @account_name
end

#devices_to_deleteArray[AccountDeviceList]

A list of up to 100 devices that you want to delete, specified by device identifier. You only need to provide one identifier per device.

Returns:



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

def devices_to_delete
  @devices_to_delete
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
# File 'lib/verizon/models/delete_devices_request.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  devices_to_delete = nil
  unless hash['devicesToDelete'].nil?
    devices_to_delete = []
    hash['devicesToDelete'].each do |structure|
      devices_to_delete << (AccountDeviceList.from_hash(structure) if structure)
    end
  end

  devices_to_delete = nil unless hash.key?('devicesToDelete')
   = hash.key?('accountName') ? hash['accountName'] : SKIP

  # Create object from extracted values.
  DeleteDevicesRequest.new(devices_to_delete,
                           )
end

.namesObject

A mapping from model property names to API property names.



23
24
25
26
27
28
# File 'lib/verizon/models/delete_devices_request.rb', line 23

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

.nullablesObject

An array for nullable fields



38
39
40
# File 'lib/verizon/models/delete_devices_request.rb', line 38

def self.nullables
  []
end

.optionalsObject

An array for optional fields



31
32
33
34
35
# File 'lib/verizon/models/delete_devices_request.rb', line 31

def self.optionals
  %w[
    account_name
  ]
end