freeclimb 1.0.1 → 2.0.3

data/docs/ConferenceResult.md

@@ -22,22 +22,22 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceResult.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 conference_id: null,
-                                 account_id: null,
-                                 _alias: null,
-                                 play_beep: null,
-                                 record: null,
-                                 status: null,
-                                 wait_url: null,
-                                 action_url: null,
-                                 status_callback_url: null,
-                                 subresource_uris: null)
+instance = Freeclimb::ConferenceResult.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 conference_id: nil,
+                                 account_id: nil,
+                                 _alias: nil,
+                                 play_beep: nil,
+                                 record: nil,
+                                 status: nil,
+                                 wait_url: nil,
+                                 action_url: nil,
+                                 status_callback_url: nil,
+                                 subresource_uris: nil)
 ```
 
 

data/docs/ConferenceResultAllOf.md

@@ -18,18 +18,18 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceResultAllOf.new(conference_id: null,
-                                 account_id: null,
-                                 _alias: null,
-                                 play_beep: null,
-                                 record: null,
-                                 status: null,
-                                 wait_url: null,
-                                 action_url: null,
-                                 status_callback_url: null,
-                                 subresource_uris: null)
+instance = Freeclimb::ConferenceResultAllOf.new(conference_id: nil,
+                                 account_id: nil,
+                                 _alias: nil,
+                                 play_beep: nil,
+                                 record: nil,
+                                 status: nil,
+                                 wait_url: nil,
+                                 action_url: nil,
+                                 status_callback_url: nil,
+                                 subresource_uris: nil)
 ```
 
 

data/docs/CreateConference.md

@@ -0,0 +1,27 @@
+# Freeclimb::CreateConference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** |  This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response.  | 
+**_alias** | **Boolean** | Descriptive name for the Conference.  | [optional] 
+**play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always`  | [optional] 
+**record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] 
+**status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] 
+**wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::CreateConference.new(action_url: nil,
+                                 _alias: nil,
+                                 play_beep: nil,
+                                 record: nil,
+                                 status_callback_url: nil,
+                                 wait_url: nil)
+```
+
+

data/docs/CreateConferenceAllOf.md

@@ -0,0 +1,27 @@
+# Freeclimb::CreateConferenceAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** |  This URL is invoked once the Conference is successfully created. Actions on the Conference, such as adding Participants, can be performed via the PerCL script returned in the response.  | 
+**_alias** | **Boolean** | Descriptive name for the Conference.  | [optional] 
+**play_beep** | **String** | Indicates whether to play a beep when a Participant enters or leaves the Conference. either `always`, `never`, `entryOnly`, or `exitOnly`. Leaving this unset will make conference default to `always`  | [optional] 
+**record** | **Boolean** | When set to `true`, the entire Conference is recorded. The `statusCallbackUrl` of the Conference will receive a `conferenceRecordingEnded` Webhook when the Conference transitions from the `inProgress` to empty state. | [optional] 
+**status_callback_url** | **Boolean** | This URL is invoked when the status of the Conference changes or when a recording of the Conference has become available. | [optional] 
+**wait_url** | **String** | If specified, this URL provides the custom hold music for the Conference when it is in the populated state. This attribute is always fetched using HTTP GET and is fetched just once – when the Conference is created. The URL must be an audio file that is reachable and readable by FreeClimb. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::CreateConferenceAllOf.new(action_url: nil,
+                                 _alias: nil,
+                                 play_beep: nil,
+                                 record: nil,
+                                 status_callback_url: nil,
+                                 wait_url: nil)
+```
+
+

data/docs/CreateConferenceRequest.md

@@ -9,19 +9,17 @@ Name | Type | Description | Notes
 **record** | **Boolean** | Setting to `true` records the entire Conference. | [optional] 
 **wait_url** | **String** | If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created. | [optional] 
 **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below). | [optional] 
-**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] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::CreateConferenceRequest.new(_alias: null,
-                                 play_beep: null,
-                                 record: null,
-                                 wait_url: null,
-                                 status_callback_url: null,
-                                 request_id: null)
+instance = Freeclimb::CreateConferenceRequest.new(_alias: nil,
+                                 play_beep: nil,
+                                 record: nil,
+                                 wait_url: nil,
+                                 status_callback_url: nil)
 ```
 
 

data/docs/DefaultApi.md

@@ -102,7 +102,7 @@ This endpoint does not need any parameter.
 
 ## buy_a_phone_number
 
-> IncomingNumberResult buy_a_phone_number(opts)
+> IncomingNumberResult buy_a_phone_number(buy_incoming_number_request)
 
 Buy a Phone Number
 
