freeclimb 1.0.1 → 1.0.3

data/docs/CallResult.md

@@ -27,27 +27,27 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::CallResult.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 call_id: null,
-                                 parent_call_id: null,
-                                 account_id: null,
-                                 from: null,
-                                 to: null,
-                                 phone_number_id: null,
-                                 status: null,
-                                 start_time: null,
-                                 connect_time: null,
-                                 end_time: null,
-                                 duration: null,
-                                 connect_duration: null,
-                                 direction: null,
-                                 answered_by: null,
-                                 subresource_uris: null)
+instance = Freeclimb::CallResult.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 call_id: nil,
+                                 parent_call_id: nil,
+                                 account_id: nil,
+                                 from: nil,
+                                 to: nil,
+                                 phone_number_id: nil,
+                                 status: nil,
+                                 start_time: nil,
+                                 connect_time: nil,
+                                 end_time: nil,
+                                 duration: nil,
+                                 connect_duration: nil,
+                                 direction: nil,
+                                 answered_by: nil,
+                                 subresource_uris: nil)
 ```
 
 

data/docs/CallResultAllOf.md

@@ -23,23 +23,23 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::CallResultAllOf.new(call_id: null,
-                                 parent_call_id: null,
-                                 account_id: null,
-                                 from: null,
-                                 to: null,
-                                 phone_number_id: null,
-                                 status: null,
-                                 start_time: null,
-                                 connect_time: null,
-                                 end_time: null,
-                                 duration: null,
-                                 connect_duration: null,
-                                 direction: null,
-                                 answered_by: null,
-                                 subresource_uris: null)
+instance = Freeclimb::CallResultAllOf.new(call_id: nil,
+                                 parent_call_id: nil,
+                                 account_id: nil,
+                                 from: nil,
+                                 to: nil,
+                                 phone_number_id: nil,
+                                 status: nil,
+                                 start_time: nil,
+                                 connect_time: nil,
+                                 end_time: nil,
+                                 duration: nil,
+                                 connect_duration: nil,
+                                 direction: nil,
+                                 answered_by: nil,
+                                 subresource_uris: nil)
 ```
 
 

data/docs/ConferenceList.md

@@ -16,16 +16,16 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceList.new(total: null,
-                                 start: null,
-                                 _end: null,
-                                 page: null,
-                                 num_pages: null,
-                                 page_size: null,
-                                 next_page_uri: null,
-                                 conferences: null)
+instance = Freeclimb::ConferenceList.new(total: nil,
+                                 start: nil,
+                                 _end: nil,
+                                 page: nil,
+                                 num_pages: nil,
+                                 page_size: nil,
+                                 next_page_uri: nil,
+                                 conferences: nil)
 ```
 
 

data/docs/ConferenceListAllOf.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceListAllOf.new(conferences: null)
+instance = Freeclimb::ConferenceListAllOf.new(conferences: nil)
 ```
 
 

data/docs/ConferenceParticipantList.md

@@ -16,16 +16,16 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceParticipantList.new(total: null,
-                                 start: null,
-                                 _end: null,
-                                 page: null,
-                                 num_pages: null,
-                                 page_size: null,
-                                 next_page_uri: null,
-                                 participants: null)
+instance = Freeclimb::ConferenceParticipantList.new(total: nil,
+                                 start: nil,
+                                 _end: nil,
+                                 page: nil,
+                                 num_pages: nil,
+                                 page_size: nil,
+                                 next_page_uri: nil,
+                                 participants: nil)
 ```
 
 

data/docs/ConferenceParticipantListAllOf.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceParticipantListAllOf.new(participants: null)
+instance = Freeclimb::ConferenceParticipantListAllOf.new(participants: nil)
 ```
 
 

data/docs/ConferenceParticipantResult.md

@@ -18,18 +18,18 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceParticipantResult.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 account_id: null,
-                                 conference_id: null,
-                                 call_id: null,
-                                 talk: null,
-                                 listen: null,
-                                 start_conf_on_enter: null)
+instance = Freeclimb::ConferenceParticipantResult.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 account_id: nil,
+                                 conference_id: nil,
+                                 call_id: nil,
+                                 talk: nil,
+                                 listen: nil,
+                                 start_conf_on_enter: nil)
 ```
 
 

data/docs/ConferenceParticipantResultAllOf.md

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::ConferenceParticipantResultAllOf.new(account_id: null,
-                                 conference_id: null,
-                                 call_id: null,
-                                 talk: null,
-                                 listen: null,
-                                 start_conf_on_enter: null)
+instance = Freeclimb::ConferenceParticipantResultAllOf.new(account_id: nil,
+                                 conference_id: nil,
+                                 call_id: nil,
+                                 talk: nil,
+                                 listen: nil,
+                                 start_conf_on_enter: nil)
 ```
 
 

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

@@ -14,14 +14,14 @@ Name | Type | Description | Notes
 ## 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,
+                                 request_id: nil)
 ```
 
 

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/DequeueMemberRequest.md

@@ -9,9 +9,9 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::DequeueMemberRequest.new(request_id: null)
+instance = Freeclimb::DequeueMemberRequest.new(request_id: nil)
 ```
 
 

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

@@ -10,10 +10,10 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::FilterLogsRequest.new(pql: null,
-                                 request_id: null)
+instance = Freeclimb::FilterLogsRequest.new(pql: nil,
+                                 request_id: nil)
 ```
 
 

data/docs/GetDigits.md

@@ -0,0 +1,31 @@
+# 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] 
+
+## 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)
+```
+
+

data/docs/GetDigitsAllOf.md

