Class: Verizon::UsageRequestBody

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

Overview

UsageRequestBody Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(account_id = SKIP, device_id = SKIP, start_time = SKIP, end_time = SKIP) ⇒ UsageRequestBody

Returns a new instance of UsageRequestBody.



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

def initialize( = SKIP,
               device_id = SKIP,
               start_time = SKIP,
               end_time = SKIP)
  @account_id =  unless  == SKIP
  @device_id = device_id unless device_id == SKIP
  @start_time = start_time unless start_time == SKIP
  @end_time = end_time unless end_time == SKIP
end

Instance Attribute Details

#account_id ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def 
  @account_id
end

#device_id ⇒ Array[ReadySimDeviceId]

TODO: Write general description for this method

Returns:



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

def device_id
  @device_id
end

#end_time ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


27
28
29
 
# File 'lib/verizon/models/usage_request_body.rb', line 27

def end_time
  @end_time
end

#start_time ⇒ DateTime

TODO: Write general description for this method

Returns:

  • (DateTime) 


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

def start_time
  @start_time
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
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/verizon/models/usage_request_body.rb', line 65

def self.from_hash(hash)
  return nil unless hash

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

  device_id = SKIP unless hash.key?('deviceId')
  start_time = if hash.key?('startTime')
                 (DateTimeHelper.from_rfc3339(hash['startTime']) if hash['startTime'])
               else
                 SKIP
               end
  end_time = if hash.key?('endTime')
               (DateTimeHelper.from_rfc3339(hash['endTime']) if hash['endTime'])
             else
               SKIP
             end

  # Create object from extracted values.
  UsageRequestBody.new(,
                       device_id,
                       start_time,
                       end_time)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_id'] = 'accountId'
  @_hash['device_id'] = 'deviceId'
  @_hash['start_time'] = 'startTime'
  @_hash['end_time'] = 'endTime'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    account_id
    device_id
    start_time
    end_time
  ]
end

Instance Method Details

#to_custom_end_time ⇒ Object 



102
103
104
 
# File 'lib/verizon/models/usage_request_body.rb', line 102

def to_custom_end_time
  DateTimeHelper.to_rfc3339(end_time)
end

#to_custom_start_time ⇒ Object 



98
99
100
 
# File 'lib/verizon/models/usage_request_body.rb', line 98

def to_custom_start_time
  DateTimeHelper.to_rfc3339(start_time)
end