Class: IntegrationApi::SMS

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/models/sms.rb

Overview

SMS Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SMS

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/integration_api/models/sms.rb', line 109

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

  if attributes.has_key?(:'delivery_status')
    self.delivery_status = attributes[:'delivery_status']
  end

  if attributes.has_key?(:'delivery_status_timestamp')
    self.delivery_status_timestamp = attributes[:'delivery_status_timestamp']
  end

  if attributes.has_key?(:'from')
    self.from = attributes[:'from']
  end

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'nucleus_business_id')
    self.nucleus_business_id = attributes[:'nucleus_business_id']
  end

  if attributes.has_key?(:'nucleus_client_id')
    self.nucleus_client_id = attributes[:'nucleus_client_id']
  end

  if attributes.has_key?(:'reply_message')
    self.reply_message = attributes[:'reply_message']
  end

  if attributes.has_key?(:'secondary_id')
    self.secondary_id = attributes[:'secondary_id']
  end

  if attributes.has_key?(:'sms_id')
    self.sms_id = attributes[:'sms_id']
  end

  if attributes.has_key?(:'to')
    self.to = attributes[:'to']
  end

  if attributes.has_key?(:'type')
    self.type = attributes[:'type']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end

  if attributes.has_key?(:'vendor_account_id')
    self. = attributes[:'vendor_account_id']
  end

  if attributes.has_key?(:'vendor_id')
    self.vendor_id = attributes[:'vendor_id']
  end

  if attributes.has_key?(:'vendor_name')
    self.vendor_name = attributes[:'vendor_name']
  end

  if attributes.has_key?(:'vendor_sms_id')
    self.vendor_sms_id = attributes[:'vendor_sms_id']
  end
end

Instance Attribute Details

#create_date ⇒ Object

Returns the value of attribute create_date.



18
19
20
 
# File 'lib/integration_api/models/sms.rb', line 18

def create_date
  @create_date
end

#delivery_status ⇒ Object

deliveryStatus



21
22
23
 
# File 'lib/integration_api/models/sms.rb', line 21

def delivery_status
  @delivery_status
end

#delivery_status_timestamp ⇒ Object

deliveryStatusTimestamp



24
25
26
 
# File 'lib/integration_api/models/sms.rb', line 24

def delivery_status_timestamp
  @delivery_status_timestamp
end

#from ⇒ Object

from



27
28
29
 
# File 'lib/integration_api/models/sms.rb', line 27

def from
  @from
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/integration_api/models/sms.rb', line 29

def id
  @id
end

#nucleus_business_id ⇒ Object

nucleusBusinessId



32
33
34
 
# File 'lib/integration_api/models/sms.rb', line 32

def nucleus_business_id
  @nucleus_business_id
end

#nucleus_client_id ⇒ Object

nucleusClientId



35
36
37
 
# File 'lib/integration_api/models/sms.rb', line 35

def nucleus_client_id
  @nucleus_client_id
end

#reply_message ⇒ Object

replyMessage



38
39
40
 
# File 'lib/integration_api/models/sms.rb', line 38

def reply_message
  @reply_message
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



40
41
42
 
# File 'lib/integration_api/models/sms.rb', line 40

def secondary_id
  @secondary_id
end

#sms_id ⇒ Object

Returns the value of attribute sms_id.



42
43
44
 
# File 'lib/integration_api/models/sms.rb', line 42

def sms_id
  @sms_id
end

#to ⇒ Object

to



45
46
47
 
# File 'lib/integration_api/models/sms.rb', line 45

def to
  @to
end

#type ⇒ Object

type



48
49
50
 
# File 'lib/integration_api/models/sms.rb', line 48

def type
  @type
end

#update_date ⇒ Object

Returns the value of attribute update_date.



50
51
52
 
# File 'lib/integration_api/models/sms.rb', line 50

def update_date
  @update_date
end

#vendor_account_id ⇒ Object

Returns the value of attribute vendor_account_id.



52
53
54
 