@@ -119,13 +119,11 @@ Freeclimb.configure do |config|
 end
 
 api_instance = Freeclimb::DefaultApi.new
-opts = {
-  buy_incoming_number_request: Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
-}
+buy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
 
 begin
   #Buy a Phone Number
-  result = api_instance.buy_a_phone_number(opts)
+  result = api_instance.buy_a_phone_number(buy_incoming_number_request)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
@@ -137,7 +135,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details | [optional] 
+ **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details | 
 
 ### Return type
 
@@ -464,7 +462,7 @@ nil (empty response body)
 
 ## dequeue_a_member
 
-> QueueMember dequeue_a_member(queue_id, call_id, opts)
+> QueueMember dequeue_a_member(queue_id, call_id)
 
 Dequeue a Member
 
@@ -483,13 +481,10 @@ end
 api_instance = Freeclimb::DefaultApi.new
 queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
 call_id = 'call_id_example' # String | ID if the Call that the Member belongs to
-opts = {
-  dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue member request details
-}
 
 begin
   #Dequeue a Member
-  result = api_instance.dequeue_a_member(queue_id, call_id, opts)
+  result = api_instance.dequeue_a_member(queue_id, call_id)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->dequeue_a_member: #{e}"
@@ -503,7 +498,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. | 
  **call_id** | **String**| ID if the Call that the Member belongs to | 
- **dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue member request details | [optional] 
 
 ### Return type
 
@@ -515,13 +509,13 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
 ## dequeue_head_member
 
-> QueueMember dequeue_head_member(queue_id, opts)
+> QueueMember dequeue_head_member(queue_id)
 
 Dequeue Head Member
 
@@ -539,13 +533,10 @@ end
 
 api_instance = Freeclimb::DefaultApi.new
 queue_id = 'queue_id_example' # String | String that uniquely identifies this queue resource.
-opts = {
-  dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue head member request details
-}
 
 begin
   #Dequeue Head Member
-  result = api_instance.dequeue_head_member(queue_id, opts)
+  result = api_instance.dequeue_head_member(queue_id)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->dequeue_head_member: #{e}"
@@ -558,7 +549,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **queue_id** | **String**| String that uniquely identifies this queue resource. | 
- **dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue head member request details | [optional] 
 
 ### Return type
 
@@ -570,7 +560,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
@@ -627,7 +617,7 @@ Name | Type | Description  | Notes
 
 ## filter_logs
 
-> LogList filter_logs(opts)
+> LogList filter_logs(filter_logs_request)
 
 Filter Logs
 
@@ -644,13 +634,11 @@ Freeclimb.configure do |config|
 end
 
 api_instance = Freeclimb::DefaultApi.new
-opts = {
-  filter_logs_request: Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
-}
+filter_logs_request = Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
 
 begin
   #Filter Logs
-  result = api_instance.filter_logs(opts)
+  result = api_instance.filter_logs(filter_logs_request)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->filter_logs: #{e}"
@@ -662,7 +650,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters | [optional] 
+ **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters | 
 
 ### Return type
 
@@ -2018,7 +2006,7 @@ nil (empty response body)
 
 ## send_an_sms_message
 
-> MessageResult send_an_sms_message(opts)
+> MessageResult send_an_sms_message(message_request)
 
 Send an SMS Message
 
@@ -2035,13 +2023,11 @@ Freeclimb.configure do |config|
 end
 
 api_instance = Freeclimb::DefaultApi.new
-opts = {
-  message_request: Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
-}
+message_request = Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
 
 begin
   #Send an SMS Message
-  result = api_instance.send_an_sms_message(opts)
+  result = api_instance.send_an_sms_message(message_request)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->send_an_sms_message: #{e}"
@@ -2053,7 +2039,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message | [optional] 
+ **message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message | 
 
 ### Return type
 
@@ -2177,7 +2163,7 @@ Name | Type | Description  | Notes
 
 ## update_a_live_call
 
-> update_a_live_call(call_id, opts)
+> update_a_live_call(call_id, update_call_request)
 
 Update a Live Call
 
@@ -2195,13 +2181,11 @@ end
 
 api_instance = Freeclimb::DefaultApi.new
 call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
-opts = {
-  update_call_request: Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
-}
+update_call_request = Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
 
 begin
   #Update a Live Call
-  api_instance.update_a_live_call(call_id, opts)
+  api_instance.update_a_live_call(call_id, update_call_request)
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->update_a_live_call: #{e}"
 end
