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



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
183
184
185
186
187
 
# File 'lib/freeclimb/models/message_result.rb', line 127

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
end

Instance Attribute Details

#account_id ⇒ Object

String that uniquely identifies this account resource.



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

def 
  @account_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).



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

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



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

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

#message_id ⇒ Object

String that uniquely identifies this message resource



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

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.



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

def revision
  @revision
end

#status ⇒ Object

Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received



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.



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

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/freeclimb/models/message_result.rb', line 76

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



248
249
250
 
# File 'lib/freeclimb/models/message_result.rb', line 248

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



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

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
 
# File 'lib/freeclimb/models/message_result.rb', line 112

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'uri' => :'String',
    :'date_created' => :'String',
    :'date_updated' => :'String',
    :'revision' => :'Integer',
    :'account_id' => :'String',
    :'message_id' => :'String',
    :'status' => :'String',
    :'from' => :'String',
    :'to' => :'String',
    :'text' => :'String',
    :'direction' => :'String',
    :'notification_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/freeclimb/models/message_result.rb', line 216

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/freeclimb/models/message_result.rb', line 276

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
    Freeclimb.const_get(type).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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/freeclimb/models/message_result.rb', line 345

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
 
# File 'lib/freeclimb/models/message_result.rb', line 255

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


235
236
237
 
# File 'lib/freeclimb/models/message_result.rb', line 235

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



241
242
243
 
# File 'lib/freeclimb/models/message_result.rb', line 241

def hash
  [uri, date_created, date_updated, revision, , message_id, status, from, to, text, direction, notification_url].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



191
192
193
194
 
# File 'lib/freeclimb/models/message_result.rb', line 191

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



321
322
323
 
# File 'lib/freeclimb/models/message_result.rb', line 321

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



327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/freeclimb/models/message_result.rb', line 327

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



315
316
317
 
# File 'lib/freeclimb/models/message_result.rb', line 315

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



198
199
200
201
202
 
# File 'lib/freeclimb/models/message_result.rb', line 198

def valid?
  status_validator = EnumAttributeValidator.new('String', ["new", "queued", "rejected", "sending", "sent", "failed", "received", "undelivered"])
  return false unless status_validator.valid?(@status)
  true
end