# File 'lib/integration_api/models/sms.rb', line 52

def 
  @vendor_account_id
end

#vendor_id ⇒ Object

vendorId



55
56
57
 
# File 'lib/integration_api/models/sms.rb', line 55

def vendor_id
  @vendor_id
end

#vendor_name ⇒ Object

Returns the value of attribute vendor_name.



57
58
59
 
# File 'lib/integration_api/models/sms.rb', line 57

def vendor_name
  @vendor_name
end

#vendor_sms_id ⇒ Object

Returns the value of attribute vendor_sms_id.



59
60
61
 
# File 'lib/integration_api/models/sms.rb', line 59

def vendor_sms_id
  @vendor_sms_id
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/integration_api/models/sms.rb', line 62

def self.attribute_map
  {
    :'create_date' => :'create_date',
    :'delivery_status' => :'delivery_status',
    :'delivery_status_timestamp' => :'delivery_status_timestamp',
    :'from' => :'from',
    :'id' => :'id',
    :'nucleus_business_id' => :'nucleus_business_id',
    :'nucleus_client_id' => :'nucleus_client_id',
    :'reply_message' => :'reply_message',
    :'secondary_id' => :'secondary_id',
    :'sms_id' => :'sms_id',
    :'to' => :'to',
    :'type' => :'type',
    :'update_date' => :'update_date',
    :'vendor_account_id' => :'vendor_account_id',
    :'vendor_id' => :'vendor_id',
    :'vendor_name' => :'vendor_name',
    :'vendor_sms_id' => :'vendor_sms_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/integration_api/models/sms.rb', line 85

def self.swagger_types
  {
    :'create_date' => :'DateTime',
    :'delivery_status' => :'String',
    :'delivery_status_timestamp' => :'DateTime',
    :'from' => :'String',
    :'id' => :'String',
    :'nucleus_business_id' => :'String',
    :'nucleus_client_id' => :'String',
    :'reply_message' => :'String',
    :'secondary_id' => :'String',
    :'sms_id' => :'String',
    :'to' => :'String',
    :'type' => :'String',
    :'update_date' => :'DateTime',
    :'vendor_account_id' => :'String',
    :'vendor_id' => :'String',
    :'vendor_name' => :'String',
    :'vendor_sms_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/integration_api/models/sms.rb', line 199

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      create_date == o.create_date &&
      delivery_status == o.delivery_status &&
      delivery_status_timestamp == o.delivery_status_timestamp &&
      from == o.from &&
      id == o.id &&
      nucleus_business_id == o.nucleus_business_id &&
      nucleus_client_id == o.nucleus_client_id &&
      reply_message == o.reply_message &&
      secondary_id == o.secondary_id &&
      sms_id == o.sms_id &&
      to == o.to &&
      type == o.type &&
      update_date == o.update_date &&
       == o. &&
      vendor_id == o.vendor_id &&
      vendor_name == o.vendor_name &&
      vendor_sms_id == o.vendor_sms_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/integration_api/models/sms.rb', line 257

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = IntegrationApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/integration_api/models/sms.rb', line 323

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/integration_api/models/sms.rb', line 236

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


223
224
225
 
# File 'lib/integration_api/models/sms.rb', line 223

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



229
230
231
 
# File 'lib/integration_api/models/sms.rb', line 229

def hash
  [create_date, delivery_status, delivery_status_timestamp, from, id, nucleus_business_id, nucleus_client_id, reply_message, secondary_id, sms_id, to, type, update_date, , vendor_id, vendor_name, vendor_sms_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



186
187
188
189
 
# File 'lib/integration_api/models/sms.rb', line 186

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



303
304
305
 
# File 'lib/integration_api/models/sms.rb', line 303

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



309
310
311
312
313
314
315
316
317
 
# File 'lib/integration_api/models/sms.rb', line 309

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



297
298
299
 
# File 'lib/integration_api/models/sms.rb', line 297

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



193
194
195
 
# File 'lib/integration_api/models/sms.rb', line 193

def valid?
  true
end