Class: Freeclimb::MessageResult

Inherits:
Object
  • Object
show all
Defined in:
lib/freeclimb/models/message_result.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ MessageResult

Initializes the object

Parameters:

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

    Model attributes in the form of hash



177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/freeclimb/models/message_result.rb', line 177

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::MessageResult` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if !self.class.attribute_map.key?(k.to_sym)
      fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::MessageResult`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:uri)
    self.uri = attributes[:uri]
  end

  if attributes.key?(:date_created)
    self.date_created = attributes[:date_created]
  end

  if attributes.key?(:date_updated)
    self.date_updated = attributes[:date_updated]
  end

  if attributes.key?(:revision)
    self.revision = attributes[:revision]
  end

  if attributes.key?(:account_id)
    self. = attributes[:account_id]
  end

  if attributes.key?(:message_id)
    self.message_id = attributes[:message_id]
  end

  if attributes.key?(:status)
    self.status = attributes[:status]
  end

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

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

  if attributes.key?(:text)
    self.text = attributes[:text]
  end

  if attributes.key?(:direction)
    self.direction = attributes[:direction]
  end

  if attributes.key?(:notification_url)
    self.notification_url = attributes[:notification_url]
  end

  if attributes.key?(:brand_id)
    self.brand_id = attributes[:brand_id]
  end

  if attributes.key?(:campaign_id)
    self.campaign_id = attributes[:campaign_id]
  end

  if attributes.key?(:segment_count)
    self.segment_count = attributes[:segment_count]
  end

  if attributes.key?(:media_urls)
    if (value = attributes[:media_urls]).is_a?(Array)
      self.media_urls = value
    end
  end

  if attributes.key?(:tfn)
    self.tfn = attributes[:tfn]
  end

  if attributes.key?(:phone_number_id)
    self.phone_number_id = attributes[:phone_number_id]
  end

  if attributes.key?(:application_id)
    self.application_id = attributes[:application_id]
  end
end

Instance Attribute Details

#account_id ⇒ Object

String that uniquely identifies this account resource.



29
30
31
 
# File 'lib/freeclimb/models/message_result.rb', line 29

def 
  @account_id
end

#application_id ⇒ Object

String that uniquely identifies the Application resource used to send this Message



69
70
71
 
# File 'lib/freeclimb/models/message_result.rb', line 69

def application_id
  @application_id
end

#brand_id ⇒ Object

The unique identifier for the brand associated with the message



52
53
54
 
# File 'lib/freeclimb/models/message_result.rb', line 52

def brand_id
  @brand_id
end

#campaign_id ⇒ Object

The unique identifier for the campaign associated with the message



55
56
57
 
# File 'lib/freeclimb/models/message_result.rb', line 55

def campaign_id
  @campaign_id
end

#date_created ⇒ Object

The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



20
21
22
 
# File 'lib/freeclimb/models/message_result.rb', line 20

def date_created
  @date_created
end

#date_updated ⇒ Object

The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT).



23
24
25
 
# File 'lib/freeclimb/models/message_result.rb', line 23

def date_updated
  @date_updated
end

#direction ⇒ Object

Noting whether the message was inbound or outbound



46
47
48
 
# File 'lib/freeclimb/models/message_result.rb', line 46

def direction
  @direction
end

#from ⇒ Object

Phone number in E.164 format that sent the message.



37
38
39
 
# File 'lib/freeclimb/models/message_result.rb', line 37

def from
  @from
end

#media_urls ⇒ Object

an array of HTTP URLs which were attached this this message



61
62
63
 
# File 'lib/freeclimb/models/message_result.rb', line 61

def media_urls
  @media_urls
end

#message_id ⇒ Object

String that uniquely identifies this message resource



32
33
34
 
# File 'lib/freeclimb/models/message_result.rb', line 32

def message_id
  @message_id
end

#notification_url ⇒ Object

URL invoked when message sent



49
50
51
 
# File 'lib/freeclimb/models/message_result.rb', line 49

def notification_url
  @notification_url
end

#phone_number_id ⇒ Object

String that uniquely identifies the phoneNumber resource used to send this Message



66
67
68
 
# File 'lib/freeclimb/models/message_result.rb', line 66

def phone_number_id
  @phone_number_id
end

#revision ⇒ Object

Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated.



26
27
28
 
# File 'lib/freeclimb/models/message_result.rb', line 26

def revision
  @revision
end

#segment_count ⇒ Object

The number of segments into which the message was split



58
59
60
 
# File 'lib/freeclimb/models/message_result.rb', line 58

def segment_count
  @segment_count
end

#status ⇒ Object

