freeclimb 1.0.0 → 2.0.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile.lock +1 -1
- data/README.md +69 -50
- data/docs/AccountRequest.md +3 -5
- data/docs/AccountResult.md +12 -12
- data/docs/AccountResultAllOf.md +8 -8
- data/docs/AddToConference.md +35 -0
- data/docs/AddToConferenceAllOf.md +35 -0
- data/docs/ApplicationList.md +9 -9
- data/docs/ApplicationListAllOf.md +2 -2
- data/docs/ApplicationRequest.md +8 -10
- data/docs/ApplicationResult.md +14 -14
- data/docs/ApplicationResultAllOf.md +10 -10
- data/docs/AvailableNumber.md +7 -7
- data/docs/AvailableNumberList.md +9 -9
- data/docs/AvailableNumberListAllOf.md +2 -2
- data/docs/BuyIncomingNumberRequest.md +4 -6
- data/docs/CallList.md +9 -9
- data/docs/CallListAllOf.md +2 -2
- data/docs/CallResult.md +20 -20
- data/docs/CallResultAllOf.md +16 -16
- data/docs/ConferenceList.md +9 -9
- data/docs/ConferenceListAllOf.md +2 -2
- data/docs/ConferenceParticipantList.md +9 -9
- data/docs/ConferenceParticipantListAllOf.md +2 -2
- data/docs/ConferenceParticipantResult.md +11 -11
- data/docs/ConferenceParticipantResultAllOf.md +7 -7
- data/docs/ConferenceResult.md +15 -15
- data/docs/ConferenceResultAllOf.md +11 -11
- data/docs/CreateConference.md +27 -0
- data/docs/CreateConferenceAllOf.md +27 -0
- data/docs/CreateConferenceRequest.md +6 -8
- data/docs/DefaultApi.md +70 -86
- data/docs/Dequeue.md +16 -0
- data/docs/Enqueue.md +23 -0
- data/docs/EnqueueAllOf.md +23 -0
- data/docs/FilterLogsRequest.md +2 -4
- data/docs/GetDigits.md +33 -0
- data/docs/GetDigitsAllOf.md +33 -0
- data/docs/GetSpeech.md +41 -0
- data/docs/GetSpeechAllOf.md +41 -0
- data/docs/IncomingNumberList.md +9 -9
- data/docs/IncomingNumberListAllOf.md +2 -2
- data/docs/IncomingNumberRequest.md +3 -5
- data/docs/IncomingNumberResult.md +14 -14
- data/docs/IncomingNumberResultAllOf.md +10 -10
- data/docs/LogList.md +9 -9
- data/docs/LogListAllOf.md +2 -2
- data/docs/LogResult.md +8 -8
- data/docs/MakeCallRequest.md +11 -11
- data/docs/MessageRequest.md +10 -12
- data/docs/MessageRequestAllOf.md +6 -8
- data/docs/MessageResult.md +13 -13
- data/docs/MessageResultAllOf.md +9 -9
- data/docs/MessagesList.md +9 -9
- data/docs/MessagesListAllOf.md +2 -2
- data/docs/MutableResourceModel.md +5 -5
- data/docs/OutDial.md +35 -0
- data/docs/OutDialAllOf.md +35 -0
- data/docs/PaginationModel.md +8 -8
- data/docs/Pause.md +17 -0
- data/docs/PauseAllOf.md +17 -0
- data/docs/PerclCommand.md +17 -0
- data/docs/PerclScript.md +17 -0
- data/docs/Play.md +23 -0
- data/docs/PlayAllOf.md +23 -0
- data/docs/PlayEarlyMedia.md +17 -0
- data/docs/PlayEarlyMediaAllOf.md +17 -0
- data/docs/QueueList.md +9 -9
- data/docs/QueueListAllOf.md +2 -2
- data/docs/QueueMember.md +6 -6
- data/docs/QueueMemberList.md +9 -9
- data/docs/QueueMemberListAllOf.md +2 -2
- data/docs/QueueRequest.md +3 -5
- data/docs/QueueResult.md +12 -12
- data/docs/QueueResultAllOf.md +8 -8
- data/docs/RecordUtterance.md +27 -0
- data/docs/RecordUtteranceAllOf.md +27 -0
- data/docs/RecordingList.md +9 -9
- data/docs/RecordingListAllOf.md +2 -2
- data/docs/RecordingResult.md +10 -10
- data/docs/RecordingResultAllOf.md +6 -6
- data/docs/Redirect.md +17 -0
- data/docs/RedirectAllOf.md +17 -0
- data/docs/RemoveFromConference.md +17 -0
- data/docs/RemoveFromConferenceAllOf.md +17 -0
- data/docs/Say.md +25 -0
- data/docs/SayAllOf.md +25 -0
- data/docs/SendDigits.md +21 -0
- data/docs/SendDigitsAllOf.md +21 -0
- data/docs/SetListen.md +19 -0
- data/docs/SetListenAllOf.md +19 -0
- data/docs/SetTalk.md +19 -0
- data/docs/SetTalkAllOf.md +19 -0
- data/docs/Sms.md +23 -0
- data/docs/SmsAllOf.md +23 -0
- data/docs/StartRecordCall.md +16 -0
- data/docs/TerminateConference.md +17 -0
- data/docs/TerminateConferenceAllOf.md +17 -0
- data/docs/UpdateCallRequest.md +2 -4
- data/docs/UpdateConferenceParticipantRequest.md +3 -5
- data/docs/UpdateConferenceRequest.md +4 -6
- data/lib/freeclimb.rb +69 -2
- data/lib/freeclimb/api/default_api.rb +96 -88
- data/lib/freeclimb/api_client.rb +1 -1
- data/lib/freeclimb/models/account_request.rb +4 -14
- data/lib/freeclimb/models/add_to_conference.rb +320 -0
- data/lib/freeclimb/models/add_to_conference_all_of.rb +307 -0
- data/lib/freeclimb/models/application_request.rb +4 -14
- data/lib/freeclimb/models/buy_incoming_number_request.rb +4 -14
- data/lib/freeclimb/models/create_conference.rb +275 -0
- data/lib/freeclimb/models/create_conference_all_of.rb +262 -0
- data/lib/freeclimb/models/create_conference_request.rb +4 -14
- data/lib/freeclimb/models/dequeue.rb +209 -0
- data/lib/freeclimb/models/enqueue.rb +265 -0
- data/lib/freeclimb/models/enqueue_all_of.rb +252 -0
- data/lib/freeclimb/models/filter_logs_request.rb +4 -14
- data/lib/freeclimb/models/get_digits.rb +307 -0
- data/lib/freeclimb/models/get_digits_all_of.rb +294 -0
- data/lib/freeclimb/models/get_speech.rb +352 -0
- data/lib/freeclimb/models/get_speech_all_of.rb +339 -0
- data/lib/freeclimb/models/incoming_number_request.rb +4 -14
- data/lib/freeclimb/models/make_call_request.rb +14 -14
- data/lib/freeclimb/models/message_request.rb +1 -11
- data/lib/freeclimb/models/message_request_all_of.rb +1 -11
- data/lib/freeclimb/models/out_dial.rb +330 -0
- data/lib/freeclimb/models/out_dial_all_of.rb +317 -0
- data/lib/freeclimb/models/pause.rb +225 -0
- data/lib/freeclimb/models/{dequeue_member_request.rb → pause_all_of.rb} +16 -11
- data/lib/freeclimb/models/percl_command.rb +211 -0
- data/lib/freeclimb/models/percl_script.rb +210 -0
- data/lib/freeclimb/models/play.rb +255 -0
- data/lib/freeclimb/models/play_all_of.rb +242 -0
- data/lib/freeclimb/models/play_early_media.rb +225 -0
- data/lib/freeclimb/models/play_early_media_all_of.rb +212 -0
- data/lib/freeclimb/models/queue_request.rb +4 -14
- data/lib/freeclimb/models/record_utterance.rb +275 -0
- data/lib/freeclimb/models/record_utterance_all_of.rb +262 -0
- data/lib/freeclimb/models/redirect.rb +220 -0
- data/lib/freeclimb/models/redirect_all_of.rb +207 -0
- data/lib/freeclimb/models/remove_from_conference.rb +225 -0
- data/lib/freeclimb/models/remove_from_conference_all_of.rb +212 -0
- data/lib/freeclimb/models/say.rb +265 -0
- data/lib/freeclimb/models/say_all_of.rb +252 -0
- data/lib/freeclimb/models/send_digits.rb +245 -0
- data/lib/freeclimb/models/send_digits_all_of.rb +232 -0
- data/lib/freeclimb/models/set_listen.rb +235 -0
- data/lib/freeclimb/models/set_listen_all_of.rb +222 -0
- data/lib/freeclimb/models/set_talk.rb +235 -0
- data/lib/freeclimb/models/set_talk_all_of.rb +222 -0
- data/lib/freeclimb/models/sms.rb +265 -0
- data/lib/freeclimb/models/sms_all_of.rb +252 -0
- data/lib/freeclimb/models/start_record_call.rb +209 -0
- data/lib/freeclimb/models/terminate_conference.rb +225 -0
- data/lib/freeclimb/models/terminate_conference_all_of.rb +212 -0
- data/lib/freeclimb/models/update_call_request.rb +4 -14
- data/lib/freeclimb/models/update_conference_participant_request.rb +4 -14
- data/lib/freeclimb/models/update_conference_request.rb +4 -14
- data/lib/freeclimb/version.rb +1 -1
- data/spec/api/default_api_spec.rb +9 -24
- data/spec/models/add_to_conference_spec.rb +95 -0
- data/spec/models/create_conference_spec.rb +71 -0
- data/spec/models/{dequeue_member_request_spec.rb → dequeue_spec.rb} +8 -7
- data/spec/models/enqueue_spec.rb +59 -0
- data/spec/models/get_digits_spec.rb +83 -0
- data/spec/models/get_speech_spec.rb +113 -0
- data/spec/models/out_dial_spec.rb +89 -0
- data/spec/models/pause_spec.rb +41 -0
- data/spec/models/percl_command_spec.rb +41 -0
- data/spec/models/percl_script_spec.rb +41 -0
- data/spec/models/play_early_media_spec.rb +41 -0
- data/spec/models/play_spec.rb +53 -0
- data/spec/models/record_utterance_spec.rb +71 -0
- data/spec/models/redirect_spec.rb +41 -0
- data/spec/models/remove_from_conference_spec.rb +41 -0
- data/spec/models/say_spec.rb +65 -0
- data/spec/models/send_digits_spec.rb +47 -0
- data/spec/models/set_listen_spec.rb +47 -0
- data/spec/models/set_talk_spec.rb +47 -0
- data/spec/models/sms_spec.rb +59 -0
- data/spec/models/start_record_call_spec.rb +35 -0
- data/spec/models/terminate_conference_spec.rb +41 -0
- metadata +126 -35
- data/docs/DequeueMemberRequest.md +0 -17
- data/docs/Percl.md +0 -697
- data/git_push.sh +0 -58
- data/lib/percl/calls.rb +0 -43
- data/lib/percl/conference_participants.rb +0 -40
- data/lib/percl/conferences.rb +0 -21
- data/lib/percl/ivr.rb +0 -63
- data/lib/percl/jsonable.rb +0 -23
- data/lib/percl/percl.rb +0 -29
- data/lib/percl/queue_members.rb +0 -15
- data/lib/percl/recordings.rb +0 -15
- data/lib/percl/sms.rb +0 -11
- data/spec/percl/calls_spec.rb +0 -111
- data/spec/percl/conference_participant_spec.rb +0 -96
- data/spec/percl/conference_spec.rb +0 -46
- data/spec/percl/ivr_spec.rb +0 -155
- data/spec/percl/jsonable_spec.rb +0 -28
- data/spec/percl/percl_spec.rb +0 -31
- data/spec/percl/queue_members_spec.rb +0 -35
- data/spec/percl/recordings_spec.rb +0 -32
- data/spec/percl/sms_spec.rb +0 -29
@@ -0,0 +1,212 @@
|
|
1
|
+
=begin
|
2
|
+
#FreeClimb API
|
3
|
+
|
4
|
+
#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module Freeclimb
|
16
|
+
class PlayEarlyMediaAllOf
|
17
|
+
# RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands or any accessible URL. FreeClimb will respect Cache-Control headers for this file. Use these to limit repeated requests for unchanged audio. If no Cache-Control header is provided, the file will be cached for seven days by default.
|
18
|
+
attr_accessor :file
|
19
|
+
|
20
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
21
|
+
def self.attribute_map
|
22
|
+
{
|
23
|
+
:'file' => :'file'
|
24
|
+
}
|
25
|
+
end
|
26
|
+
|
27
|
+
# Attribute type mapping.
|
28
|
+
def self.openapi_types
|
29
|
+
{
|
30
|
+
:'file' => :'String'
|
31
|
+
}
|
32
|
+
end
|
33
|
+
|
34
|
+
# List of attributes with nullable: true
|
35
|
+
def self.openapi_nullable
|
36
|
+
Set.new([
|
37
|
+
])
|
38
|
+
end
|
39
|
+
|
40
|
+
# Initializes the object
|
41
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
42
|
+
def initialize(attributes = {})
|
43
|
+
if (!attributes.is_a?(Hash))
|
44
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::PlayEarlyMediaAllOf` initialize method"
|
45
|
+
end
|
46
|
+
|
47
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
48
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
49
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
50
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::PlayEarlyMediaAllOf`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
51
|
+
end
|
52
|
+
h[k.to_sym] = v
|
53
|
+
}
|
54
|
+
|
55
|
+
if attributes.key?(:'file')
|
56
|
+
self.file = attributes[:'file']
|
57
|
+
end
|
58
|
+
end
|
59
|
+
|
60
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
61
|
+
# @return Array for valid properties with the reasons
|
62
|
+
def list_invalid_properties
|
63
|
+
invalid_properties = Array.new
|
64
|
+
if @file.nil?
|
65
|
+
invalid_properties.push('invalid value for "file", file cannot be nil.')
|
66
|
+
end
|
67
|
+
|
68
|
+
invalid_properties
|
69
|
+
end
|
70
|
+
|
71
|
+
# Check to see if the all the properties in the model are valid
|
72
|
+
# @return true if the model is valid
|
73
|
+
def valid?
|
74
|
+
return false if @file.nil?
|
75
|
+
true
|
76
|
+
end
|
77
|
+
|
78
|
+
# Checks equality by comparing each attribute.
|
79
|
+
# @param [Object] Object to be compared
|
80
|
+
def ==(o)
|
81
|
+
return true if self.equal?(o)
|
82
|
+
self.class == o.class &&
|
83
|
+
file == o.file
|
84
|
+
end
|
85
|
+
|
86
|
+
# @see the `==` method
|
87
|
+
# @param [Object] Object to be compared
|
88
|
+
def eql?(o)
|
89
|
+
self == o
|
90
|
+
end
|
91
|
+
|
92
|
+
# Calculates hash code according to all attributes.
|
93
|
+
# @return [Integer] Hash code
|
94
|
+
def hash
|
95
|
+
[file].hash
|
96
|
+
end
|
97
|
+
|
98
|
+
# Builds the object from hash
|
99
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
100
|
+
# @return [Object] Returns the model itself
|
101
|
+
def self.build_from_hash(attributes)
|
102
|
+
new.build_from_hash(attributes)
|
103
|
+
end
|
104
|
+
|
105
|
+
# Builds the object from hash
|
106
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
107
|
+
# @return [Object] Returns the model itself
|
108
|
+
def build_from_hash(attributes)
|
109
|
+
return nil unless attributes.is_a?(Hash)
|
110
|
+
self.class.openapi_types.each_pair do |key, type|
|
111
|
+
if type =~ /\AArray<(.*)>/i
|
112
|
+
# check to ensure the input is an array given that the attribute
|
113
|
+
# is documented as an array but the input is not
|
114
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
115
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
116
|
+
end
|
117
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
118
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
119
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
120
|
+
end
|
121
|
+
|
122
|
+
self
|
123
|
+
end
|
124
|
+
|
125
|
+
# Deserializes the data based on type
|
126
|
+
# @param string type Data type
|
127
|
+
# @param string value Value to be deserialized
|
128
|
+
# @return [Object] Deserialized data
|
129
|
+
def _deserialize(type, value)
|
130
|
+
case type.to_sym
|
131
|
+
when :DateTime
|
132
|
+
DateTime.parse(value)
|
133
|
+
when :Date
|
134
|
+
Date.parse(value)
|
135
|
+
when :String
|
136
|
+
value.to_s
|
137
|
+
when :Integer
|
138
|
+
value.to_i
|
139
|
+
when :Float
|
140
|
+
value.to_f
|
141
|
+
when :Boolean
|
142
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
143
|
+
true
|
144
|
+
else
|
145
|
+
false
|
146
|
+
end
|
147
|
+
when :Object
|
148
|
+
# generic object (usually a Hash), return directly
|
149
|
+
value
|
150
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
151
|
+
inner_type = Regexp.last_match[:inner_type]
|
152
|
+
value.map { |v| _deserialize(inner_type, v) }
|
153
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
154
|
+
k_type = Regexp.last_match[:k_type]
|
155
|
+
v_type = Regexp.last_match[:v_type]
|
156
|
+
{}.tap do |hash|
|
157
|
+
value.each do |k, v|
|
158
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
159
|
+
end
|
160
|
+
end
|
161
|
+
else # model
|
162
|
+
Freeclimb.const_get(type).build_from_hash(value)
|
163
|
+
end
|
164
|
+
end
|
165
|
+
|
166
|
+
# Returns the string representation of the object
|
167
|
+
# @return [String] String presentation of the object
|
168
|
+
def to_s
|
169
|
+
to_hash.to_s
|
170
|
+
end
|
171
|
+
|
172
|
+
# to_body is an alias to to_hash (backward compatibility)
|
173
|
+
# @return [Hash] Returns the object in the form of hash
|
174
|
+
def to_body
|
175
|
+
to_hash
|
176
|
+
end
|
177
|
+
|
178
|
+
# Returns the object in the form of hash
|
179
|
+
# @return [Hash] Returns the object in the form of hash
|
180
|
+
def to_hash
|
181
|
+
hash = {}
|
182
|
+
self.class.attribute_map.each_pair do |attr, param|
|
183
|
+
value = self.send(attr)
|
184
|
+
if value.nil?
|
185
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
186
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
187
|
+
end
|
188
|
+
|
189
|
+
hash[param] = _to_hash(value)
|
190
|
+
end
|
191
|
+
hash
|
192
|
+
end
|
193
|
+
|
194
|
+
# Outputs non-array value in the form of hash
|
195
|
+
# For object, use to_hash. Otherwise, just return the value
|
196
|
+
# @param [Object] value Any valid value
|
197
|
+
# @return [Hash] Returns the value in the form of hash
|
198
|
+
def _to_hash(value)
|
199
|
+
if value.is_a?(Array)
|
200
|
+
value.compact.map { |v| _to_hash(v) }
|
201
|
+
elsif value.is_a?(Hash)
|
202
|
+
{}.tap do |hash|
|
203
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
204
|
+
end
|
205
|
+
elsif value.respond_to? :to_hash
|
206
|
+
value.to_hash
|
207
|
+
else
|
208
|
+
value
|
209
|
+
end
|
210
|
+
end
|
211
|
+
end
|
212
|
+
end
|
@@ -20,15 +20,11 @@ module Freeclimb
|
|
20
20
|
# Maximum number of calls this queue can hold. Default is 100. Maximum is 1000. **Note:** Reducing the maxSize of a Queue causes the Queue to reject incoming requests until it shrinks below the new value of maxSize.
|
21
21
|
attr_accessor :max_size
|
22
22
|
|
23
|
-
# RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request include this requestId. If this parameter is not provided, FreeClimb generates a requestId and returns it as a header in the response (e.g., X-Pulse-Request-Id: <requestId>).
|
24
|
-
attr_accessor :request_id
|
25
|
-
|
26
23
|
# Attribute mapping from ruby-style variable name to JSON key.
|
27
24
|
def self.attribute_map
|
28
25
|
{
|
29
26
|
:'_alias' => :'alias',
|
30
|
-
:'max_size' => :'maxSize'
|
31
|
-
:'request_id' => :'requestId'
|
27
|
+
:'max_size' => :'maxSize'
|
32
28
|
}
|
33
29
|
end
|
34
30
|
|
@@ -36,8 +32,7 @@ module Freeclimb
|
|
36
32
|
def self.openapi_types
|
37
33
|
{
|
38
34
|
:'_alias' => :'String',
|
39
|
-
:'max_size' => :'Integer'
|
40
|
-
:'request_id' => :'String'
|
35
|
+
:'max_size' => :'Integer'
|
41
36
|
}
|
42
37
|
end
|
43
38
|
|
@@ -69,10 +64,6 @@ module Freeclimb
|
|
69
64
|
if attributes.key?(:'max_size')
|
70
65
|
self.max_size = attributes[:'max_size']
|
71
66
|
end
|
72
|
-
|
73
|
-
if attributes.key?(:'request_id')
|
74
|
-
self.request_id = attributes[:'request_id']
|
75
|
-
end
|
76
67
|
end
|
77
68
|
|
78
69
|
# Show invalid properties with the reasons. Usually used together with valid?
|
@@ -94,8 +85,7 @@ module Freeclimb
|
|
94
85
|
return true if self.equal?(o)
|
95
86
|
self.class == o.class &&
|
96
87
|
_alias == o._alias &&
|
97
|
-
max_size == o.max_size
|
98
|
-
request_id == o.request_id
|
88
|
+
max_size == o.max_size
|
99
89
|
end
|
100
90
|
|
101
91
|
# @see the `==` method
|
@@ -107,7 +97,7 @@ module Freeclimb
|
|
107
97
|
# Calculates hash code according to all attributes.
|
108
98
|
# @return [Integer] Hash code
|
109
99
|
def hash
|
110
|
-
[_alias, max_size
|
100
|
+
[_alias, max_size].hash
|
111
101
|
end
|
112
102
|
|
113
103
|
# Builds the object from hash
|
@@ -0,0 +1,275 @@
|
|
1
|
+
=begin
|
2
|
+
#FreeClimb API
|
3
|
+
|
4
|
+
#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
|
5
|
+
|
6
|
+
The version of the OpenAPI document: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://openapi-generator.tech
|
9
|
+
OpenAPI Generator version: 4.3.0-SNAPSHOT
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'date'
|
14
|
+
|
15
|
+
module Freeclimb
|
16
|
+
# The `RecordUtterance` command records the caller's voice and returns the URL of a file containing the audio recording. `RecordUtterance` is blocking and is a terminal command. As such, the `actionUrl` property is required, and control of the Call picks up using the PerCL returned in response to the `actionUrl`. Recording information is returned in the `actionUrl` request.
|
17
|
+
class RecordUtterance < PerclCommand
|
18
|
+
# URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing.
|
19
|
+
attr_accessor :action_url
|
20
|
+
|
21
|
+
# Interval of silence that should elapse before ending the recording.
|
22
|
+
attr_accessor :silence_timeout_ms
|
23
|
+
|
24
|
+
# Key that triggers the end of the recording. any digit, '#', or '*'
|
25
|
+
attr_accessor :finish_on_key
|
26
|
+
|
27
|
+
# Maximum length for the command execution in seconds.
|
28
|
+
attr_accessor :max_length_sec
|
29
|
+
|
30
|
+
# Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played.
|
31
|
+
attr_accessor :play_beep
|
32
|
+
|
33
|
+
# If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated.
|
34
|
+
attr_accessor :auto_start
|
35
|
+
|
36
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
37
|
+
def self.attribute_map
|
38
|
+
{
|
39
|
+
:'action_url' => :'actionUrl',
|
40
|
+
:'silence_timeout_ms' => :'silenceTimeoutMs',
|
41
|
+
:'finish_on_key' => :'finishOnKey',
|
42
|
+
:'max_length_sec' => :'maxLengthSec',
|
43
|
+
:'play_beep' => :'playBeep',
|
44
|
+
:'auto_start' => :'autoStart'
|
45
|
+
}
|
46
|
+
end
|
47
|
+
|
48
|
+
# Attribute type mapping.
|
49
|
+
def self.openapi_types
|
50
|
+
{
|
51
|
+
:'action_url' => :'String',
|
52
|
+
:'silence_timeout_ms' => :'Integer',
|
53
|
+
:'finish_on_key' => :'String',
|
54
|
+
:'max_length_sec' => :'Integer',
|
55
|
+
:'play_beep' => :'Boolean',
|
56
|
+
:'auto_start' => :'Boolean'
|
57
|
+
}
|
58
|
+
end
|
59
|
+
|
60
|
+
# List of attributes with nullable: true
|
61
|
+
def self.openapi_nullable
|
62
|
+
Set.new([
|
63
|
+
])
|
64
|
+
end
|
65
|
+
|
66
|
+
# List of class defined in allOf (OpenAPI v3)
|
67
|
+
def self.openapi_all_of
|
68
|
+
[
|
69
|
+
:'PerclCommand',
|
70
|
+
:'RecordUtteranceAllOf'
|
71
|
+
]
|
72
|
+
end
|
73
|
+
|
74
|
+
# Initializes the object
|
75
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
76
|
+
def initialize(attributes = {})
|
77
|
+
if (!attributes.is_a?(Hash))
|
78
|
+
fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::RecordUtterance` initialize method"
|
79
|
+
end
|
80
|
+
|
81
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
82
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
83
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
84
|
+
fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::RecordUtterance`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
|
85
|
+
end
|
86
|
+
h[k.to_sym] = v
|
87
|
+
}
|
88
|
+
|
89
|
+
# call parent's initialize
|
90
|
+
super(attributes)
|
91
|
+
|
92
|
+
if attributes.key?(:'action_url')
|
93
|
+
self.action_url = attributes[:'action_url']
|
94
|
+
end
|
95
|
+
|
96
|
+
if attributes.key?(:'silence_timeout_ms')
|
97
|
+
self.silence_timeout_ms = attributes[:'silence_timeout_ms']
|
98
|
+
end
|
99
|
+
|
100
|
+
if attributes.key?(:'finish_on_key')
|
101
|
+
self.finish_on_key = attributes[:'finish_on_key']
|
102
|
+
end
|
103
|
+
|
104
|
+
if attributes.key?(:'max_length_sec')
|
105
|
+
self.max_length_sec = attributes[:'max_length_sec']
|
106
|
+
end
|
107
|
+
|
108
|
+
if attributes.key?(:'play_beep')
|
109
|
+
self.play_beep = attributes[:'play_beep']
|
110
|
+
end
|
111
|
+
|
112
|
+
if attributes.key?(:'auto_start')
|
113
|
+
self.auto_start = attributes[:'auto_start']
|
114
|
+
end
|
115
|
+
end
|
116
|
+
|
117
|
+
# Show invalid properties with the reasons. Usually used together with valid?
|
118
|
+
# @return Array for valid properties with the reasons
|
119
|
+
def list_invalid_properties
|
120
|
+
invalid_properties = super
|
121
|
+
if @action_url.nil?
|
122
|
+
invalid_properties.push('invalid value for "action_url", action_url cannot be nil.')
|
123
|
+
end
|
124
|
+
|
125
|
+
invalid_properties
|
126
|
+
end
|
127
|
+
|
128
|
+
# Check to see if the all the properties in the model are valid
|
129
|
+
# @return true if the model is valid
|
130
|
+
def valid?
|
131
|
+
return false if @action_url.nil?
|
132
|
+
true && super
|
133
|
+
end
|
134
|
+
|
135
|
+
# Checks equality by comparing each attribute.
|
136
|
+
# @param [Object] Object to be compared
|
137
|
+
def ==(o)
|
138
|
+
return true if self.equal?(o)
|
139
|
+
self.class == o.class &&
|
140
|
+
action_url == o.action_url &&
|
141
|
+
silence_timeout_ms == o.silence_timeout_ms &&
|
142
|
+
finish_on_key == o.finish_on_key &&
|
143
|
+
max_length_sec == o.max_length_sec &&
|
144
|
+
play_beep == o.play_beep &&
|
145
|
+
auto_start == o.auto_start && super(o)
|
146
|
+
end
|
147
|
+
|
148
|
+
# @see the `==` method
|
149
|
+
# @param [Object] Object to be compared
|
150
|
+
def eql?(o)
|
151
|
+
self == o
|
152
|
+
end
|
153
|
+
|
154
|
+
# Calculates hash code according to all attributes.
|
155
|
+
# @return [Integer] Hash code
|
156
|
+
def hash
|
157
|
+
[action_url, silence_timeout_ms, finish_on_key, max_length_sec, play_beep, auto_start].hash
|
158
|
+
end
|
159
|
+
|
160
|
+
# Builds the object from hash
|
161
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
162
|
+
# @return [Object] Returns the model itself
|
163
|
+
def self.build_from_hash(attributes)
|
164
|
+
new.build_from_hash(attributes)
|
165
|
+
end
|
166
|
+
|
167
|
+
# Builds the object from hash
|
168
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
169
|
+
# @return [Object] Returns the model itself
|
170
|
+
def build_from_hash(attributes)
|
171
|
+
return nil unless attributes.is_a?(Hash)
|
172
|
+
super(attributes)
|
173
|
+
self.class.openapi_types.each_pair do |key, type|
|
174
|
+
if type =~ /\AArray<(.*)>/i
|
175
|
+
# check to ensure the input is an array given that the attribute
|
176
|
+
# is documented as an array but the input is not
|
177
|
+
if attributes[self.class.attribute_map[key]].is_a?(Array)
|
178
|
+
self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
|
179
|
+
end
|
180
|
+
elsif !attributes[self.class.attribute_map[key]].nil?
|
181
|
+
self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
|
182
|
+
end # or else data not found in attributes(hash), not an issue as the data can be optional
|
183
|
+
end
|
184
|
+
|
185
|
+
self
|
186
|
+
end
|
187
|
+
|
188
|
+
# Deserializes the data based on type
|
189
|
+
# @param string type Data type
|
190
|
+
# @param string value Value to be deserialized
|
191
|
+
# @return [Object] Deserialized data
|
192
|
+
def _deserialize(type, value)
|
193
|
+
case type.to_sym
|
194
|
+
when :DateTime
|
195
|
+
DateTime.parse(value)
|
196
|
+
when :Date
|
197
|
+
Date.parse(value)
|
198
|
+
when :String
|
199
|
+
value.to_s
|
200
|
+
when :Integer
|
201
|
+
value.to_i
|
202
|
+
when :Float
|
203
|
+
value.to_f
|
204
|
+
when :Boolean
|
205
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
206
|
+
true
|
207
|
+
else
|
208
|
+
false
|
209
|
+
end
|
210
|
+
when :Object
|
211
|
+
# generic object (usually a Hash), return directly
|
212
|
+
value
|
213
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
214
|
+
inner_type = Regexp.last_match[:inner_type]
|
215
|
+
value.map { |v| _deserialize(inner_type, v) }
|
216
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
217
|
+
k_type = Regexp.last_match[:k_type]
|
218
|
+
v_type = Regexp.last_match[:v_type]
|
219
|
+
{}.tap do |hash|
|
220
|
+
value.each do |k, v|
|
221
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
222
|
+
end
|
223
|
+
end
|
224
|
+
else # model
|
225
|
+
Freeclimb.const_get(type).build_from_hash(value)
|
226
|
+
end
|
227
|
+
end
|
228
|
+
|
229
|
+
# Returns the string representation of the object
|
230
|
+
# @return [String] String presentation of the object
|
231
|
+
def to_s
|
232
|
+
to_hash.to_s
|
233
|
+
end
|
234
|
+
|
235
|
+
# to_body is an alias to to_hash (backward compatibility)
|
236
|
+
# @return [Hash] Returns the object in the form of hash
|
237
|
+
def to_body
|
238
|
+
to_hash
|
239
|
+
end
|
240
|
+
|
241
|
+
# Returns the object in the form of hash
|
242
|
+
# @return [Hash] Returns the object in the form of hash
|
243
|
+
def to_hash
|
244
|
+
hash = super
|
245
|
+
self.class.attribute_map.each_pair do |attr, param|
|
246
|
+
value = self.send(attr)
|
247
|
+
if value.nil?
|
248
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
249
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
250
|
+
end
|
251
|
+
|
252
|
+
hash[param] = _to_hash(value)
|
253
|
+
end
|
254
|
+
hash
|
255
|
+
end
|
256
|
+
|
257
|
+
# Outputs non-array value in the form of hash
|
258
|
+
# For object, use to_hash. Otherwise, just return the value
|
259
|
+
# @param [Object] value Any valid value
|
260
|
+
# @return [Hash] Returns the value in the form of hash
|
261
|
+
def _to_hash(value)
|
262
|
+
if value.is_a?(Array)
|
263
|
+
value.compact.map { |v| _to_hash(v) }
|
264
|
+
elsif value.is_a?(Hash)
|
265
|
+
{}.tap do |hash|
|
266
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
267
|
+
end
|
268
|
+
elsif value.respond_to? :to_hash
|
269
|
+
value.to_hash
|
270
|
+
else
|
271
|
+
value
|
272
|
+
end
|
273
|
+
end
|
274
|
+
end
|
275
|
+
end
|