freeclimb 1.0.0 → 2.0.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (204) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +1 -1
  3. data/README.md +69 -50
  4. data/docs/AccountRequest.md +3 -5
  5. data/docs/AccountResult.md +12 -12
  6. data/docs/AccountResultAllOf.md +8 -8
  7. data/docs/AddToConference.md +35 -0
  8. data/docs/AddToConferenceAllOf.md +35 -0
  9. data/docs/ApplicationList.md +9 -9
  10. data/docs/ApplicationListAllOf.md +2 -2
  11. data/docs/ApplicationRequest.md +8 -10
  12. data/docs/ApplicationResult.md +14 -14
  13. data/docs/ApplicationResultAllOf.md +10 -10
  14. data/docs/AvailableNumber.md +7 -7
  15. data/docs/AvailableNumberList.md +9 -9
  16. data/docs/AvailableNumberListAllOf.md +2 -2
  17. data/docs/BuyIncomingNumberRequest.md +4 -6
  18. data/docs/CallList.md +9 -9
  19. data/docs/CallListAllOf.md +2 -2
  20. data/docs/CallResult.md +20 -20
  21. data/docs/CallResultAllOf.md +16 -16
  22. data/docs/ConferenceList.md +9 -9
  23. data/docs/ConferenceListAllOf.md +2 -2
  24. data/docs/ConferenceParticipantList.md +9 -9
  25. data/docs/ConferenceParticipantListAllOf.md +2 -2
  26. data/docs/ConferenceParticipantResult.md +11 -11
  27. data/docs/ConferenceParticipantResultAllOf.md +7 -7
  28. data/docs/ConferenceResult.md +15 -15
  29. data/docs/ConferenceResultAllOf.md +11 -11
  30. data/docs/CreateConference.md +27 -0
  31. data/docs/CreateConferenceAllOf.md +27 -0
  32. data/docs/CreateConferenceRequest.md +6 -8
  33. data/docs/DefaultApi.md +70 -86
  34. data/docs/Dequeue.md +16 -0
  35. data/docs/Enqueue.md +23 -0
  36. data/docs/EnqueueAllOf.md +23 -0
  37. data/docs/FilterLogsRequest.md +2 -4
  38. data/docs/GetDigits.md +33 -0
  39. data/docs/GetDigitsAllOf.md +33 -0
  40. data/docs/GetSpeech.md +41 -0
  41. data/docs/GetSpeechAllOf.md +41 -0
  42. data/docs/IncomingNumberList.md +9 -9
  43. data/docs/IncomingNumberListAllOf.md +2 -2
  44. data/docs/IncomingNumberRequest.md +3 -5
  45. data/docs/IncomingNumberResult.md +14 -14
  46. data/docs/IncomingNumberResultAllOf.md +10 -10
  47. data/docs/LogList.md +9 -9
  48. data/docs/LogListAllOf.md +2 -2
  49. data/docs/LogResult.md +8 -8
  50. data/docs/MakeCallRequest.md +11 -11
  51. data/docs/MessageRequest.md +10 -12
  52. data/docs/MessageRequestAllOf.md +6 -8
  53. data/docs/MessageResult.md +13 -13
  54. data/docs/MessageResultAllOf.md +9 -9
  55. data/docs/MessagesList.md +9 -9
  56. data/docs/MessagesListAllOf.md +2 -2
  57. data/docs/MutableResourceModel.md +5 -5
  58. data/docs/OutDial.md +35 -0
  59. data/docs/OutDialAllOf.md +35 -0
  60. data/docs/PaginationModel.md +8 -8
  61. data/docs/Pause.md +17 -0
  62. data/docs/PauseAllOf.md +17 -0
  63. data/docs/PerclCommand.md +17 -0
  64. data/docs/PerclScript.md +17 -0
  65. data/docs/Play.md +23 -0
  66. data/docs/PlayAllOf.md +23 -0
  67. data/docs/PlayEarlyMedia.md +17 -0
  68. data/docs/PlayEarlyMediaAllOf.md +17 -0
  69. data/docs/QueueList.md +9 -9
  70. data/docs/QueueListAllOf.md +2 -2
  71. data/docs/QueueMember.md +6 -6
  72. data/docs/QueueMemberList.md +9 -9
  73. data/docs/QueueMemberListAllOf.md +2 -2
  74. data/docs/QueueRequest.md +3 -5
  75. data/docs/QueueResult.md +12 -12
  76. data/docs/QueueResultAllOf.md +8 -8
  77. data/docs/RecordUtterance.md +27 -0
  78. data/docs/RecordUtteranceAllOf.md +27 -0
  79. data/docs/RecordingList.md +9 -9
  80. data/docs/RecordingListAllOf.md +2 -2
  81. data/docs/RecordingResult.md +10 -10
  82. data/docs/RecordingResultAllOf.md +6 -6
  83. data/docs/Redirect.md +17 -0
  84. data/docs/RedirectAllOf.md +17 -0
  85. data/docs/RemoveFromConference.md +17 -0
  86. data/docs/RemoveFromConferenceAllOf.md +17 -0
  87. data/docs/Say.md +25 -0
  88. data/docs/SayAllOf.md +25 -0
  89. data/docs/SendDigits.md +21 -0
  90. data/docs/SendDigitsAllOf.md +21 -0
  91. data/docs/SetListen.md +19 -0
  92. data/docs/SetListenAllOf.md +19 -0
  93. data/docs/SetTalk.md +19 -0
  94. data/docs/SetTalkAllOf.md +19 -0
  95. data/docs/Sms.md +23 -0
  96. data/docs/SmsAllOf.md +23 -0
  97. data/docs/StartRecordCall.md +16 -0
  98. data/docs/TerminateConference.md +17 -0
  99. data/docs/TerminateConferenceAllOf.md +17 -0
  100. data/docs/UpdateCallRequest.md +2 -4
  101. data/docs/UpdateConferenceParticipantRequest.md +3 -5
  102. data/docs/UpdateConferenceRequest.md +4 -6
  103. data/lib/freeclimb.rb +69 -2
  104. data/lib/freeclimb/api/default_api.rb +96 -88
  105. data/lib/freeclimb/api_client.rb +1 -1
  106. data/lib/freeclimb/models/account_request.rb +4 -14
  107. data/lib/freeclimb/models/add_to_conference.rb +320 -0
  108. data/lib/freeclimb/models/add_to_conference_all_of.rb +307 -0
  109. data/lib/freeclimb/models/application_request.rb +4 -14
  110. data/lib/freeclimb/models/buy_incoming_number_request.rb +4 -14
  111. data/lib/freeclimb/models/create_conference.rb +275 -0
  112. data/lib/freeclimb/models/create_conference_all_of.rb +262 -0
  113. data/lib/freeclimb/models/create_conference_request.rb +4 -14
  114. data/lib/freeclimb/models/dequeue.rb +209 -0
  115. data/lib/freeclimb/models/enqueue.rb +265 -0
  116. data/lib/freeclimb/models/enqueue_all_of.rb +252 -0
  117. data/lib/freeclimb/models/filter_logs_request.rb +4 -14
  118. data/lib/freeclimb/models/get_digits.rb +307 -0
  119. data/lib/freeclimb/models/get_digits_all_of.rb +294 -0
  120. data/lib/freeclimb/models/get_speech.rb +352 -0
  121. data/lib/freeclimb/models/get_speech_all_of.rb +339 -0
  122. data/lib/freeclimb/models/incoming_number_request.rb +4 -14
  123. data/lib/freeclimb/models/make_call_request.rb +14 -14
  124. data/lib/freeclimb/models/message_request.rb +1 -11
  125. data/lib/freeclimb/models/message_request_all_of.rb +1 -11
  126. data/lib/freeclimb/models/out_dial.rb +330 -0
  127. data/lib/freeclimb/models/out_dial_all_of.rb +317 -0
  128. data/lib/freeclimb/models/pause.rb +225 -0
  129. data/lib/freeclimb/models/{dequeue_member_request.rb → pause_all_of.rb} +16 -11
  130. data/lib/freeclimb/models/percl_command.rb +211 -0
  131. data/lib/freeclimb/models/percl_script.rb +210 -0
  132. data/lib/freeclimb/models/play.rb +255 -0
  133. data/lib/freeclimb/models/play_all_of.rb +242 -0
  134. data/lib/freeclimb/models/play_early_media.rb +225 -0
  135. data/lib/freeclimb/models/play_early_media_all_of.rb +212 -0
  136. data/lib/freeclimb/models/queue_request.rb +4 -14
  137. data/lib/freeclimb/models/record_utterance.rb +275 -0
  138. data/lib/freeclimb/models/record_utterance_all_of.rb +262 -0
  139. data/lib/freeclimb/models/redirect.rb +220 -0
  140. data/lib/freeclimb/models/redirect_all_of.rb +207 -0
  141. data/lib/freeclimb/models/remove_from_conference.rb +225 -0
  142. data/lib/freeclimb/models/remove_from_conference_all_of.rb +212 -0
  143. data/lib/freeclimb/models/say.rb +265 -0
  144. data/lib/freeclimb/models/say_all_of.rb +252 -0
  145. data/lib/freeclimb/models/send_digits.rb +245 -0
  146. data/lib/freeclimb/models/send_digits_all_of.rb +232 -0
  147. data/lib/freeclimb/models/set_listen.rb +235 -0
  148. data/lib/freeclimb/models/set_listen_all_of.rb +222 -0
  149. data/lib/freeclimb/models/set_talk.rb +235 -0
  150. data/lib/freeclimb/models/set_talk_all_of.rb +222 -0
  151. data/lib/freeclimb/models/sms.rb +265 -0
  152. data/lib/freeclimb/models/sms_all_of.rb +252 -0
  153. data/lib/freeclimb/models/start_record_call.rb +209 -0
  154. data/lib/freeclimb/models/terminate_conference.rb +225 -0
  155. data/lib/freeclimb/models/terminate_conference_all_of.rb +212 -0
  156. data/lib/freeclimb/models/update_call_request.rb +4 -14
  157. data/lib/freeclimb/models/update_conference_participant_request.rb +4 -14
  158. data/lib/freeclimb/models/update_conference_request.rb +4 -14
  159. data/lib/freeclimb/version.rb +1 -1
  160. data/spec/api/default_api_spec.rb +9 -24
  161. data/spec/models/add_to_conference_spec.rb +95 -0
  162. data/spec/models/create_conference_spec.rb +71 -0
  163. data/spec/models/{dequeue_member_request_spec.rb → dequeue_spec.rb} +8 -7
  164. data/spec/models/enqueue_spec.rb +59 -0
  165. data/spec/models/get_digits_spec.rb +83 -0
  166. data/spec/models/get_speech_spec.rb +113 -0
  167. data/spec/models/out_dial_spec.rb +89 -0
  168. data/spec/models/pause_spec.rb +41 -0
  169. data/spec/models/percl_command_spec.rb +41 -0
  170. data/spec/models/percl_script_spec.rb +41 -0
  171. data/spec/models/play_early_media_spec.rb +41 -0
  172. data/spec/models/play_spec.rb +53 -0
  173. data/spec/models/record_utterance_spec.rb +71 -0
  174. data/spec/models/redirect_spec.rb +41 -0
  175. data/spec/models/remove_from_conference_spec.rb +41 -0
  176. data/spec/models/say_spec.rb +65 -0
  177. data/spec/models/send_digits_spec.rb +47 -0
  178. data/spec/models/set_listen_spec.rb +47 -0
  179. data/spec/models/set_talk_spec.rb +47 -0
  180. data/spec/models/sms_spec.rb +59 -0
  181. data/spec/models/start_record_call_spec.rb +35 -0
  182. data/spec/models/terminate_conference_spec.rb +41 -0
  183. metadata +126 -35
  184. data/docs/DequeueMemberRequest.md +0 -17
  185. data/docs/Percl.md +0 -697
  186. data/git_push.sh +0 -58
  187. data/lib/percl/calls.rb +0 -43
  188. data/lib/percl/conference_participants.rb +0 -40
  189. data/lib/percl/conferences.rb +0 -21
  190. data/lib/percl/ivr.rb +0 -63
  191. data/lib/percl/jsonable.rb +0 -23
  192. data/lib/percl/percl.rb +0 -29
  193. data/lib/percl/queue_members.rb +0 -15
  194. data/lib/percl/recordings.rb +0 -15
  195. data/lib/percl/sms.rb +0 -11
  196. data/spec/percl/calls_spec.rb +0 -111
  197. data/spec/percl/conference_participant_spec.rb +0 -96
  198. data/spec/percl/conference_spec.rb +0 -46
  199. data/spec/percl/ivr_spec.rb +0 -155
  200. data/spec/percl/jsonable_spec.rb +0 -28
  201. data/spec/percl/percl_spec.rb +0 -31
  202. data/spec/percl/queue_members_spec.rb +0 -35
  203. data/spec/percl/recordings_spec.rb +0 -32
  204. data/spec/percl/sms_spec.rb +0 -29
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6c8945455e8f348b4bec450ae18fd8625deab7b722d0692a350acd8978650dbe
4
- data.tar.gz: ac7e84f670bbc020846d14acdc23b60af5faffe9c93e7f667ae4b200536d3171
3
+ metadata.gz: d5a21b6a4c4232634a11989f817ad275f52b00a6fc9ec0169b2acb044122e0b9
4
+ data.tar.gz: ef3a12e35b025c51f28a575b4ebaa23b1866a50fcb109541fd1e154cec30734b
5
5
  SHA512:
