Class: Freeclimb::MessageDeliveryWebhook

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

Overview

An SMS has been received by the platform and is being delivered to the smsUrl of the customer application that is associated with the destination number. A PerCL response will be ignored.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Webhook

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ MessageDeliveryWebhook

Initializes the object

Parameters:

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

    Model attributes in the form of hash



105
106
107
108
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
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 105

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

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

Instance Attribute Details

#account_id ⇒ Object

Account ID associated with your account.



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

def 
  @account_id
end

#application_id ⇒ Object

ID of the application to which the destination number is assigned.



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

def application_id
  @application_id
end

#direction ⇒ Object

Value will be inbound to indicate the receipt of a message into the FreeClimb platform.



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

def direction
  @direction
end

#from ⇒ Object

Phone number of the party that initiated the Call (in E.164 format).



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

def from
  @from
end

#phone_number_id ⇒ Object

ID of the destination phone number.



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

def phone_number_id
  @phone_number_id
end

#request_type ⇒ Object

Value will be messageDelivery - An SMS message has been received by the platform and is being delivered to the customer application associated with the destination number.



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

def request_type
  @request_type
end

#status ⇒ Object

Value will be received to indicate that the platform has successfully received the incoming message.



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

def status
  @status
end

#text ⇒ Object

Body of the SMS message.



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

def text
  @text
end

#to ⇒ Object

Phone number provisioned to you and to which this Call is directed (in E.164 format).



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

def to
  @to
end

#uri ⇒ Object

The URI for this resource, relative to the API base URL



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

def uri
  @uri
end

Class Method Details

.acceptable_attributes ⇒ Object

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



71
72
73
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 71

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.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 55

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



210
211
212
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 210

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_delivery_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
  MessageDeliveryWebhook.new(hash)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



97
98
99
100
101
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 97

def self.openapi_all_of
  [
    :Webhook
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



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

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

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 180

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    request_type == other.request_type &&
     == other. &&
    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 &&
    uri == other.uri && 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



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
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 241

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



312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 312

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



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 217

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


197
198
199
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 197

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



203
204
205
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 203

def hash
  [request_type, , from, to, text, direction, application_id, status, phone_number_id, uri].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



164
165
166
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 164

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



288
289
290
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 288

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 294

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



282
283
284
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 282

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



170
171
172
173
174
175
176
 
# File 'lib/freeclimb/models/message_delivery_webhook.rb', line 170

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