freeclimb 1.0.1 → 1.0.3

data/docs/QueueList.md

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

data/docs/QueueListAllOf.md

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

data/docs/QueueMember.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::QueueMember.new(uri: null,
-                                 call_id: null,
-                                 wait_time: null,
-                                 position: null,
-                                 date_enqueued: null)
+instance = Freeclimb::QueueMember.new(uri: nil,
+                                 call_id: nil,
+                                 wait_time: nil,
+                                 position: nil,
+                                 date_enqueued: nil)
 ```
 
 

data/docs/QueueMemberList.md

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

data/docs/QueueMemberListAllOf.md

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

data/docs/QueueRequest.md

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

data/docs/QueueResult.md

@@ -19,19 +19,19 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::QueueResult.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 account_id: null,
-                                 queue_id: null,
-                                 _alias: null,
-                                 max_size: null,
-                                 current_size: null,
-                                 average_wait_time: null,
-                                 subresource_uris: null)
+instance = Freeclimb::QueueResult.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 account_id: nil,
+                                 queue_id: nil,
+                                 _alias: nil,
+                                 max_size: nil,
+                                 current_size: nil,
+                                 average_wait_time: nil,
+                                 subresource_uris: nil)
 ```
 
 

data/docs/QueueResultAllOf.md

@@ -15,15 +15,15 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::QueueResultAllOf.new(account_id: null,
-                                 queue_id: null,
-                                 _alias: null,
-                                 max_size: null,
-                                 current_size: null,
-                                 average_wait_time: null,
-                                 subresource_uris: null)
+instance = Freeclimb::QueueResultAllOf.new(account_id: nil,
+                                 queue_id: nil,
+                                 _alias: nil,
+                                 max_size: nil,
+                                 current_size: nil,
+                                 average_wait_time: nil,
+                                 subresource_uris: nil)
 ```
 
 

data/docs/RecordUtterance.md

@@ -0,0 +1,27 @@
+# Freeclimb::RecordUtterance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing. | 
+**silence_timeout_ms** | **Integer** | Interval of silence that should elapse before ending the recording. | [optional] 
+**finish_on_key** | **String** | Key that triggers the end of the recording. any digit, '#', or '*' | [optional] 
+**max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional] 
+**play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional] 
+**auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RecordUtterance.new(action_url: nil,
+                                 silence_timeout_ms: nil,
+                                 finish_on_key: nil,
+                                 max_length_sec: nil,
+                                 play_beep: nil,
+                                 auto_start: nil)
+```
+
+

data/docs/RecordUtteranceAllOf.md

@@ -0,0 +1,27 @@
+# Freeclimb::RecordUtteranceAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | URL to which information on the completed recording is submitted. The PerCL received in response is then used to continue with Call processing. | 
+**silence_timeout_ms** | **Integer** | Interval of silence that should elapse before ending the recording. | [optional] 
+**finish_on_key** | **String** | Key that triggers the end of the recording. any digit, '#', or '*' | [optional] 
+**max_length_sec** | **Integer** | Maximum length for the command execution in seconds. | [optional] 
+**play_beep** | **Boolean** | Indicates whether to play a beep sound before the start of the recording. If set to `false`, no beep is played. | [optional] 
+**auto_start** | **Boolean** | If `false`, recording begins immediately after the RecordUtterance command is processed. If `true`, recording begins when audio is present and if audio begins before the `maxLengthSec` timeout. If no audio begins before `maxLengthSec`, no recording is generated. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RecordUtteranceAllOf.new(action_url: nil,
+                                 silence_timeout_ms: nil,
+                                 finish_on_key: nil,
+                                 max_length_sec: nil,
+                                 play_beep: nil,
+                                 auto_start: nil)
+```
+
+

data/docs/RecordingList.md

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

data/docs/RecordingListAllOf.md

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

data/docs/RecordingResult.md

@@ -17,17 +17,17 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::RecordingResult.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null,
-                                 recording_id: null,
-                                 account_id: null,
-                                 call_id: null,
-                                 duration_sec: null,
-                                 conference_id: null)
+instance = Freeclimb::RecordingResult.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil,
+                                 recording_id: nil,
+                                 account_id: nil,
+                                 call_id: nil,
+                                 duration_sec: nil,
+                                 conference_id: nil)
 ```
 
 

data/docs/RecordingResultAllOf.md

@@ -13,13 +13,13 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::RecordingResultAllOf.new(recording_id: null,
-                                 account_id: null,
-                                 call_id: null,
-                                 duration_sec: null,
-                                 conference_id: null)
+instance = Freeclimb::RecordingResultAllOf.new(recording_id: nil,
+                                 account_id: nil,
+                                 call_id: nil,
+                                 duration_sec: nil,
+                                 conference_id: nil)
 ```
 
 

data/docs/Redirect.md

@@ -0,0 +1,17 @@
+# Freeclimb::Redirect
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Redirect.new(action_url: nil)
+```
+
+

data/docs/RedirectAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::RedirectAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | Reason for the rejection. This can be any string value. In general, applications should use a set of enumerated values that are predefined to cover all exit points of the call flows for the given application. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RedirectAllOf.new(action_url: nil)
+```
+
+

data/docs/RemoveFromConference.md

@@ -0,0 +1,17 @@
+# Freeclimb::RemoveFromConference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RemoveFromConference.new(call_id: nil)
+```
+
+