6
- metadata.gz: 1b7569004378a0e30262b44f23c769f2cef98860a4477224e7c9ddaf5de5dd896ddedc036e025ab1ed85df1f6ad73f76aecfc902f862481b7e3535befdef3b25
7
- data.tar.gz: d8e12e55d22cdac58a133be21edf439a3f8a692d76f9de73d9d390653dcfc3be10e2bc00d0ea945bb21d18df9752d4c1a38472a036be48021b8e20e7fa5363a6
6
+ metadata.gz: 8b6626ce1948b6160a939a87ed301f698770a499f658fa3cdfb4ed86664b292364574c533ca8c9b8f8e9b4f02d6d116ba60724becfac5dbccadbf51714736dac
7
+ data.tar.gz: ad7f8d3501a32dc3c678792874a2257c750c164e0839dd828f0de419448f0480d2e753f0d6f19c49e578fae01422b8cb318d70ed7a63814fbab3c0be55e02c9b
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- freeclimb (1.0.0)
4
+ freeclimb (2.0.0)
5
5
  json (~> 2.1, >= 2.1.0)
6
6
  typhoeus (~> 1.0, >= 1.0.1)
7
7
 
data/README.md CHANGED
@@ -1,13 +1,11 @@
1
- # freeclimb
2
-
3
- Freeclimb - the Ruby gem for the FreeClimb API
1
+ # FreeClimb
4
2
 
