Class: Freeclimb::Park

Inherits:
PerclCommand show all
Defined in:
lib/freeclimb/models/park.rb

Overview

The ‘Park` command allows a caller to be put on hold. You can provide hold music,messages,etc until ready to resume the call. Park is a terminal command. Actions performed on the Call while on hold are provided in a PerCL script in response to the waitUrl property. Actions performed on the Call after it has been unparked (resumed) will be provided in a PerCL script in response to the actionUrl provided. A Call can be resumed in two ways – REST API invocation or the Unpark percl command. No actions can be nested within Park and Park cannot be nested in any other actions.

Instance Attribute Summary collapse

Attributes inherited from PerclCommand

#command

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from PerclCommand

openapi_discriminator_name, #to_percl_hash

Constructor Details

#initialize(attributes = {}) ⇒ Park

Initializes the object

Parameters:

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

    Model attributes in the form of hash



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/freeclimb/models/park.rb', line 67

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

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

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

  if attributes.key?(:'notification_url')
    self.notification_url = attributes[:'notification_url']
  end
  self.command = "Park"
end

Instance Attribute Details

#action_url ⇒ Object

A request is made to this URL when the Call is resumed, which can occur if the Call is resumed via the Unpark command, the REST API (POST to Call resource), or the caller hangs up. The PerCL script returned in response to the actionUrl will be executed on the resumed call.



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

def action_url
  @action_url
end

#notification_url ⇒ Object

URL to be invoked when the Call is parked. The request to the URL contains the standard request parameters.



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

def notification_url
  @notification_url
end

#wait_url ⇒ Object

Specifies a URL pointing to a PerCL script containing actions to be executed while the caller is Parked. Once the script returned by the waitUrl runs out of commands to execute, FreeClimb will re-request the waitUrl and start over, essentially looping the script requests indefinitely.



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

def wait_url
  @wait_url
end

Class Method Details

.acceptable_attributes ⇒ Object

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



38
39
40
 
# File 'lib/freeclimb/models/park.rb', line 38

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.



29
30
31
32
33
34
35
 
# File 'lib/freeclimb/models/park.rb', line 29

def self.attribute_map
  {
    :'wait_url' => :'waitUrl',
    :'action_url' => :'actionUrl',
    :'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



148
149
150
 
# File 'lib/freeclimb/models/park.rb', line 148

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



58
59
60
61
62
63
 
# File 'lib/freeclimb/models/park.rb', line 58

def self.openapi_all_of
  [
  :'ParkAllOf',
  :'PerclCommand'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
 
# File 'lib/freeclimb/models/park.rb', line 43

def self.openapi_types
  {
    :'wait_url' => :'String',
    :'action_url' => :'String',
    :'notification_url' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      wait_url == o.wait_url &&
      action_url == o.action_url &&
      notification_url == o.notification_url && super(o)
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



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

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



250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/freeclimb/models/park.rb', line 250

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



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/freeclimb/models/park.rb', line 155

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


135
136
137
 
# File 'lib/freeclimb/models/park.rb', line 135

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



141
142
143
 
# File 'lib/freeclimb/models/park.rb', line 141

def hash
  [wait_url, action_url, 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



99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/freeclimb/models/park.rb', line 99

def list_invalid_properties
  invalid_properties = super
  if @wait_url.nil?
    invalid_properties.push('invalid value for "wait_url", wait_url cannot be nil.')
  end

  if @action_url.nil?
    invalid_properties.push('invalid value for "action_url", action_url cannot be nil.')
  end

  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



226
227
228
 
# File 'lib/freeclimb/models/park.rb', line 226

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



232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/freeclimb/models/park.rb', line 232

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



220
221
222
 
# File 'lib/freeclimb/models/park.rb', line 220

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



114
115
116
117
118
119
120
121
 
# File 'lib/freeclimb/models/park.rb', line 114

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