Class: Freeclimb::ApplicationRequest

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ApplicationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/freeclimb/models/application_request.rb', line 82

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

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

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

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

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

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

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

Instance Attribute Details

#_alias ⇒ Object

A human readable description of the application, with maximum length 64 characters.



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

def _alias
  @_alias
end

#call_connect_url ⇒ Object

The URL that FreeClimb will request when an outbound call request is complete. Used for outbound calls only. Note: A PerCL response is expected if the outbound call is connected (status=InProgress) to control the call.



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

def call_connect_url
  @call_connect_url
end

#sms_fallback_url ⇒ Object

The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only. Note: Any PerCL returned will be ignored.



35
36
37
 
# File 'lib/freeclimb/models/application_request.rb', line 35

def sms_fallback_url
  @sms_fallback_url
end

#sms_url ⇒ Object

The URL that FreeClimb will request when a phone number assigned to this application receives an incoming SMS message. Used for inbound SMS only. Note: Any PerCL returned will be ignored.



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

def sms_url
  @sms_url
end

#status_callback_url ⇒ Object

The URL that FreeClimb will request to pass call status (such as call ended) to the application. Note: This is a notification only; any PerCL returned will be ignored.



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

def status_callback_url
  @status_callback_url
end

#voice_fallback_url ⇒ Object

The URL that FreeClimb will request if it times out waiting for a response from the voiceUrl. Used for inbound calls only. Note: A PerCL response is expected to control the inbound call.



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

def voice_fallback_url
  @voice_fallback_url
end

#voice_url ⇒ Object

The URL that FreeClimb will request when an inbound call arrives on a phone number assigned to this application. Used only for inbound calls.



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

def voice_url
  @voice_url
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/freeclimb/models/application_request.rb', line 38

def self.attribute_map
  {
    _alias: :alias,
    voice_url: :voiceUrl,
    voice_fallback_url: :voiceFallbackUrl,
    call_connect_url: :callConnectUrl,
    status_callback_url: :statusCallbackUrl,
    sms_url: :smsUrl,
    sms_fallback_url: :smsFallbackUrl
  }
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



169
170
171
 
# File 'lib/freeclimb/models/application_request.rb', line 169

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/freeclimb/models/application_request.rb', line 69

def self.openapi_nullable
  Set.new([
    :voice_url,
    :voice_fallback_url,
    :call_connect_url,
    :status_callback_url,
    :sms_url,
    :sms_fallback_url
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    _alias: :String,
    voice_url: :String,
    voice_fallback_url: :String,
    call_connect_url: :String,
    status_callback_url: :String,
    sms_url: :String,
    sms_fallback_url: :String
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/freeclimb/models/application_request.rb', line 142

def ==(other)
  return true if equal?(other)
  self.class == other.class &&
    _alias == other._alias &&
    voice_url == other.voice_url &&
    voice_fallback_url == other.voice_fallback_url &&
    call_connect_url == other.call_connect_url &&
    status_callback_url == other.status_callback_url &&
    sms_url == other.sms_url &&
    sms_fallback_url == other.sms_fallback_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



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

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



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/freeclimb/models/application_request.rb', line 270

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



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

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


156
157
158
 
# File 'lib/freeclimb/models/application_request.rb', line 156

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



162
163
164
 
# File 'lib/freeclimb/models/application_request.rb', line 162

def hash
  [_alias, voice_url, voice_fallback_url, call_connect_url, status_callback_url, sms_url, sms_fallback_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



126
127
128
 
# File 'lib/freeclimb/models/application_request.rb', line 126

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



246
247
248
 
# File 'lib/freeclimb/models/application_request.rb', line 246

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



252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/freeclimb/models/application_request.rb', line 252

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



240
241
242
 
# File 'lib/freeclimb/models/application_request.rb', line 240

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



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

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