freeclimb 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (195) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +10 -0
  3. data/Gemfile.lock +82 -0
  4. data/README.md +238 -0
  5. data/Rakefile +10 -0
  6. data/docs/AccountRequest.md +21 -0
  7. data/docs/AccountResult.md +37 -0
  8. data/docs/AccountResultAllOf.md +29 -0
  9. data/docs/ApplicationList.md +31 -0
  10. data/docs/ApplicationListAllOf.md +17 -0
  11. data/docs/ApplicationRequest.md +31 -0
  12. data/docs/ApplicationResult.md +41 -0
  13. data/docs/ApplicationResultAllOf.md +33 -0
  14. data/docs/AvailableNumber.md +27 -0
  15. data/docs/AvailableNumberList.md +31 -0
  16. data/docs/AvailableNumberListAllOf.md +17 -0
  17. data/docs/BuyIncomingNumberRequest.md +23 -0
  18. data/docs/CallList.md +31 -0
  19. data/docs/CallListAllOf.md +17 -0
  20. data/docs/CallResult.md +53 -0
  21. data/docs/CallResultAllOf.md +45 -0
  22. data/docs/ConferenceList.md +31 -0
  23. data/docs/ConferenceListAllOf.md +17 -0
  24. data/docs/ConferenceParticipantList.md +31 -0
  25. data/docs/ConferenceParticipantListAllOf.md +17 -0
  26. data/docs/ConferenceParticipantResult.md +35 -0
  27. data/docs/ConferenceParticipantResultAllOf.md +27 -0
  28. data/docs/ConferenceResult.md +43 -0
  29. data/docs/ConferenceResultAllOf.md +35 -0
  30. data/docs/CreateConferenceRequest.md +27 -0
  31. data/docs/DefaultApi.md +2504 -0
  32. data/docs/DequeueMemberRequest.md +17 -0
  33. data/docs/FilterLogsRequest.md +19 -0
  34. data/docs/IncomingNumberList.md +31 -0
  35. data/docs/IncomingNumberListAllOf.md +17 -0
  36. data/docs/IncomingNumberRequest.md +21 -0
  37. data/docs/IncomingNumberResult.md +41 -0
  38. data/docs/IncomingNumberResultAllOf.md +33 -0
  39. data/docs/LogList.md +31 -0
  40. data/docs/LogListAllOf.md +17 -0
  41. data/docs/LogResult.md +29 -0
  42. data/docs/MakeCallRequest.md +33 -0
  43. data/docs/MessageRequest.md +35 -0
  44. data/docs/MessageRequestAllOf.md +27 -0
  45. data/docs/MessageResult.md +39 -0
  46. data/docs/MessageResultAllOf.md +31 -0
  47. data/docs/MessagesList.md +31 -0
  48. data/docs/MessagesListAllOf.md +17 -0
  49. data/docs/MutableResourceModel.md +23 -0
  50. data/docs/PaginationModel.md +29 -0
  51. data/docs/Percl.md +697 -0
  52. data/docs/QueueList.md +31 -0
  53. data/docs/QueueListAllOf.md +17 -0
  54. data/docs/QueueMember.md +25 -0
  55. data/docs/QueueMemberList.md +31 -0
  56. data/docs/QueueMemberListAllOf.md +17 -0
  57. data/docs/QueueRequest.md +21 -0
  58. data/docs/QueueResult.md +37 -0
  59. data/docs/QueueResultAllOf.md +29 -0
  60. data/docs/RecordingList.md +31 -0
  61. data/docs/RecordingListAllOf.md +17 -0
  62. data/docs/RecordingResult.md +33 -0
  63. data/docs/RecordingResultAllOf.md +25 -0
  64. data/docs/UpdateCallRequest.md +19 -0
  65. data/docs/UpdateConferenceParticipantRequest.md +21 -0
  66. data/docs/UpdateConferenceRequest.md +23 -0
  67. data/freeclimb.gemspec +39 -0
  68. data/git_push.sh +58 -0
  69. data/lib/freeclimb.rb +99 -0
  70. data/lib/freeclimb/api/default_api.rb +2845 -0
  71. data/lib/freeclimb/api_client.rb +386 -0
  72. data/lib/freeclimb/api_error.rb +57 -0
  73. data/lib/freeclimb/configuration.rb +248 -0
  74. data/lib/freeclimb/models/account_request.rb +227 -0
  75. data/lib/freeclimb/models/account_result.rb +349 -0
  76. data/lib/freeclimb/models/account_result_all_of.rb +301 -0
  77. data/lib/freeclimb/models/application_list.rb +286 -0
  78. data/lib/freeclimb/models/application_list_all_of.rb +208 -0
  79. data/lib/freeclimb/models/application_request.rb +277 -0
  80. data/lib/freeclimb/models/application_result.rb +335 -0
  81. data/lib/freeclimb/models/application_result_all_of.rb +287 -0
  82. data/lib/freeclimb/models/available_number.rb +257 -0
  83. data/lib/freeclimb/models/available_number_list.rb +286 -0
  84. data/lib/freeclimb/models/available_number_list_all_of.rb +208 -0
  85. data/lib/freeclimb/models/buy_incoming_number_request.rb +242 -0
  86. data/lib/freeclimb/models/call_list.rb +286 -0
  87. data/lib/freeclimb/models/call_list_all_of.rb +208 -0
  88. data/lib/freeclimb/models/call_result.rb +429 -0
  89. data/lib/freeclimb/models/call_result_all_of.rb +381 -0
  90. data/lib/freeclimb/models/conference_list.rb +286 -0
  91. data/lib/freeclimb/models/conference_list_all_of.rb +208 -0
  92. data/lib/freeclimb/models/conference_participant_list.rb +286 -0
  93. data/lib/freeclimb/models/conference_participant_list_all_of.rb +208 -0
  94. data/lib/freeclimb/models/conference_participant_result.rb +305 -0
  95. data/lib/freeclimb/models/conference_participant_result_all_of.rb +257 -0
  96. data/lib/freeclimb/models/conference_result.rb +391 -0
  97. data/lib/freeclimb/models/conference_result_all_of.rb +343 -0
  98. data/lib/freeclimb/models/create_conference_request.rb +293 -0
  99. data/lib/freeclimb/models/dequeue_member_request.rb +207 -0
  100. data/lib/freeclimb/models/filter_logs_request.rb +222 -0
  101. data/lib/freeclimb/models/incoming_number_list.rb +286 -0
  102. data/lib/freeclimb/models/incoming_number_list_all_of.rb +208 -0
  103. data/lib/freeclimb/models/incoming_number_request.rb +227 -0
  104. data/lib/freeclimb/models/incoming_number_result.rb +335 -0
  105. data/lib/freeclimb/models/incoming_number_result_all_of.rb +287 -0
  106. data/lib/freeclimb/models/log_list.rb +286 -0
  107. data/lib/freeclimb/models/log_list_all_of.rb +208 -0
  108. data/lib/freeclimb/models/log_result.rb +301 -0
  109. data/lib/freeclimb/models/make_call_request.rb +302 -0
  110. data/lib/freeclimb/models/message_request.rb +320 -0
  111. data/lib/freeclimb/models/message_request_all_of.rb +272 -0
  112. data/lib/freeclimb/models/message_result.rb +359 -0
  113. data/lib/freeclimb/models/message_result_all_of.rb +311 -0
  114. data/lib/freeclimb/models/messages_list.rb +287 -0
  115. data/lib/freeclimb/models/messages_list_all_of.rb +209 -0
  116. data/lib/freeclimb/models/mutable_resource_model.rb +237 -0
  117. data/lib/freeclimb/models/pagination_model.rb +267 -0
  118. data/lib/freeclimb/models/queue_list.rb +286 -0
  119. data/lib/freeclimb/models/queue_list_all_of.rb +208 -0
  120. data/lib/freeclimb/models/queue_member.rb +247 -0
  121. data/lib/freeclimb/models/queue_member_list.rb +286 -0
  122. data/lib/freeclimb/models/queue_member_list_all_of.rb +208 -0
  123. data/lib/freeclimb/models/queue_request.rb +227 -0
  124. data/lib/freeclimb/models/queue_result.rb +315 -0
  125. data/lib/freeclimb/models/queue_result_all_of.rb +267 -0
  126. data/lib/freeclimb/models/recording_list.rb +286 -0
  127. data/lib/freeclimb/models/recording_list_all_of.rb +208 -0
  128. data/lib/freeclimb/models/recording_result.rb +295 -0
  129. data/lib/freeclimb/models/recording_result_all_of.rb +247 -0
  130. data/lib/freeclimb/models/update_call_request.rb +256 -0
  131. data/lib/freeclimb/models/update_conference_participant_request.rb +227 -0
  132. data/lib/freeclimb/models/update_conference_request.rb +273 -0
  133. data/lib/freeclimb/version.rb +15 -0
  134. data/lib/percl/calls.rb +43 -0
  135. data/lib/percl/conference_participants.rb +40 -0
  136. data/lib/percl/conferences.rb +21 -0
  137. data/lib/percl/ivr.rb +63 -0
  138. data/lib/percl/jsonable.rb +23 -0
  139. data/lib/percl/percl.rb +29 -0
  140. data/lib/percl/queue_members.rb +15 -0
  141. data/lib/percl/recordings.rb +15 -0
  142. data/lib/percl/sms.rb +11 -0
  143. data/spec/api/default_api_spec.rb +1151 -0
  144. data/spec/api/web_mocks.rb +473 -0
  145. data/spec/api_client_spec.rb +226 -0
  146. data/spec/configuration_spec.rb +34 -0
  147. data/spec/models/account_request_spec.rb +33 -0
  148. data/spec/models/account_result_spec.rb +33 -0
  149. data/spec/models/application_list_spec.rb +33 -0
  150. data/spec/models/application_request_spec.rb +33 -0
  151. data/spec/models/application_result_spec.rb +33 -0
  152. data/spec/models/available_number_list_spec.rb +34 -0
  153. data/spec/models/available_number_spec.rb +33 -0
  154. data/spec/models/buy_incoming_number_request_spec.rb +33 -0
  155. data/spec/models/call_list_spec.rb +34 -0
  156. data/spec/models/call_result_spec.rb +34 -0
  157. data/spec/models/conference_list_spec.rb +33 -0
  158. data/spec/models/conference_participant_list_spec.rb +33 -0
  159. data/spec/models/conference_participant_result_spec.rb +33 -0
  160. data/spec/models/conference_result_spec.rb +34 -0
  161. data/spec/models/create_conference_request_spec.rb +34 -0
  162. data/spec/models/dequeue_member_request_spec.rb +34 -0
  163. data/spec/models/filter_logs_request_spec.rb +33 -0
  164. data/spec/models/incoming_number_list_spec.rb +34 -0
  165. data/spec/models/incoming_number_request_spec.rb +33 -0
  166. data/spec/models/incoming_number_result_spec.rb +34 -0
  167. data/spec/models/log_list_spec.rb +33 -0
  168. data/spec/models/log_result_spec.rb +33 -0
  169. data/spec/models/make_call_request_spec.rb +33 -0
  170. data/spec/models/message_request_spec.rb +34 -0
  171. data/spec/models/message_result_spec.rb +33 -0
  172. data/spec/models/messages_list_spec.rb +33 -0
  173. data/spec/models/mutable_resource_model_spec.rb +34 -0
  174. data/spec/models/pagination_model_spec.rb +33 -0
  175. data/spec/models/queue_list_spec.rb +34 -0
  176. data/spec/models/queue_member_list_spec.rb +33 -0
  177. data/spec/models/queue_member_spec.rb +34 -0
  178. data/spec/models/queue_request_spec.rb +34 -0
  179. data/spec/models/queue_result_spec.rb +33 -0
  180. data/spec/models/recording_list_spec.rb +33 -0
  181. data/spec/models/recording_result_spec.rb +33 -0
  182. data/spec/models/update_call_request_spec.rb +33 -0
  183. data/spec/models/update_conference_participant_request_spec.rb +33 -0
  184. data/spec/models/update_conference_request_spec.rb +33 -0
  185. data/spec/percl/calls_spec.rb +111 -0
  186. data/spec/percl/conference_participant_spec.rb +96 -0
  187. data/spec/percl/conference_spec.rb +46 -0
  188. data/spec/percl/ivr_spec.rb +155 -0
  189. data/spec/percl/jsonable_spec.rb +28 -0
  190. data/spec/percl/percl_spec.rb +31 -0
  191. data/spec/percl/queue_members_spec.rb +35 -0
  192. data/spec/percl/recordings_spec.rb +32 -0
  193. data/spec/percl/sms_spec.rb +29 -0
  194. data/spec/spec_helper.rb +114 -0
  195. metadata +355 -0
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: 6c8945455e8f348b4bec450ae18fd8625deab7b722d0692a350acd8978650dbe
4
+ data.tar.gz: ac7e84f670bbc020846d14acdc23b60af5faffe9c93e7f667ae4b200536d3171
5
+ SHA512:
6
+ metadata.gz: 1b7569004378a0e30262b44f23c769f2cef98860a4477224e7c9ddaf5de5dd896ddedc036e025ab1ed85df1f6ad73f76aecfc902f862481b7e3535befdef3b25
7
+ data.tar.gz: d8e12e55d22cdac58a133be21edf439a3f8a692d76f9de73d9d390653dcfc3be10e2bc00d0ea945bb21d18df9752d4c1a38472a036be48021b8e20e7fa5363a6
data/Gemfile ADDED
@@ -0,0 +1,10 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gemspec
4
+
5
+ group :development, :test do
6
+ gem 'rake', '~> 12.0.0'
7
+ gem 'pry-byebug'
8
+ gem "webmock", "~> 3.8"
9
+ gem 'rubocop', '~> 0.66.0'
10
+ end
data/Gemfile.lock ADDED
@@ -0,0 +1,82 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ freeclimb (1.0.0)
5
+ json (~> 2.1, >= 2.1.0)
6
+ typhoeus (~> 1.0, >= 1.0.1)
7
+
8
+ GEM
9
+ remote: https://rubygems.org/
10
+ specs:
11
+ addressable (2.7.0)
12
+ public_suffix (>= 2.0.2, < 5.0)
13
+ ast (2.4.0)
14
+ byebug (11.1.1)
15
+ coderay (1.1.2)
16
+ crack (0.4.3)
17
+ safe_yaml (~> 1.0.0)
18
+ diff-lcs (1.3)
19
+ ethon (0.12.0)
20
+ ffi (>= 1.3.0)
21
+ ffi (1.12.1)
22
+ hashdiff (1.0.0)
23
+ jaro_winkler (1.5.4)
24
+ json (2.3.0)
25
+ method_source (0.9.2)
26
+ parallel (1.19.1)
27
+ parser (2.7.0.2)
28
+ ast (~> 2.4.0)
29
+ pry (0.12.2)
30
+ coderay (~> 1.1.0)
31
+ method_source (~> 0.9.0)
32
+ pry-byebug (3.8.0)
33
+ byebug (~> 11.0)
34
+ pry (~> 0.10)
35
+ psych (3.1.0)
36
+ public_suffix (4.0.3)
37
+ rainbow (3.0.0)
38
+ rake (12.0.0)
39
+ rspec (3.9.0)
40
+ rspec-core (~> 3.9.0)
41
+ rspec-expectations (~> 3.9.0)
42
+ rspec-mocks (~> 3.9.0)
43
+ rspec-core (3.9.1)
44
+ rspec-support (~> 3.9.1)
45
+ rspec-expectations (3.9.0)
46
+ diff-lcs (>= 1.2.0, < 2.0)
47
+ rspec-support (~> 3.9.0)
48
+ rspec-mocks (3.9.1)
49
+ diff-lcs (>= 1.2.0, < 2.0)
50
+ rspec-support (~> 3.9.0)
51
+ rspec-support (3.9.2)
52
+ rubocop (0.66.0)
53
+ jaro_winkler (~> 1.5.1)
54
+ parallel (~> 1.10)
55
+ parser (>= 2.5, != 2.5.1.1)
56
+ psych (>= 3.1.0)
57
+ rainbow (>= 2.2.2, < 4.0)
58
+ ruby-progressbar (~> 1.7)
59
+ unicode-display_width (>= 1.4.0, < 1.6)
60
+ ruby-progressbar (1.10.1)
61
+ safe_yaml (1.0.5)
62
+ typhoeus (1.3.1)
63
+ ethon (>= 0.9.0)
64
+ unicode-display_width (1.5.0)
65
+ webmock (3.8.0)
66
+ addressable (>= 2.3.6)
67
+ crack (>= 0.3.2)
68
+ hashdiff (>= 0.4.0, < 2.0.0)
69
+
70
+ PLATFORMS
71
+ ruby
72
+
73
+ DEPENDENCIES
74
+ freeclimb!
75
+ pry-byebug
76
+ rake (~> 12.0.0)
77
+ rspec (~> 3.6, >= 3.6.0)
78
+ rubocop (~> 0.66.0)
79
+ webmock (~> 3.8)
80
+
81
+ BUNDLED WITH
82
+ 1.17.2
data/README.md ADDED
@@ -0,0 +1,238 @@
1
+ # freeclimb
2
+
3
+ Freeclimb - the Ruby gem for the FreeClimb API
4
+
5
+ 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
+
7
+ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
+
9
+ - API version: 1.0.0
10
+ - Package version: 1.0.0
11
+ - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
+
13
+ ## Installation
14
+
15
+ ### Build a gem
16
+
17
+ To build the Ruby code into a gem:
18
+
19
+ ```shell
20
+ gem build freeclimb.gemspec
21
+ ```
22
+
23
+ Then either install the gem locally:
24
+
25
+ ```shell
26
+ gem install ./freeclimb-1.0.0.gem
27
+ ```
28
+
29
+ (for development, run `gem install --dev ./freeclimb-1.0.0.gem` to install the development dependencies)
30
+
31
+ or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
+
33
+ Finally add this to the Gemfile:
34
+
35
+ gem 'freeclimb', '~> 1.0.0'
36
+
37
+ ### Install from Git
38
+
39
+ If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
40
+
41
+ gem 'freeclimb', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
42
+
43
+ ### Include the Ruby code directly
44
+
45
+ Include the Ruby code directly using `-I` as follows:
46
+
47
+ ```shell
48
+ ruby -Ilib script.rb
49
+ ```
50
+
51
+ ## Getting Started
52
+
53
+ Please follow the [installation](#installation) procedure and then run the following code:
54
+
55
+ ```ruby
56
+ # Load the gem
57
+ require 'freeclimb'
58
+
59
+ # Setup authorization
60
+ Freeclimb.configure do |config|
61
+ # Configure HTTP basic authorization: fc
62
+ config.username = 'ACCOUNT_ID'
63
+ config.password = 'AUTH_TOKEN'
64
+ end
65
+
66
+ api_instance = Freeclimb::DefaultApi.new
67
+ opts = {
68
+ buy_incoming_number_request: Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
69
+ }
70
+
71
+ begin
72
+ #Buy a Phone Number
73
+ result = api_instance.buy_a_phone_number(opts)
74
+ p result
75
+ rescue Freeclimb::ApiError => e
76
+ puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
77
+ end
78
+
79
+ ```
80
+
81
+ ## Documentation for API Endpoints
82
+
83
+ All URIs are relative to *https://www.freeclimb.com/apiserver*
84
+
85
+ Class | Method | HTTP request | Description
86
+ ------------ | ------------- | ------------- | -------------
87
+ *Freeclimb::DefaultApi* | [**buy_a_phone_number**](docs/DefaultApi.md#buy_a_phone_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers | Buy a Phone Number
88
+ *Freeclimb::DefaultApi* | [**create_a_conference**](docs/DefaultApi.md#create_a_conference) | **POST** /Accounts/{accountId}/Conferences | Create a Conference
89
+ *Freeclimb::DefaultApi* | [**create_a_queue**](docs/DefaultApi.md#create_a_queue) | **POST** /Accounts/{accountId}/Queues | Create a Queue
90
+ *Freeclimb::DefaultApi* | [**create_an_application**](docs/DefaultApi.md#create_an_application) | **POST** /Accounts/{accountId}/Applications | Create an application
91
+ *Freeclimb::DefaultApi* | [**delete_a_recording**](docs/DefaultApi.md#delete_a_recording) | **DELETE** /Accounts/{accountId}/Recordings/{recordingId} | Delete a Recording
92
+ *Freeclimb::DefaultApi* | [**delete_an_application**](docs/DefaultApi.md#delete_an_application) | **DELETE** /Accounts/{accountId}/Applications/{applicationId} | Delete an application
93
+ *Freeclimb::DefaultApi* | [**delete_an_incoming_number**](docs/DefaultApi.md#delete_an_incoming_number) | **DELETE** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Delete an Incoming Number
94
+ *Freeclimb::DefaultApi* | [**dequeue_a_member**](docs/DefaultApi.md#dequeue_a_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Dequeue a Member
95
+ *Freeclimb::DefaultApi* | [**dequeue_head_member**](docs/DefaultApi.md#dequeue_head_member) | **POST** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Dequeue Head Member
96
+ *Freeclimb::DefaultApi* | [**download_a_recording_file**](docs/DefaultApi.md#download_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Download | Download a Recording File
97
+ *Freeclimb::DefaultApi* | [**filter_logs**](docs/DefaultApi.md#filter_logs) | **POST** /Accounts/{accountId}/Logs | Filter Logs
98
+ *Freeclimb::DefaultApi* | [**get_a_call**](docs/DefaultApi.md#get_a_call) | **GET** /Accounts/{accountId}/Calls/{callId} | Get a Call
99
+ *Freeclimb::DefaultApi* | [**get_a_conference**](docs/DefaultApi.md#get_a_conference) | **GET** /Accounts/{accountId}/Conferences/{conferenceId} | Get a Conference
100
+ *Freeclimb::DefaultApi* | [**get_a_member**](docs/DefaultApi.md#get_a_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/{callId} | Get a Member
101
+ *Freeclimb::DefaultApi* | [**get_a_participant**](docs/DefaultApi.md#get_a_participant) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Get a Participant
102
+ *Freeclimb::DefaultApi* | [**get_a_queue**](docs/DefaultApi.md#get_a_queue) | **GET** /Accounts/{accountId}/Queues/{queueId} | Get a Queue
103
+ *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
+ *Freeclimb::DefaultApi* | [**get_an_application**](docs/DefaultApi.md#get_an_application) | **GET** /Accounts/{accountId}/Applications/{applicationId} | Get an Application
106
+ *Freeclimb::DefaultApi* | [**get_an_incoming_number**](docs/DefaultApi.md#get_an_incoming_number) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Get an Incoming Number
107
+ *Freeclimb::DefaultApi* | [**get_an_sms_message**](docs/DefaultApi.md#get_an_sms_message) | **GET** /Accounts/{accountId}/Messages/{messageId} | Get an SMS Message
108
+ *Freeclimb::DefaultApi* | [**get_head_member**](docs/DefaultApi.md#get_head_member) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members/Front | Get Head Member
109
+ *Freeclimb::DefaultApi* | [**list_active_queues**](docs/DefaultApi.md#list_active_queues) | **GET** /Accounts/{accountId}/Queues | List Active Queues
110
+ *Freeclimb::DefaultApi* | [**list_all_account_logs**](docs/DefaultApi.md#list_all_account_logs) | **GET** /Accounts/{accountId}/Logs | List All Account Logs
111
+ *Freeclimb::DefaultApi* | [**list_an_application**](docs/DefaultApi.md#list_an_application) | **GET** /Accounts/{accountId}/Applications | List applications
112
+ *Freeclimb::DefaultApi* | [**list_available_numbers**](docs/DefaultApi.md#list_available_numbers) | **GET** /AvailablePhoneNumbers | List available numbers
113
+ *Freeclimb::DefaultApi* | [**list_call_logs**](docs/DefaultApi.md#list_call_logs) | **GET** /Accounts/{accountId}/Calls/{callId}/Logs | List Call Logs
114
+ *Freeclimb::DefaultApi* | [**list_call_recordings**](docs/DefaultApi.md#list_call_recordings) | **GET** /Accounts/{accountId}/Calls/{callId}/Recordings | List Call Recordings
115
+ *Freeclimb::DefaultApi* | [**list_calls**](docs/DefaultApi.md#list_calls) | **GET** /Accounts/{accountId}/Calls | List Calls
116
+ *Freeclimb::DefaultApi* | [**list_conferences**](docs/DefaultApi.md#list_conferences) | **GET** /Accounts/{accountId}/Conferences | List Conferences
117
+ *Freeclimb::DefaultApi* | [**list_incoming_numbers**](docs/DefaultApi.md#list_incoming_numbers) | **GET** /Accounts/{accountId}/IncomingPhoneNumbers | List Incoming Numbers
118
+ *Freeclimb::DefaultApi* | [**list_members**](docs/DefaultApi.md#list_members) | **GET** /Accounts/{accountId}/Queues/{queueId}/Members | List Members
119
+ *Freeclimb::DefaultApi* | [**list_participants**](docs/DefaultApi.md#list_participants) | **GET** /Accounts/{accountId}/Conferences/{conferenceId}/Participants | List Participants
120
+ *Freeclimb::DefaultApi* | [**list_recordings**](docs/DefaultApi.md#list_recordings) | **GET** /Accounts/{accountId}/Recordings | List Recordings
121
+ *Freeclimb::DefaultApi* | [**list_sms_messages**](docs/DefaultApi.md#list_sms_messages) | **GET** /Accounts/{accountId}/Messages | List SMS Messages
122
+ *Freeclimb::DefaultApi* | [**make_a_call**](docs/DefaultApi.md#make_a_call) | **POST** /Accounts/{accountId}/Calls | Make a Call
123
+ *Freeclimb::DefaultApi* | [**remove_a_participant**](docs/DefaultApi.md#remove_a_participant) | **DELETE** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Remove a Participant
124
+ *Freeclimb::DefaultApi* | [**send_an_sms_message**](docs/DefaultApi.md#send_an_sms_message) | **POST** /Accounts/{accountId}/Messages | Send an SMS Message
125
+ *Freeclimb::DefaultApi* | [**stream_a_recording_file**](docs/DefaultApi.md#stream_a_recording_file) | **GET** /Accounts/{accountId}/Recordings/{recordingId}/Stream | Stream a Recording File
126
+ *Freeclimb::DefaultApi* | [**update_a_conference**](docs/DefaultApi.md#update_a_conference) | **POST** /Accounts/{accountId}/Conferences/{conferenceId} | Update a Conference
127
+ *Freeclimb::DefaultApi* | [**update_a_live_call**](docs/DefaultApi.md#update_a_live_call) | **POST** /Accounts/{accountId}/Calls/{callId} | Update a Live Call
128
+ *Freeclimb::DefaultApi* | [**update_a_participant**](docs/DefaultApi.md#update_a_participant) | **POST** /Accounts/{accountId}/Conferences/{conferenceId}/Participants/{callId} | Update a Participant
129
+ *Freeclimb::DefaultApi* | [**update_a_queue**](docs/DefaultApi.md#update_a_queue) | **POST** /Accounts/{accountId}/Queues/{queueId} | Update a Queue
130
+ *Freeclimb::DefaultApi* | [**update_an_account**](docs/DefaultApi.md#update_an_account) | **POST** /Accounts/{accountId} | Manage an account
131
+ *Freeclimb::DefaultApi* | [**update_an_application**](docs/DefaultApi.md#update_an_application) | **POST** /Accounts/{accountId}/Applications/{applicationId} | Update an application
132
+ *Freeclimb::DefaultApi* | [**update_an_incoming_number**](docs/DefaultApi.md#update_an_incoming_number) | **POST** /Accounts/{accountId}/IncomingPhoneNumbers/{phoneNumberId} | Update an Incoming Number
133
+
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
+
169
+ ## Documentation for Models
170
+
171
+ - [Freeclimb::AccountRequest](docs/AccountRequest.md)
172
+ - [Freeclimb::AccountResult](docs/AccountResult.md)
173
+ - [Freeclimb::AccountResultAllOf](docs/AccountResultAllOf.md)
174
+ - [Freeclimb::ApplicationList](docs/ApplicationList.md)
175
+ - [Freeclimb::ApplicationListAllOf](docs/ApplicationListAllOf.md)
176
+ - [Freeclimb::ApplicationRequest](docs/ApplicationRequest.md)
177
+ - [Freeclimb::ApplicationResult](docs/ApplicationResult.md)
178
+ - [Freeclimb::ApplicationResultAllOf](docs/ApplicationResultAllOf.md)
179
+ - [Freeclimb::AvailableNumber](docs/AvailableNumber.md)
180
+ - [Freeclimb::AvailableNumberList](docs/AvailableNumberList.md)
181
+ - [Freeclimb::AvailableNumberListAllOf](docs/AvailableNumberListAllOf.md)
182
+ - [Freeclimb::BuyIncomingNumberRequest](docs/BuyIncomingNumberRequest.md)
183
+ - [Freeclimb::CallList](docs/CallList.md)
184
+ - [Freeclimb::CallListAllOf](docs/CallListAllOf.md)
185
+ - [Freeclimb::CallResult](docs/CallResult.md)
186
+ - [Freeclimb::CallResultAllOf](docs/CallResultAllOf.md)
187
+ - [Freeclimb::ConferenceList](docs/ConferenceList.md)
188
+ - [Freeclimb::ConferenceListAllOf](docs/ConferenceListAllOf.md)
189
+ - [Freeclimb::ConferenceParticipantList](docs/ConferenceParticipantList.md)
190
+ - [Freeclimb::ConferenceParticipantListAllOf](docs/ConferenceParticipantListAllOf.md)
191
+ - [Freeclimb::ConferenceParticipantResult](docs/ConferenceParticipantResult.md)
192
+ - [Freeclimb::ConferenceParticipantResultAllOf](docs/ConferenceParticipantResultAllOf.md)
193
+ - [Freeclimb::ConferenceResult](docs/ConferenceResult.md)
194
+ - [Freeclimb::ConferenceResultAllOf](docs/ConferenceResultAllOf.md)
195
+ - [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)
196
+ - [Freeclimb::DequeueMemberRequest](docs/DequeueMemberRequest.md)
197
+ - [Freeclimb::FilterLogsRequest](docs/FilterLogsRequest.md)
198
+ - [Freeclimb::IncomingNumberList](docs/IncomingNumberList.md)
199
+ - [Freeclimb::IncomingNumberListAllOf](docs/IncomingNumberListAllOf.md)
200
+ - [Freeclimb::IncomingNumberRequest](docs/IncomingNumberRequest.md)
201
+ - [Freeclimb::IncomingNumberResult](docs/IncomingNumberResult.md)
202
+ - [Freeclimb::IncomingNumberResultAllOf](docs/IncomingNumberResultAllOf.md)
203
+ - [Freeclimb::LogList](docs/LogList.md)
204
+ - [Freeclimb::LogListAllOf](docs/LogListAllOf.md)
205
+ - [Freeclimb::LogResult](docs/LogResult.md)
206
+ - [Freeclimb::MakeCallRequest](docs/MakeCallRequest.md)
207
+ - [Freeclimb::MessageRequest](docs/MessageRequest.md)
208
+ - [Freeclimb::MessageRequestAllOf](docs/MessageRequestAllOf.md)
209
+ - [Freeclimb::MessageResult](docs/MessageResult.md)
210
+ - [Freeclimb::MessageResultAllOf](docs/MessageResultAllOf.md)
211
+ - [Freeclimb::MessagesList](docs/MessagesList.md)
212
+ - [Freeclimb::MessagesListAllOf](docs/MessagesListAllOf.md)
213
+ - [Freeclimb::MutableResourceModel](docs/MutableResourceModel.md)
214
+ - [Freeclimb::PaginationModel](docs/PaginationModel.md)
215
+ - [Freeclimb::QueueList](docs/QueueList.md)
216
+ - [Freeclimb::QueueListAllOf](docs/QueueListAllOf.md)
217
+ - [Freeclimb::QueueMember](docs/QueueMember.md)
218
+ - [Freeclimb::QueueMemberList](docs/QueueMemberList.md)
219
+ - [Freeclimb::QueueMemberListAllOf](docs/QueueMemberListAllOf.md)
220
+ - [Freeclimb::QueueRequest](docs/QueueRequest.md)
221
+ - [Freeclimb::QueueResult](docs/QueueResult.md)
222
+ - [Freeclimb::QueueResultAllOf](docs/QueueResultAllOf.md)
223
+ - [Freeclimb::RecordingList](docs/RecordingList.md)
224
+ - [Freeclimb::RecordingListAllOf](docs/RecordingListAllOf.md)
225
+ - [Freeclimb::RecordingResult](docs/RecordingResult.md)
226
+ - [Freeclimb::RecordingResultAllOf](docs/RecordingResultAllOf.md)
227
+ - [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
228
+ - [Freeclimb::UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
229
+ - [Freeclimb::UpdateConferenceRequest](docs/UpdateConferenceRequest.md)
230
+
231
+
232
+ ## Documentation for Authorization
233
+
234
+
235
+ ### fc
236
+
237
+ - **Type**: HTTP basic authentication
238
+
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+
3
+ begin
4
+ require 'rspec/core/rake_task'
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+ task default: :spec
8
+ rescue LoadError
9
+ # no rspec available
10
+ end
@@ -0,0 +1,21 @@
1
+ # Freeclimb::AccountRequest
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **_alias** | **String** | Description for this account. | [optional]
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: &lt;requestId&gt; | [optional]
10
+
11
+ ## Code Sample
12
+
13
+ ```ruby
14
+ require 'Freeclimb'
15
+
16
+ instance = Freeclimb::AccountRequest.new(_alias: null,
17
+ label: null,
18
+ request_id: null)
19
+ ```
20
+
21
+
@@ -0,0 +1,37 @@
1
+ # Freeclimb::AccountResult
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **uri** | **String** | The URI for this resource, relative to /apiserver. | [optional]
8
+ **date_created** | **String** | The date that this resource was created (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
9
+ **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional]
10
+ **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional]
11
+ **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
12
+ **auth_token** | **String** | The authorization token assigned to this account. This token must be kept a secret by the customer. | [optional]
13
+ **_alias** | **String** | A description for this account. | [optional]
14
+ **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
15
+ **type** | **String** | The type of this account. It is one of: trial or full. | [optional]
16
+ **status** | **String** | The status of this account. It is one of: active, suspended, or closed. | [optional]
17
+ **subresource_uris** | [**Object**](.md) | The list of subresources for this account. | [optional]
18
+
19
+ ## Code Sample
20
+
21
+ ```ruby
22
+ require 'Freeclimb'
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)
35
+ ```
36
+
37
+
@@ -0,0 +1,29 @@
1
+ # Freeclimb::AccountResultAllOf
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **account_id** | **String** | String that uniquely identifies this account resource. | [optional]
8
+ **auth_token** | **String** | The authorization token assigned to this account. This token must be kept a secret by the customer. | [optional]
9
+ **_alias** | **String** | A description for this account. | [optional]
10
+ **label** | **String** | A string that identifies a category or group to which the account belongs. | [optional]
11
+ **type** | **String** | The type of this account. It is one of: trial or full. | [optional]
12
+ **status** | **String** | The status of this account. It is one of: active, suspended, or closed. | [optional]
13
+ **subresource_uris** | [**Object**](.md) | The list of subresources for this account. | [optional]
14
+
15
+ ## Code Sample
16
+
17
+ ```ruby
18
+ require 'Freeclimb'
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)
27
+ ```
28
+
29
+
@@ -0,0 +1,31 @@
1
+ # Freeclimb::ApplicationList
2
+
3
+ ## Properties
4
+
5
+ Name | Type | Description | Notes
6
+ ------------ | ------------- | ------------- | -------------
7
+ **total** | **Integer** | Total amount of requested resource. | [optional]
8
+ **start** | **Integer** | Resource index at start of current page | [optional]
9
+ **_end** | **Integer** | Resource index at end of current page | [optional]
10
+ **page** | **Integer** | Current page | [optional]
11
+ **num_pages** | **Integer** | Total number of pages | [optional]
12
+ **page_size** | **Integer** | Number of items per page | [optional]
13
+ **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional]
14
+ **applications** | [**Array&lt;ApplicationResult&gt;**](ApplicationResult.md) | | [optional]
15
+
16
+ ## Code Sample
17
+
18
+ ```ruby
19
+ require 'Freeclimb'
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)
29
+ ```
30
+
31
+