@@ -0,0 +1,31 @@
+# Freeclimb::GetDigitsAllOf
+
+## 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] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::GetDigitsAllOf.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)
+```
+
+

data/docs/GetSpeech.md

@@ -0,0 +1,41 @@
+# Freeclimb::GetSpeech
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call. | 
+**grammar_type** | **Integer** | The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files. | [optional] 
+**grammar_file** | **String** | The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL. | 
+**grammar_rule** | **Boolean** | The grammar rule within the specified grammar file to use for speech recognition. This attribute is optional if `grammarType` is `URL` and ignored if `grammarType` is `BUILTIN`. | [optional] 
+**play_beep** | **String** | Indicates whether a beep should be played just before speech recognition is initiated so that the speaker can start to speak. | [optional] 
+**prompts** | [**Array<PerclCommand>**](PerclCommand.md) | The JSON array of PerCL commands to nest within the `GetSpeech` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the caller. This allows for playing menu options to the caller and to prompt for the expected input. These commands stop executing when the caller begins to input speech. | [optional] 
+**no_input_timeout_ms** | **Integer** | When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] 
+**recognition_timeout_ms** | **Integer** | When playback of prompts ends and there is no match for `recognitionTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] 
+**confidence_threshold** | **Float** | When a recognition resource recognizes a spoken phrase, it associates a confidence level with that match. Parameter `confidenceThreshold` specifies what confidence level is considered a successful match. Values are between 0.0 and 1.0. | [optional] 
+**sensitivity_level** | **Float** | The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0  | [optional] 
+**speech_complete_timeout_ms** | **Integer** | Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. | [optional] 
+**speech_incomplete_timeout_ms** | **Integer** | Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. | [optional] 
+**enforce_pci** | **Boolean** | Parameter enforcePCI will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::GetSpeech.new(action_url: nil,
+                                 grammar_type: nil,
+                                 grammar_file: nil,
+                                 grammar_rule: nil,
+                                 play_beep: nil,
+                                 prompts: nil,
+                                 no_input_timeout_ms: nil,
+                                 recognition_timeout_ms: nil,
+                                 confidence_threshold: nil,
+                                 sensitivity_level: nil,
+                                 speech_complete_timeout_ms: nil,
+                                 speech_incomplete_timeout_ms: nil,
+                                 enforce_pci: nil)
+```
+
+

data/docs/GetSpeechAllOf.md

@@ -0,0 +1,41 @@
+# Freeclimb::GetSpeechAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | When the caller has finished speaking or the command has timed out, FreeClimb will make a POST request to this URL. A PerCL response is expected to continue handling the call. | 
+**grammar_type** | **Integer** | The grammar file type to use for speech recognition. A value of 'URL' indicates the grammarFile attribute specifies a URL that points to the grammar file. A value of `BUILTIN` indicates the grammarFile attribute specifies the name of one of the platform built-in grammar files. | [optional] 
+**grammar_file** | **String** | The grammar file to use for speech recognition. If grammarType is set to URL, this attribute is specified as a download URL. | 
+**grammar_rule** | **Boolean** | The grammar rule within the specified grammar file to use for speech recognition. This attribute is optional if `grammarType` is `URL` and ignored if `grammarType` is `BUILTIN`. | [optional] 
+**play_beep** | **String** | Indicates whether a beep should be played just before speech recognition is initiated so that the speaker can start to speak. | [optional] 
+**prompts** | [**Array<PerclCommand>**](PerclCommand.md) | The JSON array of PerCL commands to nest within the `GetSpeech` command. The `Say`, `Play`, and `Pause` commands can be used. The nested actions are executed while FreeClimb is waiting for input from the caller. This allows for playing menu options to the caller and to prompt for the expected input. These commands stop executing when the caller begins to input speech. | [optional] 
+**no_input_timeout_ms** | **Integer** | When recognition is started and there is no speech detected for `noInputTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] 
+**recognition_timeout_ms** | **Integer** | When playback of prompts ends and there is no match for `recognitionTimeoutMs` milliseconds, the recognizer will terminate the recognition operation. | [optional] 
+**confidence_threshold** | **Float** | When a recognition resource recognizes a spoken phrase, it associates a confidence level with that match. Parameter `confidenceThreshold` specifies what confidence level is considered a successful match. Values are between 0.0 and 1.0. | [optional] 
+**sensitivity_level** | **Float** | The speech recognizer supports a variable level of sound sensitivity. The sensitivityLevel attribute allows for filtering out background noise, so it is not mistaken for speech. Values are between 0.0 and 1.0  | [optional] 
+**speech_complete_timeout_ms** | **Integer** | Parameter `speechCompleteTimeoutMs` specifies the length of silence required following user speech before the speech recognizer finalizes a result. This timeout applies when the recognizer currently has a complete match against an active grammar. Reasonable speech complete timeout values are typically in the range of 0.3 seconds to 1.0 seconds. | [optional] 
+**speech_incomplete_timeout_ms** | **Integer** | Parameter `speechIncompleteTimeoutMs` specifies the length of silence following user speech after which a recognizer finalizes a result. This timeout applies when the speech prior to the silence is an incomplete match of all active grammars. Timeout `speechIncompleteTimeoutMs` is usually longer than `speechCompleteTimeoutMs` to allow users to pause mid-utterance. | [optional] 
+**enforce_pci** | **Boolean** | Parameter enforcePCI will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::GetSpeechAllOf.new(action_url: nil,
+                                 grammar_type: nil,
+                                 grammar_file: nil,
+                                 grammar_rule: nil,
+                                 play_beep: nil,
+                                 prompts: nil,
+                                 no_input_timeout_ms: nil,
+                                 recognition_timeout_ms: nil,
+                                 confidence_threshold: nil,
+                                 sensitivity_level: nil,
+                                 speech_complete_timeout_ms: nil,
+                                 speech_incomplete_timeout_ms: nil,
+                                 enforce_pci: nil)
+```
+
+