freeclimb 1.0.1 → 2.0.3

data/docs/GetDigitsAllOf.md

@@ -0,0 +1,33 @@
+# 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] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [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,
+                                 privacy_mode: 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] 
+**privacy_mode** | **Boolean** | Parameter privacyMode 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,
+                                 privacy_mode: 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] 
+**privacy_mode** | **Boolean** | Parameter privacyMode 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,
+                                 privacy_mode: nil)
+```
+
+

data/docs/IncomingNumberList.md

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

data/docs/IncomingNumberListAllOf.md

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

data/docs/IncomingNumberRequest.md

@@ -6,16 +6,14 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **application_id** | **String** | ID of the Application that should handle calls to this number. | [optional] 
 **_alias** | **String** | Description for this phone number. | [optional] 
-**request_id** | **String** | RequestId for this request starting with prefix `RQ` followed by 40 hexadecimal characters. FreeClimb logs that are 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::IncomingNumberRequest.new(application_id: null,
-                                 _alias: null,
-                                 request_id: null)
+instance = Freeclimb::IncomingNumberRequest.new(application_id: nil,
+                                 _alias: nil)
 ```
 
 

data/docs/IncomingNumberResult.md

@@ -21,21 +21,21 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::IncomingNumberResult.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 phone_number_id: null,
-                                 account_id: null,
-                                 application_id: null,
-                                 phone_number: null,
-                                 _alias: null,
-                                 region: null,
-                                 country: null,
-                                 voice_enabled: null,
-                                 sms_enabled: null)
+instance = Freeclimb::IncomingNumberResult.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 phone_number_id: nil,
+                                 account_id: nil,
+                                 application_id: nil,
+                                 phone_number: nil,
+                                 _alias: nil,
+                                 region: nil,
+                                 country: nil,
+                                 voice_enabled: nil,
+                                 sms_enabled: nil)
 ```
 
 

data/docs/IncomingNumberResultAllOf.md

@@ -17,17 +17,17 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::IncomingNumberResultAllOf.new(phone_number_id: null,
-                                 account_id: null,
-                                 application_id: null,
-                                 phone_number: null,
-                                 _alias: null,
-                                 region: null,
-                                 country: null,
-                                 voice_enabled: null,
-                                 sms_enabled: null)
+instance = Freeclimb::IncomingNumberResultAllOf.new(phone_number_id: nil,
+                                 account_id: nil,
+                                 application_id: nil,
+                                 phone_number: nil,
+                                 _alias: nil,
+                                 region: nil,
+                                 country: nil,
+                                 voice_enabled: nil,
+                                 sms_enabled: nil)
 ```
 
 

data/docs/LogList.md

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

data/docs/LogListAllOf.md

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

data/docs/LogResult.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::LogResult.new(timestamp: null,
-                                 level: null,
-                                 request_id: null,
-                                 account_id: null,
-                                 call_id: null,
-                                 message: null,
-                                 metadata: null)
+instance = Freeclimb::LogResult.new(timestamp: nil,
+                                 level: nil,
+                                 request_id: nil,
+                                 account_id: nil,
+                                 call_id: nil,
+                                 message: nil,
+                                 metadata: nil)
 ```
 
 

data/docs/MakeCallRequest.md

@@ -11,23 +11,23 @@ Name | Type | Description | Notes
 **if_machine** | **String** | Specifies how FreeClimb should handle this Call if an answering machine answers it. | [optional] 
 **if_machine_url** | **String** | This attribute specifies a URL to which FreeClimb will make a POST request when an answering machine or a fax machine is detected. This URL is required if the ifMachine flag is set to redirect. When ifMachine is set to hangup, ifMachineUrl must not be included in the request. For more information, see **ifMachineUrl example** below. | [optional] 
 **timeout** | **Integer** | Number of seconds that FreeClimb should allow the phone to ring before assuming there is no answer. Default is 30 seconds. Maximum allowed ring-time is determined by the target phone's provider. Note that most providers limit ring-time to 120 seconds. | [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] 
 **parent_call_id** | **String** | The ID of the parent Call in the case that this new Call is meant to be treated as a child of an existing Call. This attribute should be included when possible to reduce latency when adding child calls to Conferences containing the parent Call. A call can only be used as a parent once the call is in progress or as an inbound call that is still ringing.  An outbound call is considered to be in progress once the outdialConnect or outdialApiConnect webhook is invoked.  An inbound call is ringing when the inbound webhook is invoked. | [optional] 
+**privacy_mode** | **Boolean** | Activate privacy mode in order to obscure log data that can potentially expose private information. | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::MakeCallRequest.new(from: null,
-                                 to: null,
-                                 application_id: null,
-                                 send_digits: null,
-                                 if_machine: null,
-                                 if_machine_url: null,
-                                 timeout: null,
-                                 request_id: null,
-                                 parent_call_id: null)
+instance = Freeclimb::MakeCallRequest.new(from: nil,
+                                 to: nil,
+                                 application_id: nil,
+                                 send_digits: nil,
+                                 if_machine: nil,
+                                 if_machine_url: nil,
+                                 timeout: nil,
+                                 parent_call_id: nil,
+                                 privacy_mode: nil)
 ```
 
 