@@ -2213,7 +2197,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **call_id** | **String**| String that uniquely identifies this call resource. | 
- **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update | [optional] 
+ **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update | 
 
 ### Return type
 

data/docs/Dequeue.md

@@ -0,0 +1,16 @@
+# Freeclimb::Dequeue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Dequeue.new()
+```
+
+

data/docs/Enqueue.md

@@ -0,0 +1,23 @@
+# Freeclimb::Enqueue
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up. | 
+**notification_url** | **String** | URL to be invoked when the call enters the queue. The request to the URL contains the standard request parameters.This is a notification only; any PerCL returned will be ignored. | [optional] 
+**queue_id** | **String** | ID of the Queue to which to add the Call. If the Queue does not exist, it will be created. The ID must start with QU followed by 40 hex characters. | 
+**wait_url** | **String** | A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Enqueue.new(action_url: nil,
+                                 notification_url: nil,
+                                 queue_id: nil,
+                                 wait_url: nil)
+```
+
+

data/docs/EnqueueAllOf.md

@@ -0,0 +1,23 @@
+# Freeclimb::EnqueueAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up. | 
+**notification_url** | **String** | URL to be invoked when the call enters the queue. The request to the URL contains the standard request parameters.This is a notification only; any PerCL returned will be ignored. | [optional] 
+**queue_id** | **String** | ID of the Queue to which to add the Call. If the Queue does not exist, it will be created. The ID must start with QU followed by 40 hex characters. | 
+**wait_url** | **String** | A request is made to this URL when the Call leaves the Queue, which can occur if enqueue of the Call fails or when the call is dequeued via the `Dequeue` command, the REST API (POST to Queue Member resource), or the caller hangs up. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::EnqueueAllOf.new(action_url: nil,
+                                 notification_url: nil,
+                                 queue_id: nil,
+                                 wait_url: nil)
+```
+
+

data/docs/FilterLogsRequest.md

@@ -5,15 +5,13 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **pql** | **String** | The filter query for retrieving logs. See **Performance Query Language** below. | 
-**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] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::FilterLogsRequest.new(pql: null,
-                                 request_id: null)
+instance = Freeclimb::FilterLogsRequest.new(pql: nil)
 ```
 
 

data/docs/GetDigits.md

@@ -0,0 +1,33 @@
+# Freeclimb::GetDigits
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | When the Caller has finished entering digits, FreeClimb will make an HTTP POST request to this URL. A PerCL response is expected to continue handling the Call. Make sure to keep “http://“ in the URL. | 
+**digit_timeout_ms** | **Integer** |  Maximum time in milliseconds that FreeClimb will wait for the Caller to press any digit after the last digit entered, before making a determination that a `timeout` has occurred and moving on to make the request to the actionUrl to submit the results of the `GetDigits` command. This timeout interval begins and resets after each digit entered. | [optional] 
+**finish_on_key** | **String** | Digit that causes the input sequence to be deemed complete. This attribute defers to the `timeout` attribute – so, if a `timeout` occurs, then the command terminates regardless of the value of `finishOnKey`. | [optional] 
+**flush_buffer** | **Boolean** | If set to true, the FreeClimb platform starts with an empty DTMF buffer to store the digits entered by the caller. If set to false, FreeClimb will append the user inputs to the end of the existing digits buffer and will return digits from the start of the digits buffer. | [optional] 
+**initial_timeout_ms** | **String** | Maximum time in milliseconds that FreeClimb will wait for the Caller to press the first digit before making a determination that a `timeout` has occurred and moving on to make the request to the `actionUrl` to submit the results of the `GetDigits` command. This timeout interval begins when all nested commands have been fully executed. | [optional] 
+**max_digits** | **Integer** | Maximum number of digits expected in the input. If the terminating digit is not entered and the caller has entered the maximum number of digits allowed, the `GetDigits` command terminates regardless of the value of `finishOnKey`. | [optional] 
+**min_digits** | **Integer** | Minimum number of digits expected in the input. If specified, FreeClimb will return the collected digits only if the Caller has entered at least that many digits. | [optional] 
+**prompts** | [**Array<PerclCommand>**](PerclCommand.md) | JSON array of PerCL commands to nest within the `GetDigits` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the Caller. | [optional] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::GetDigits.new(action_url: nil,
+                                 digit_timeout_ms: nil,
+                                 finish_on_key: nil,
+                                 flush_buffer: nil,
+                                 initial_timeout_ms: nil,
+                                 max_digits: nil,
+                                 min_digits: nil,
+                                 prompts: nil,
+                                 privacy_mode: nil)
+```
+
+