Class: Verizon::ConsentRequest

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

Overview

ConsentRequest 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_name = nil, all_device = SKIP, type = SKIP, exclusion = SKIP) ⇒ ConsentRequest

Returns a new instance of ConsentRequest.



52
53
54
55
56
57
58
59
60
# File 'lib/verizon/models/consent_request.rb', line 52

def initialize( = nil,
               all_device = SKIP,
               type = SKIP,
               exclusion = SKIP)
  @account_name = 
  @all_device = all_device unless all_device == SKIP
  @type = type unless type == SKIP
  @exclusion = exclusion unless exclusion == SKIP
end

Instance Attribute Details

#account_nameString

Account identifier in “##########-#####”.

Returns:

  • (String)


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

def 
  @account_name
end

#all_deviceTrueClass | FalseClass

Exclude all devices or not.

Returns:

  • (TrueClass | FalseClass)


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

def all_device
  @all_device
end

#exclusionArray[String]

Device ID list.

Returns:

  • (Array[String])


26
27
28
# File 'lib/verizon/models/consent_request.rb', line 26

def exclusion
  @exclusion
end

#typeString

The change to make: append or replace.

Returns:

  • (String)


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

def type
  @type
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   = hash.key?('accountName') ? hash['accountName'] : nil
  all_device = hash.key?('allDevice') ? hash['allDevice'] : SKIP
  type = hash.key?('type') ? hash['type'] : SKIP
  exclusion = hash.key?('exclusion') ? hash['exclusion'] : SKIP

  # Create object from extracted values.
  ConsentRequest.new(,
                     all_device,
                     type,
                     exclusion)
end

.namesObject

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_name'] = 'accountName'
  @_hash['all_device'] = 'allDevice'
  @_hash['type'] = 'type'
  @_hash['exclusion'] = 'exclusion'
  @_hash
end

.nullablesObject

An array for nullable fields



48
49
50
# File 'lib/verizon/models/consent_request.rb', line 48

def self.nullables
  []
end

.optionalsObject

An array for optional fields



39
40
41
42
43
44
45
# File 'lib/verizon/models/consent_request.rb', line 39

def self.optionals
  %w[
    all_device
    type
    exclusion
  ]
end