data/docs/MessageRequest.md

@@ -12,24 +12,22 @@ Name | Type | Description | Notes
 **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. | 
 **text** | **String** | Text contained in the message (maximum 160 characters).   **Note:** For text, only ASCII characters are supported. | 
 **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters.  **Note:** This is a notification only; any PerCL returned is ignored. | [optional] 
-**request_id** | **String** | RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request 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] 
 **account_id** | **String** | String that uniquely identifies this account resource. | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::MessageRequest.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 from: null,
-                                 to: null,
-                                 text: null,
-                                 notification_url: null,
-                                 request_id: null,
-                                 account_id: null)
+instance = Freeclimb::MessageRequest.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 from: nil,
+                                 to: nil,
+                                 text: nil,
+                                 notification_url: nil,
+                                 account_id: nil)
 ```
 
 

data/docs/MessageRequestAllOf.md

@@ -8,20 +8,18 @@ Name | Type | Description | Notes
 **to** | **String** | Phone number to receive the message. Must be within FreeClimb's service area. | 
 **text** | **String** | Text contained in the message (maximum 160 characters).   **Note:** For text, only ASCII characters are supported. | 
 **notification_url** | **String** | When the Message changes status, this URL is invoked using HTTP POST with the messageStatus parameters.  **Note:** This is a notification only; any PerCL returned is ignored. | [optional] 
-**request_id** | **String** | RequestId for this request, starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request 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] 
 **account_id** | **String** | String that uniquely identifies this account resource. | [optional] 
 
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::MessageRequestAllOf.new(from: null,
-                                 to: null,
-                                 text: null,
-                                 notification_url: null,
-                                 request_id: null,
-                                 account_id: null)
+instance = Freeclimb::MessageRequestAllOf.new(from: nil,
+                                 to: nil,
+                                 text: nil,
+                                 notification_url: nil,
+                                 account_id: nil)
 ```
 
 

data/docs/MessageResult.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] 
 **account_id** | **String** | String that uniquely identifies this account resource. | [optional] 
 **message_id** | **String** | String that uniquely identifies this message resource | [optional] 
-**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received | [optional] 
+**status** | **String** | Indicates the state of the message through the message lifecycle including: new, queued, rejected, sending, sent, failed, received, undelivered, expired, deleted, and unknown | [optional] 
 **from** | **String** | Phone number in E.164 format that sent the message. | [optional] 
 **to** | **String** | Phone number in E.164 format that received the message. | [optional] 
 **text** | **String** | Message contents | [optional] 
@@ -20,20 +20,20 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::MessageResult.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 account_id: null,
-                                 message_id: null,
-                                 status: null,
-                                 from: null,
-                                 to: null,
-                                 text: null,
-                                 direction: null,
-                                 notification_url: null)
+instance = Freeclimb::MessageResult.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 account_id: nil,
+                                 message_id: nil,
+                                 status: nil,
+                                 from: nil,
+                                 to: nil,
+                                 text: nil,
+                                 direction: nil,
+                                 notification_url: nil)
 ```