Class: Verizon::GIOSMSSendRequest

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

Overview

GIOSMSSendRequest Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(device_ids = nil, sms_message = nil, account_name = SKIP, custom_fields = SKIP, data_encoding = SKIP, group_name = SKIP, service_plan = SKIP, time_to_live = SKIP) ⇒ GIOSMSSendRequest

Returns a new instance of GIOSMSSendRequest.



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/verizon/models/giosms_send_request.rb', line 75

def initialize(device_ids = nil, sms_message = nil,  = SKIP,
               custom_fields = SKIP, data_encoding = SKIP,
               group_name = SKIP, service_plan = SKIP, time_to_live = SKIP)
  @account_name =  unless  == SKIP
  @custom_fields = custom_fields unless custom_fields == SKIP
  @data_encoding = data_encoding unless data_encoding == SKIP
  @group_name = group_name unless group_name == SKIP
  @service_plan = service_plan unless service_plan == SKIP
  @time_to_live = time_to_live unless time_to_live == SKIP
  @device_ids = device_ids
  @sms_message = sms_message
end

Instance Attribute Details

#account_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def 
  @account_name
end

#custom_fields ⇒ Array[KvPair]

TODO: Write general description for this method

Returns:



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

def custom_fields
  @custom_fields
end

#data_encoding ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def data_encoding
  @data_encoding
end

#device_ids ⇒ Array[GIODeviceId]

TODO: Write general description for this method

Returns:



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

def device_ids
  @device_ids
end

#group_name ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def group_name
  @group_name
end

#service_plan ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


30
31
32
 
# File 'lib/verizon/models/giosms_send_request.rb', line 30

def service_plan
  @service_plan
end

#sms_message ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


42
43
44
 
# File 'lib/verizon/models/giosms_send_request.rb', line 42

def sms_message
  @sms_message
end

#time_to_live ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


34
35
36
 
# File 'lib/verizon/models/giosms_send_request.rb', line 34

def time_to_live
  @time_to_live
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/verizon/models/giosms_send_request.rb', line 89

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
  device_ids = nil
  unless hash['deviceIds'].nil?
    device_ids = []
    hash['deviceIds'].each do |structure|
      device_ids << (GIODeviceId.from_hash(structure) if structure)
    end
  end

  device_ids = nil unless hash.key?('deviceIds')
  sms_message = hash.key?('smsMessage') ? hash['smsMessage'] : nil
   = hash.key?('accountName') ? hash['accountName'] : 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 << (KvPair.from_hash(structure) if structure)
    end
  end

  custom_fields = SKIP unless hash.key?('customFields')
  data_encoding = hash.key?('dataEncoding') ? hash['dataEncoding'] : SKIP
  group_name = hash.key?('groupName') ? hash['groupName'] : SKIP
  service_plan = hash.key?('servicePlan') ? hash['servicePlan'] : SKIP
  time_to_live = hash.key?('timeToLive') ? hash['timeToLive'] : SKIP

  # Create object from extracted values.
  GIOSMSSendRequest.new(device_ids,
                        sms_message,
                        ,
                        custom_fields,
                        data_encoding,
                        group_name,
                        service_plan,
                        time_to_live)
end

.names ⇒ Object

A mapping from model property names to API property names.



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/verizon/models/giosms_send_request.rb', line 45

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_name'] = 'accountName'
  @_hash['custom_fields'] = 'customFields'
  @_hash['data_encoding'] = 'dataEncoding'
  @_hash['group_name'] = 'groupName'
  @_hash['service_plan'] = 'servicePlan'
  @_hash['time_to_live'] = 'timeToLive'
  @_hash['device_ids'] = 'deviceIds'
  @_hash['sms_message'] = 'smsMessage'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



71
72
73
 
# File 'lib/verizon/models/giosms_send_request.rb', line 71

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/verizon/models/giosms_send_request.rb', line 59

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