Class: Freeclimb::MessageResult

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

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



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
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
 
# File 'lib/freeclimb/models/message_result.rb', line 141

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
end

Instance Attribute Details

#account_id ⇒ Object

String that uniquely identifies this account resource.



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

def 
  @account_id
end

#brand_id ⇒ Object

The unique identifier for the brand associated with the message



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

def brand_id
  @brand_id
end

#campaign_id ⇒ Object

The unique identifier for the campaign associated with the message



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

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).



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

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).



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

def date_updated
  @date_updated
end

#direction ⇒ Object

Noting whether the message was inbound or outbound



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

def direction
  @direction
end

#from ⇒ Object

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



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

def from
  @from
end

#media_urls ⇒ Object

an array of HTTP URLs which were attached this this message



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

def media_urls
  @media_urls
end

#message_id ⇒ Object

String that uniquely identifies this message resource



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

def message_id
  @message_id
end

#notification_url ⇒ Object

URL invoked when message sent



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

def notification_url
  @notification_url
end

#revision ⇒ Object

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



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

def revision
  @revision
end

#segment_count ⇒ Object

The number of segments into which the message was split



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

def segment_count
  @segment_count
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#text ⇒ Object

Message contents



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

def text
  @text
end

#to ⇒ Object

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



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

def to
  @to
end

#uri ⇒ Object

The URI for this resource, relative to /apiserver.



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

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



88
89
90
 
# File 'lib/freeclimb/models/message_result.rb', line 88

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/freeclimb/models/message_result.rb', line 66

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'
  }
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



277
278
279
 
# File 'lib/freeclimb/models/message_result.rb', line 277

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



132
133
134
135
136
137
 
# File 'lib/freeclimb/models/message_result.rb', line 132

def self.openapi_all_of
  [
  :'MessageResultAllOf',
  :'MutableResourceModel'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/freeclimb/models/message_result.rb', line 115

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/freeclimb/models/message_result.rb', line 241

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



307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/freeclimb/models/message_result.rb', line 307

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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/freeclimb/models/message_result.rb', line 378

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/freeclimb/models/message_result.rb', line 284

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)
      self.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)
        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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


264
265
266
 
# File 'lib/freeclimb/models/message_result.rb', line 264

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

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].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



223
224
225
226
 
# File 'lib/freeclimb/models/message_result.rb', line 223

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



354
355
356
 
# File 'lib/freeclimb/models/message_result.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/freeclimb/models/message_result.rb', line 360

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.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



348
349
350
 
# File 'lib/freeclimb/models/message_result.rb', line 348

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



230
231
232
233
234
235
236
237
 
# File 'lib/freeclimb/models/message_result.rb', line 230

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