data/docs/RemoveFromConferenceAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::RemoveFromConferenceAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | ID of the Call leg to be removed from the Conference. The Call must be in a Conference or an error will be triggered. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::RemoveFromConferenceAllOf.new(call_id: nil)
+```
+
+

data/docs/Say.md

@@ -0,0 +1,25 @@
+# Freeclimb::Say
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. | 
+**language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional] 
+**loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional] 
+**conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional] 
+**enforce_pci** | **Boolean** | Parameter `enforcePCI` will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Say.new(text: nil,
+                                 language: nil,
+                                 loop: nil,
+                                 conference_id: nil,
+                                 enforce_pci: nil)
+```
+
+

data/docs/SayAllOf.md

@@ -0,0 +1,25 @@
+# Freeclimb::SayAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **String** | The message to be played to the caller using TTS. The size of the string is limited to 4 KB (or 4,096 bytes). An empty string will cause the command to be skipped. | 
+**language** | **String** | Language and (by implication) the locale to use. This implies the accent and pronunciations to be usde for the TTS. The complete list of valid values for the language attribute is shown below. | [optional] 
+**loop** | **Integer** | Number of times the text is said. Specifying '0' causes the `Say` action to loop until the Call is hung up. | [optional] 
+**conference_id** | **String** | D of the Conference the speech should be rendered to. If this is not specified, the speech is by default rendered to the Caller associated with the call leg that corresponds to the current PerCL execution context. The call leg associated with this command must be in the specified Conference or the command will return an error. | [optional] 
+**enforce_pci** | **Boolean** | Parameter `enforcePCI` will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SayAllOf.new(text: nil,
+                                 language: nil,
+                                 loop: nil,
+                                 conference_id: nil,
+                                 enforce_pci: nil)
+```
+
+

data/docs/SendDigits.md

@@ -0,0 +1,19 @@
+# Freeclimb::SendDigits
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. | 
+**pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SendDigits.new(digits: nil,
+                                 pause_ms: nil)
+```
+
+

data/docs/SendDigitsAllOf.md

@@ -0,0 +1,19 @@
+# Freeclimb::SendDigitsAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**digits** | **String** | String containing the digits to be played. The string cannot be empty and can include any digit, plus `#`, or `*`, and allows embedding specification for delay or pause between the output of individual digits. | 
+**pause_ms** | **Integer** | Pause between digits in milliseconds. Valid values are 100-1000 milliseconds and will be adjusted by FreeClimb to satisfy the constraint. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SendDigitsAllOf.new(digits: nil,
+                                 pause_ms: nil)
+```
+
+

data/docs/SetListen.md

@@ -0,0 +1,19 @@
+# Freeclimb::SetListen
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | ID of the call leg that is to be assigned the listen privilege. The Call must be in a Conference or an error will be triggered. | 
+**listen** | **Boolean** | Specifying `false` will silence the Conference for this Participant. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SetListen.new(call_id: nil,
+                                 listen: nil)
+```
+
+

data/docs/SetListenAllOf.md

@@ -0,0 +1,19 @@
+# Freeclimb::SetListenAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | ID of the call leg that is to be assigned the listen privilege. The Call must be in a Conference or an error will be triggered. | 
+**listen** | **Boolean** | Specifying `false` will silence the Conference for this Participant. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SetListenAllOf.new(call_id: nil,
+                                 listen: nil)
+```
+
+

data/docs/SetTalk.md

@@ -0,0 +1,19 @@
+# Freeclimb::SetTalk
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered. | 
+**talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SetTalk.new(call_id: nil,
+                                 talk: nil)
+```
+
+

data/docs/SetTalkAllOf.md

@@ -0,0 +1,19 @@
+# Freeclimb::SetTalkAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**call_id** | **String** | ID of the call leg that is to be muted or unmuted. The Call must be in a Conference or an error will be triggered. | 
+**talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SetTalkAllOf.new(call_id: nil,
+                                 talk: nil)
+```
+
+

data/docs/Sms.md

@@ -0,0 +1,23 @@
+# Freeclimb::Sms
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). | 
+**from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. | 
+**text** | **String** | Text contained in the message (maximum 160 characters). | 
+**notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Sms.new(to: nil,
+                                 from: nil,
+                                 text: nil,
+                                 notification_url: nil)
+```
+
+

data/docs/SmsAllOf.md

@@ -0,0 +1,23 @@
+# Freeclimb::SmsAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**to** | **String** | E.164 representation of the phone number to which the message will be sent. Must be within FreeClimb's service area and E.164 formatting (e.g., +18003608245). | 
+**from** | **String** | E.164 representation of the phone number to use as the sender. This must be an incoming phone number you have purchased from FreeClimb. | 
+**text** | **String** | Text contained in the message (maximum 160 characters). | 
+**notification_url** | **String** | When the message changes status, this URL will be invoked using HTTP POST with the messageStatus parameters. This is a notification only; any PerCL returned will be ignored. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SmsAllOf.new(to: nil,
+                                 from: nil,
+                                 text: nil,
+                                 notification_url: nil)
+```
+
+

data/docs/StartRecordCall.md

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

data/docs/TerminateConference.md

@@ -0,0 +1,17 @@
+# Freeclimb::TerminateConference
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**conference_id** | **String** | ID of the conference to terminate. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TerminateConference.new(conference_id: nil)
+```
+
+