5
3
  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.
6
4
 
7
5
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
6
 
9
7
  - API version: 1.0.0
10
- - Package version: 1.0.0
8
+ - Package version: 2.0.2
11
9
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
10
 
13
11
  ## Installation
@@ -23,16 +21,21 @@ gem build freeclimb.gemspec
23
21
  Then either install the gem locally:
24
22
 
25
23
  ```shell
26
- gem install ./freeclimb-1.0.0.gem
24
+ gem install ./freeclimb-2.0.2.gem
27
25
  ```
28
26
 
29
- (for development, run `gem install --dev ./freeclimb-1.0.0.gem` to install the development dependencies)
27
+ (for development, run `gem install --dev ./freeclimb-2.0.2.gem` to install the development dependencies)
30
28
 
31
29
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
30
 
33
31
  Finally add this to the Gemfile:
34
32
 
35
- gem 'freeclimb', '~> 1.0.0'
33
+ gem 'freeclimb', '~> 2.0.2'
34
+
35
+ ### Install from Ruby gems
36
+ ```shell
37
+ gem install freeclimb
38
+ ```
36
39
 
37
40
  ### Install from Git
38
41
 
@@ -48,7 +51,7 @@ Include the Ruby code directly using `-I` as follows:
48
51
  ruby -Ilib script.rb
