Class: Freeclimb::MessageStatusWebhook

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

Overview

An outbound SMS has changed status and the notificationUrl from the Sms command or Send an SMS request is being invoked. A PerCL response will be ignored.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Webhook

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ MessageStatusWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
188
189
190
191
192
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 133

def initialize(attributes = {})
  if !attributes.is_a?(Hash)
    fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::MessageStatusWebhook` 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::MessageStatusWebhook`. 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
  }

  # call parent's initialize
  super

  if attributes.key?(:request_type)
    self.request_type = attributes[:request_type]
  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?(:call_id)
    self.call_id = attributes[:call_id]
  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?(:application_id)
    self.application_id = attributes[:application_id]
  end

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

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

Instance Attribute Details

#account_id ⇒ Object

Account ID associated with your account.



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

def 
  @account_id
end

#application_id ⇒ Object

ID of the application to which the destination number is assigned. May be null if the originating number is invalid in some way or is not registered to an application.



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

def application_id
  @application_id
end

#call_id ⇒ Object

Unique ID for the Call in the context of which the Sms PerCL command was issued.



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

def call_id
  @call_id
end

#direction ⇒ Object

Value will be outbound to indicate an outgoing SMS from FreeClimb.



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

def direction
  @direction
end

#from ⇒ Object

aPhone number used to initiate the SMS message (in E.164 format).



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

def from
  @from
end

#message_id ⇒ Object

Unique ID for this message, generated by FreeClimb.



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

def message_id
  @message_id
end

#phone_number_id ⇒ Object

ID of the destination phone number.



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

def phone_number_id
  @phone_number_id
end

#request_type ⇒ Object

Value will be messageStatus - An outbound SMS has changed status and the Sms command’s notificationUrl is being invoked.



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

def request_type
  @request_type
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

#text ⇒ Object

Body of the SMS message.



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

def text
  @text
end

#to ⇒ Object

Destination number of the SMS message (in E.164 format).



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

def to
  @to
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about, including the ones defined in its parent(s)



96
97
98
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 96

def self.acceptable_attributes
  attribute_map.values.concat(superclass.acceptable_attributes)
end

.attribute_map ⇒ Object

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



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 79

def self.attribute_map
  {
    request_type: :requestType,
    account_id: :accountId,
    message_id: :messageId,
    call_id: :callId,
    from: :from,
    to: :to,
    text: :text,
    direction: :direction,
    application_id: :applicationId,
    status: :status,
    phone_number_id: :phoneNumberId
  }
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



243
244
245
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 243

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

.deserialize(payload) ⇒ Object 



17
18
19
20
21
22
23
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 17

def self.deserialize(payload)
  return nil if payload.nil? || payload.empty?
  data = JSON.parse("[#{payload}]")[0]
  inverted_attributes = attribute_map.invert
  hash = acceptable_attributes.uniq.map { |k| [inverted_attributes[k], data[k.to_s]] }.to_h
  MessageStatusWebhook.new(hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



125
126
127
128
129
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 125

def self.openapi_all_of
  [
    :Webhook
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 101

def self.openapi_types
  {
    request_type: :String,
    account_id: :String,
    message_id: :String,
    call_id: :String,
    from: :String,
    to: :String,
    text: :String,
    direction: :String,
    application_id: :String,
    status: :MessageStatus,
    phone_number_id: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 212

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    request_type == other.request_type &&
     == other. &&
    message_id == other.message_id &&
    call_id == other.call_id &&
    from == other.from &&
    to == other.to &&
    text == other.text &&
    direction == other.direction &&
    application_id == other.application_id &&
    status == other.status &&
    phone_number_id == other.phone_number_id && super
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



274
275
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_status_webhook.rb', line 274

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



345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/freeclimb/models/message_status_webhook.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



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 250

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


230
231
232
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 230

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



236
237
238
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 236

def hash
  [request_type, , message_id, call_id, from, to, text, direction, application_id, status, phone_number_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



196
197
198
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 196

def list_invalid_properties
  super
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_status_webhook.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_status_webhook.rb', line 327

def to_hash
  hash = super
  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



315
316
317
 
# File 'lib/freeclimb/models/message_status_webhook.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



202
203
204
205
206
207
208
 
# File 'lib/freeclimb/models/message_status_webhook.rb', line 202

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