Returns the value of attribute status.



34
35
36
 
# File 'lib/freeclimb/models/message_result.rb', line 34

def status
  @status
end

#text ⇒ Object

Message contents



43
44
45
 
# File 'lib/freeclimb/models/message_result.rb', line 43

def text
  @text
end

#tfn ⇒ Object

Returns the value of attribute tfn.



63
64
65
 
# File 'lib/freeclimb/models/message_result.rb', line 63

def tfn
  @tfn
end

#to ⇒ Object

Phone number in E.164 format that received the message.



40
41
42
 
# File 'lib/freeclimb/models/message_result.rb', line 40

def to
  @to
end

#uri ⇒ Object

The URI for this resource, relative to /apiserver.



17
18
19
 
# File 'lib/freeclimb/models/message_result.rb', line 17

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



119
120
121
 
# File 'lib/freeclimb/models/message_result.rb', line 119

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/freeclimb/models/message_result.rb', line 94

def self.attribute_map
  {
    uri: :uri,
    date_created: :dateCreated,
    date_updated: :dateUpdated,
    revision: :revision,
    account_id: :accountId,
    message_id: :messageId,
    status: :status,
    from: :from,
    to: :to,
    text: :text,
    direction: :direction,
    notification_url: :notificationUrl,
    brand_id: :brandId,
    campaign_id: :campaignId,
    segment_count: :segmentCount,
    media_urls: :mediaUrls,
    tfn: :tfn,
    phone_number_id: :phoneNumberId,
    application_id: :applicationId
  }
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



326
327
328
 
# File 'lib/freeclimb/models/message_result.rb', line 326

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



169
170
171
172
173
 
# File 'lib/freeclimb/models/message_result.rb', line 169

def self.openapi_all_of
  [
    :MutableResourceModel
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/freeclimb/models/message_result.rb', line 149

def self.openapi_nullable
  Set.new([
    :account_id,
    :message_id,
    :status,
    :from,
    :to,
    :text,
    :direction,
    :notification_url,
    :brand_id,
    :campaign_id,
    :segment_count,
    :media_urls,
    :phone_number_id,
    :application_id
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/freeclimb/models/message_result.rb', line 124

def self.openapi_types
  {
    uri: :String,
    date_created: :String,
    date_updated: :String,
    revision: :Integer,
    account_id: :String,
    message_id: :String,
    status: :MessageStatus,
    from: :String,
    to: :String,
    text: :String,
    direction: :String,
    notification_url: :String,
    brand_id: :String,
    campaign_id: :String,
    segment_count: :Float,
    media_urls: :"Array<String>",
    tfn: :TFN,
    phone_number_id: :String,
    application_id: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/freeclimb/models/message_result.rb', line 287

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    uri == other.uri &&
    date_created == other.date_created &&
    date_updated == other.date_updated &&
    revision == other.revision &&
     == other. &&
    message_id == other.message_id &&
    status == other.status &&
    from == other.from &&
    to == other.to &&
    text == other.text &&
    direction == other.direction &&
    notification_url == other.notification_url &&
    brand_id == other.brand_id &&
    campaign_id == other.campaign_id &&
    segment_count == other.segment_count &&
    media_urls == other.media_urls &&
    tfn == other.tfn &&
    phone_number_id == other.phone_number_id &&
    application_id == other.application_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



356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/freeclimb/models/message_result.rb', line 356

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Freeclimb.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



427
428
429
430
431
432
433
434
435
436
437
438
439
 
# File 'lib/freeclimb/models/message_result.rb', line 427

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



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/freeclimb/models/message_result.rb', line 333

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      send(:"#{key}=", nil)
    elsif 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)
        send(:"#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      send(:"#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


313
314
315
 
# File 'lib/freeclimb/models/message_result.rb', line 313

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



319
320
321
 
# File 'lib/freeclimb/models/message_result.rb', line 319

def hash
  [uri, date_created, date_updated, revision, , message_id, status, from, to, text, direction, notification_url, brand_id, campaign_id, segment_count, media_urls, tfn, phone_number_id, application_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



271
272
273
 
# File 'lib/freeclimb/models/message_result.rb', line 271

def list_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



403
404
405
 
# File 'lib/freeclimb/models/message_result.rb', line 403

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



409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/freeclimb/models/message_result.rb', line 409

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



397
398
399
 
# File 'lib/freeclimb/models/message_result.rb', line 397

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



277
278
279
280
281
282
283
 
# File 'lib/freeclimb/models/message_result.rb', line 277

def valid?
  if @uri.nil?
    false
  else
    list_invalid_properties.length == 0
  end
end