49
52
  ```
50
53
 
51
- ## Getting Started
54
+ ## Testing Your Installation
52
55
 
53
56
  Please follow the [installation](#installation) procedure and then run the following code:
54
57
 
@@ -64,18 +67,29 @@ Freeclimb.configure do |config|
64
67
  end
65
68
 
66
69
  api_instance = Freeclimb::DefaultApi.new
67
- opts = {
68
- buy_incoming_number_request: Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
69
- }
70
70
 
71
71
  begin
72
- #Buy a Phone Number
73
- result = api_instance.buy_a_phone_number(opts)
72
+ #Get an Account
73
+ result = api_instance.get_an_account
74
74
  p result
75
75
  rescue Freeclimb::ApiError => e
76
- puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
76
+ puts "Exception when calling DefaultApi->get_an_account: #{e}"
77
77
  end
78
78
 
79
+ ```
80
+ ## Documentation for PerCL
81
+
82
+ The Performance Command Language (PerCL) defines a set of instructions, written in JSON format, that express telephony actions to be performed in response to an event on the FreeClimb platform. FreeClimb communicates with the application server when events associated with the application occur, so the webserver can instruct FreeClimb how to handle such events using PerCL scripts.
83
+ PerCL commands are a part of the model schema and can be serialized into JSON like so:
84
+
85
+ ```ruby
86
+ require 'freeclimb'
87
+
88
+ say = Freeclimb::Say.new(text: "Hello, World")
89
+ play = Freeclimb::Play.new(file: "Example File")
90
+ get_digits = Freeclimb::GetDigits.new(action_url: "Example Action URL", prompts: [say, play])
91
+ percl_script = Freeclimb::PerclScript.new(commands: [get_digits])
92
+ puts Freeclimb::percl_to_json(percl_script)
79
93
  ```
80
94
 
81
95
  ## Documentation for API Endpoints
@@ -84,6 +98,7 @@ All URIs are relative to *https://www.freeclimb.com/apiserver*
84
98
 
85
99
  Class | Method | HTTP request | Description
86
100
  ------------ | ------------- | ------------- | -------------
101
+ *Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
87
102
  *Freeclimb::DefaultApi* | [**buy_a_phone_number**](docs/DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
88
103
  *Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
89
104
  *Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
@@ -101,7 +116,6 @@ Class | Method | HTTP request | Description
101
116
  *Freeclimb::DefaultApi* | [**get_a_participant**](docs/DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
102
117
  *Freeclimb::DefaultApi* | [**get_a_queue**](docs/DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
103
118
  *Freeclimb::DefaultApi* | [**get_a_recording**](docs/DefaultApi.md#get_a_recording) | **GET** /Accounts/{accountId}/Recordings/{recordingId} | Get a Recording
104
- *Freeclimb::DefaultApi* | [**get_an_account**](docs/DefaultApi.md#get_an_account) | **GET** /Accounts/{accountId} | Get an Account
105
119
  *Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
106
120
  *Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
107
121
  *Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
@@ -131,46 +145,14 @@ Class | Method | HTTP request | Description
131
145
  *Freeclimb::DefaultApi* | [**update_an_application**](docs/DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
132
146
  *Freeclimb::DefaultApi* | [**update_an_incoming_number**](docs/DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
133
147
 
134
- ## Documentation for PerCL Responses
135
- The Performance Command Language (PerCL) defines a set of instructions, written in JSON format, that express telephony actions to be performed in response to an event on the FreeClimb platform. FreeClimb communicates with the application server when events associated with the application occur, so the webserver can instruct FreeClimb how to handle such events using PerCL scripts.
136
-
137
- When creating a Percl object, required parameters must be used in the constructer while optional parameters must be set direclty on the given Percl object. Example:
138
- ```ruby
139
- digits = '630'
140
- send_digits = Percl::SendDigits.new(digits)
141
- send_digits.pauseMs = '500'
142
- ```
143
-
144
- Class | Description
145
- ------------ | -------------
146
- [*Percl::OutDial*](percl.md#percl::outdial) | The `OutDial` command is used to call a phone number
147
- [*Percl::Hangup*](percl.md#percl::hangup) | The `Hangup` command terminates a Call
148
- [*Percl::Pause*](percl.md#percl::pause) | The `Pause` command halts execution of the current PerCL script for a specified number of millisecond
149
- [*Percl::Redirect*](percl.md#percl::redirect) | The `Redirect` command transfers control of a Call to the PerCL at a different URL
150
- [*Percl::SendDigits*](percl.md#percl::senddigits) | The `SendDigits` command plays DTMF tones on a live Call. This is useful for navigating through IVR menus or dialing extensions
151
- [*Percl::Reject*](percl.md#percl::reject) | The `Reject` command blocks an incoming Call.
152
- [*Percl::CreateConference*](percl.md#percl::createConference) | The `CreateConference` command does exactly what its name implies — it creates an unpopulated Conference (one without any Participants).
153
- [*Percl::TerminateConference*](percl.md#percl::terminateConference) | The `TerminateConference` command terminates an existing Conference.
154
- [*Percl::AddToConference*](percl.md#percl::addToConference) | The `AddToConference` command adds a Participant to a Conference.
155
- [*Percl::RemoveFromConference*](percl.md#percl::removeFromConference) | The `RemoveFromConference` command removes a Participant from a Conference but does not hang up.
156
- [*Percl::SetListen*](percl.md#percl::setListen) | The `SetListen` command enables or disables the listen privilege for a Conference Participant provided both calls are in the same conference.
157
- [*Percl::SetTalk*](percl.md#percl::setTalk) | The `SetTalk` command enables or disables the talk privilege for a Participant in a Conference provided both calls are in the same conference.
158
- [*Percl::Enqueue*](percl.md#percl::enqueue) | The `Enqueue` command adds the current Call to a call Queue.
159
- [*Percl::Dequeue*](percl.md#percl::dequeue) | The `Dequeue` command transfers control of a Call that is in a Queue so that the waiting caller exits the Queue.
160
- [*Percl::RecordUtterance*](percl.md#percl::recordUtterance) | The `RecordUtterance` command records the caller's voice and returns the URL of a file containing the audio recording.
161
- [*Percl::StartRecordCall*](percl.md#percl::startRecordCall) | The `StartRecordCall` command records the current call and returns the URL of a file containing the audio recording when recording completes.
162
- [*Percl::PlayEarlyMedia*](percl.md#percl::playEarlyMedia) | The `PlayEarlyMedia` command plays A media file before attempting to connect a call
163
- [*Percl::Play*](percl.md#percl::play) | the `Play` command plays an audio file back to the caller.
164
- [*Percl::Say*](percl.md#percl::say) | The `Say` command provides Text-To-Speech (TTS) support. It converts text to speech and then renders it in a female voice back to the caller.
165
- [*Percl::GetDigits*](percl.md#percl::getDigits) | The `GetDigits` command collects DTMF inputs from the caller.
166
- [*Percl::GetSpeech*](percl.md#percl::getSpeech) | The `GetSpeech` command enables the Caller to respond to the application using a supported language.
167
- [*Percl::Sms*](percl.md#percl::Sms) | The `Sms` command can be used to send an SMS message to a phone number during a phone call.
168
148
 
169
149
  ## Documentation for Models
170
150
 
171
151
  - [Freeclimb::AccountRequest](docs/AccountRequest.md)
172
152
  - [Freeclimb::AccountResult](docs/AccountResult.md)
173
153
  - [Freeclimb::AccountResultAllOf](docs/AccountResultAllOf.md)
154
+ - [Freeclimb::AddToConference](docs/AddToConference.md)
155
+ - [Freeclimb::AddToConferenceAllOf](docs/AddToConferenceAllOf.md)
174
156
  - [Freeclimb::ApplicationList](docs/ApplicationList.md)
175
157
  - [Freeclimb::ApplicationListAllOf](docs/ApplicationListAllOf.md)
176
158
  - [Freeclimb::ApplicationRequest](docs/ApplicationRequest.md)
@@ -192,9 +174,17 @@ Class | Description
192
174
  - [Freeclimb::ConferenceParticipantResultAllOf](docs/ConferenceParticipantResultAllOf.md)
193
175
  - [Freeclimb::ConferenceResult](docs/ConferenceResult.md)
194
176
  - [Freeclimb::ConferenceResultAllOf](docs/ConferenceResultAllOf.md)
177
+ - [Freeclimb::CreateConference](docs/CreateConference.md)
178
+ - [Freeclimb::CreateConferenceAllOf](docs/CreateConferenceAllOf.md)
195
179
  - [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)
196
- - [Freeclimb::DequeueMemberRequest](docs/DequeueMemberRequest.md)
180
+ - [Freeclimb::Dequeue](docs/Dequeue.md)
181
+ - [Freeclimb::Enqueue](docs/Enqueue.md)
182
+ - [Freeclimb::EnqueueAllOf](docs/EnqueueAllOf.md)
197
183
  - [Freeclimb::FilterLogsRequest](docs/FilterLogsRequest.md)
184
+ - [Freeclimb::GetDigits](docs/GetDigits.md)
185
+ - [Freeclimb::GetDigitsAllOf](docs/GetDigitsAllOf.md)
186
+ - [Freeclimb::GetSpeech](docs/GetSpeech.md)
187
+ - [Freeclimb::GetSpeechAllOf](docs/GetSpeechAllOf.md)
198
188
  - [Freeclimb::IncomingNumberList](docs/IncomingNumberList.md)
199
189
  - [Freeclimb::IncomingNumberListAllOf](docs/IncomingNumberListAllOf.md)
200
190
  - [Freeclimb::IncomingNumberRequest](docs/IncomingNumberRequest.md)
@@ -211,7 +201,17 @@ Class | Description
211
201
  - [Freeclimb::MessagesList](docs/MessagesList.md)
212
202
  - [Freeclimb::MessagesListAllOf](docs/MessagesListAllOf.md)
213
203
  - [Freeclimb::MutableResourceModel](docs/MutableResourceModel.md)
204
+ - [Freeclimb::OutDial](docs/OutDial.md)
205
+ - [Freeclimb::OutDialAllOf](docs/OutDialAllOf.md)
214
206
  - [Freeclimb::PaginationModel](docs/PaginationModel.md)
207
+ - [Freeclimb::Pause](docs/Pause.md)
208
+ - [Freeclimb::PauseAllOf](docs/PauseAllOf.md)
209
+ - [Freeclimb::PerclCommand](docs/PerclCommand.md)
210
+ - [Freeclimb::PerclScript](docs/PerclScript.md)
211
+ - [Freeclimb::Play](docs/Play.md)
212
+ - [Freeclimb::PlayAllOf](docs/PlayAllOf.md)
213
+ - [Freeclimb::PlayEarlyMedia](docs/PlayEarlyMedia.md)
214
+ - [Freeclimb::PlayEarlyMediaAllOf](docs/PlayEarlyMediaAllOf.md)
215
215
  - [Freeclimb::QueueList](docs/QueueList.md)
216
216
  - [Freeclimb::QueueListAllOf](docs/QueueListAllOf.md)
217
217
  - [Freeclimb::QueueMember](docs/QueueMember.md)
@@ -220,10 +220,29 @@ Class | Description
220
220
  - [Freeclimb::QueueRequest](docs/QueueRequest.md)
221
221
  - [Freeclimb::QueueResult](docs/QueueResult.md)
222
222
  - [Freeclimb::QueueResultAllOf](docs/QueueResultAllOf.md)
223
+ - [Freeclimb::RecordUtterance](docs/RecordUtterance.md)
224
+ - [Freeclimb::RecordUtteranceAllOf](docs/RecordUtteranceAllOf.md)
223
225
  - [Freeclimb::RecordingList](docs/RecordingList.md)
224
226
  - [Freeclimb::RecordingListAllOf](docs/RecordingListAllOf.md)
225
227
  - [Freeclimb::RecordingResult](docs/RecordingResult.md)
226
228
  - [Freeclimb::RecordingResultAllOf](docs/RecordingResultAllOf.md)
229
+ - [Freeclimb::Redirect](docs/Redirect.md)
230
+ - [Freeclimb::RedirectAllOf](docs/RedirectAllOf.md)
231
+ - [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
232
+ - [Freeclimb::RemoveFromConferenceAllOf](docs/RemoveFromConferenceAllOf.md)
233
+ - [Freeclimb::Say](docs/Say.md)
234
+ - [Freeclimb::SayAllOf](docs/SayAllOf.md)
235
+ - [Freeclimb::SendDigits](docs/SendDigits.md)
236
+ - [Freeclimb::SendDigitsAllOf](docs/SendDigitsAllOf.md)
237
+ - [Freeclimb::SetListen](docs/SetListen.md)
238
+ - [Freeclimb::SetListenAllOf](docs/SetListenAllOf.md)
239
+ - [Freeclimb::SetTalk](docs/SetTalk.md)
240
+ - [Freeclimb::SetTalkAllOf](docs/SetTalkAllOf.md)
241
+ - [Freeclimb::Sms](docs/Sms.md)
242
+ - [Freeclimb::SmsAllOf](docs/SmsAllOf.md)
243
+ - [Freeclimb::StartRecordCall](docs/StartRecordCall.md)
244
+ - [Freeclimb::TerminateConference](docs/TerminateConference.md)
245
+ - [Freeclimb::TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
227
246
  - [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
228
247
  - [Freeclimb::UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
229
248
  - [Freeclimb::UpdateConferenceRequest](docs/UpdateConferenceRequest.md)
@@ -6,16 +6,14 @@ Name | Type | Description | Notes
6
6
  ------------ | ------------- | ------------- | -------------
7
7
  **_alias** | **String** | Description for this account. | [optional]
8
8
  **label** | **String** | Group to which this account belongs. | [optional]
9
- **request_id** | **String** | RequestId for this request starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response, e.g. X-Pulse-Request-Id: <requestId> | [optional]
10
9
 
11
10
  ## Code Sample
12
11
 
13
12
  ```ruby
14
- require 'Freeclimb'
13
+ require 'freeclimb'
15
14
 
16
- instance = Freeclimb::AccountRequest.new(_alias: null,
17
- label: null,
18
- request_id: null)
15
+ instance = Freeclimb::AccountRequest.new(_alias: nil,
16
+ label: nil)
19
17
  ```
20
18
 
21
19
 
@@ -19,19 +19,19 @@ Name | Type | Description | Notes
19
19
  ## Code Sample
20
20
 
21
21
  ```ruby
22
- require 'Freeclimb'
22
+ require 'freeclimb'
23
23
 
24
- instance = Freeclimb::AccountResult.new(uri: null,
25
- date_created: null,
26
- date_updated: null,
27
- revision: null,
28
- account_id: null,
29
- auth_token: null,
30
- _alias: null,
31
- label: null,
32
- type: null,
33
- status: null,
34
- subresource_uris: null)
24
+ instance = Freeclimb::AccountResult.new(uri: nil,
25
+ date_created: nil,
26
+ date_updated: nil,
27
+ revision: nil,
28
+ account_id: nil,
29
+ auth_token: nil,
30
+ _alias: nil,
31
+ label: nil,
32
+ type: nil,
33
+ status: nil,
34
+ subresource_uris: nil)
35
35
  ```
36
36
 
37
37
 
@@ -15,15 +15,15 @@ Name | Type | Description | Notes
15
15
  ## Code Sample
16
16
 
17
17
  ```ruby
18
- require 'Freeclimb'
18
+ require 'freeclimb'
19
19
 
20
- instance = Freeclimb::AccountResultAllOf.new(account_id: null,
21
- auth_token: null,
22
- _alias: null,
23
- label: null,
24
- type: null,
25
- status: null,
26
- subresource_uris: null)
20
+ instance = Freeclimb::AccountResultAllOf.new(account_id: nil,
21
+ auth_token: nil,
22
+ _alias: nil,
23
+ label: nil,
24
+ type: nil,
25
+ status: nil,
26
+ subresource_uris: nil)
27
27
  ```
28
28
 
29
29
 
@@ -0,0 +1,35 @@
1
+ # Freeclimb::AddToConference
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **allow_call_control** | **Boolean** | If `true`, Call control will be enabled for this Participant's Call leg. | [optional]
8
+ **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used. | [optional]
9
+ **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute. | [optional]
10
+ **conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
11
+ **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
12
+ **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
13
+ **listen** | **Boolean** | If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command. | [optional]
14
+ **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
15
+ **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional]
16
+ **talk** | **Boolean** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional]
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'freeclimb'
22
+
23
+ instance = Freeclimb::AddToConference.new(allow_call_control: nil,
24
+ call_control_sequence: nil,
25
+ call_control_url: nil,
26
+ conference_id: nil,
27
+ call_id: nil,
28
+ leave_conference_url: nil,
29
+ listen: nil,
30
+ notification_url: nil,
31
+ start_conf_on_enter: nil,
32
+ talk: nil)
33
+ ```
34
+
35
+
@@ -0,0 +1,35 @@
1
+ # Freeclimb::AddToConferenceAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **allow_call_control** | **Boolean** | If `true`, Call control will be enabled for this Participant's Call leg. | [optional]
8
+ **call_control_sequence** | **String** | Defines a sequence of digits that, when entered by this caller, invokes the `callControlUrl`. Only digits plus '*', and '#' may be used. | [optional]
9
+ **call_control_url** | **String** | URL to be invoked when this Participant enters the digit sequence defined in the `callControlSequence` attribute. | [optional]
10
+ **conference_id** | **String** | ID of the Conference to which to add the Participant (Call leg). Conference must exist or an error will result. |
11
+ **call_id** | **Boolean** | ID of the Call that will be added to the specified Conference. The Call must be in progress or an error will result. If the Call is part of an existing Conference, it is first removed from that Conference and is then moved to the new one. |
12
+ **leave_conference_url** | **String** | URL to be invoked when the Participant leaves the Conference. | [optional]
13
+ **listen** | **Boolean** | If `true`, the Participant joins the Conference with listen privileges. This may be modified later via the REST API or `SetListen` PerCL command. | [optional]
14
+ **notification_url** | **String** | When the Participant enters the Conference, this URL will be invoked using an HTTP POST request with the standard request parameters. | [optional]
15
+ **start_conf_on_enter** | **Boolean** | Flag that indicates whether a Conference starts upon entry of this particular Participant. This is usually set to `true` for moderators and `false` for all other Participants. | [optional]
16
+ **talk** | **Boolean** | If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. | [optional]
17
+
18
+ ## Code Sample
19
+
20
+ ```ruby
21
+ require 'freeclimb'
22
+
23
+ instance = Freeclimb::AddToConferenceAllOf.new(allow_call_control: nil,
24
+ call_control_sequence: nil,
25
+ call_control_url: nil,
26
+ conference_id: nil,
27
+ call_id: nil,
28
+ leave_conference_url: nil,
29
+ listen: nil,
30
+ notification_url: nil,
31
+ start_conf_on_enter: nil,
32
+ talk: nil)
33
+ ```
34
+
35
+
@@ -16,16 +16,16 @@ Name | Type | Description | Notes
16
16
  ## Code Sample
17
17
 
18
18
  ```ruby
19
- require 'Freeclimb'
19
+ require 'freeclimb'
20
20
 
21
- instance = Freeclimb::ApplicationList.new(total: null,
22
- start: null,
23
- _end: null,
24
- page: null,
25
- num_pages: null,
26
- page_size: null,
27
- next_page_uri: null,
28
- applications: null)
21
+ instance = Freeclimb::ApplicationList.new(total: nil,
22
+ start: nil,
23
+ _end: nil,
24
+ page: nil,
25
+ num_pages: nil,
26
+ page_size: nil,
27
+ next_page_uri: nil,
28
+ applications: nil)
29
29
  ```
30
30
 
31
31
 
@@ -9,9 +9,9 @@ Name | Type | Description | Notes
9
9
  ## Code Sample
10
10
 
11
11
  ```ruby
12
- require 'Freeclimb'
12
+ require 'freeclimb'
13
13
 
14
- instance = Freeclimb::ApplicationListAllOf.new(applications: null)
14
+ instance = Freeclimb::ApplicationListAllOf.new(applications: nil)
15
15
  ```
16
16
 
17
17
 
@@ -11,21 +11,19 @@ Name | Type | Description | Notes
11
11
  **status_callback_url** | **String** | 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. | [optional]
12
12
  **sms_url** | **String** | 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. | [optional]
13
13
  **sms_fallback_url** | **String** | 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. | [optional]
14
- **request_id** | **String** | The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will include this requestId. If it is not provided, FreeClimb will generate a requestId and return it as a header in the response, e.g. X-Pulse-Request-Id: <requestId> | [optional]
15
14
 
16
15
  ## Code Sample
17
16
 
18
17
  ```ruby
19
- require 'Freeclimb'
18
+ require 'freeclimb'
20
19
 
21
- instance = Freeclimb::ApplicationRequest.new(_alias: null,
22
- voice_url: null,
23
- voice_fallback_url: null,
24
- call_connect_url: null,
25
- status_callback_url: null,
26
- sms_url: null,
27
- sms_fallback_url: null,
28
- request_id: null)
20
+ instance = Freeclimb::ApplicationRequest.new(_alias: nil,
21
+ voice_url: nil,
22
+ voice_fallback_url: nil,
23
+ call_connect_url: nil,
24
+ status_callback_url: nil,
25
+ sms_url: nil,
26
+ sms_fallback_url: nil)
29
27
  ```
30
28
 
31
29