freeclimb 1.0.0 → 2.0.2

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

@@ -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)
 ```
 
 

data/docs/MessageResultAllOf.md

@@ -16,16 +16,16 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::MessageResultAllOf.new(account_id: null,
-                                 message_id: null,
-                                 status: null,
-                                 from: null,
-                                 to: null,
-                                 text: null,
-                                 direction: null,
-                                 notification_url: null)
+instance = Freeclimb::MessageResultAllOf.new(account_id: nil,
+                                 message_id: nil,
+                                 status: nil,
+                                 from: nil,
+                                 to: nil,
+                                 text: nil,
+                                 direction: nil,
+                                 notification_url: nil)
 ```
 
 

data/docs/MessagesList.md

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

data/docs/MessagesListAllOf.md

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

data/docs/MutableResourceModel.md

@@ -12,12 +12,12 @@ Name | Type | Description | Notes
 ## Code Sample
 
 ```ruby
-require 'Freeclimb'
+require 'freeclimb'
 
-instance = Freeclimb::MutableResourceModel.new(uri: null,
-                                 date_created: null,
-                                 date_updated: null,
-                                 revision: null)
+instance = Freeclimb::MutableResourceModel.new(uri: nil,
+                                 date_created: nil,
+                                 date_updated: nil,
+                                 revision: nil)
 ```
 
 

data/docs/OutDial.md

@@ -0,0 +1,35 @@
+# Freeclimb::OutDial
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | URL to which FreeClimb sends an HTTP POST request.  | 
+**call_connect_url** | **String** | URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial. | 
+**calling_number** | **Float** | he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb. | 
+**destination** | **Float** | E.164 representation of the phone number to Call.  | 
+**if_machine** | **String** | Specifies how FreeClimb should handle this OutDial if an answering machine answers the Call. Valid values: `redirect` invokes the ifMachineUrl for instructions. `hangup` hangs up the Call. The ifMachineUrl will not be invoked. | [optional] 
+**if_machine_url** | **String** | When the `ifMachine` flag is set to `redirect`, this attribute specifies a URL to which FreeClimb makes 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`. Otherwise, it should not be included. | [optional] 
+**send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional] 
+**status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional] 
+**timeout** | **Integer** | Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`. | [optional] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::OutDial.new(action_url: nil,
+                                 call_connect_url: nil,
+                                 calling_number: nil,
+                                 destination: nil,
+                                 if_machine: nil,
+                                 if_machine_url: nil,
+                                 send_digits: nil,
+                                 status_callback_url: nil,
+                                 timeout: nil,
+                                 privacy_mode: nil)
+```
+
+

data/docs/OutDialAllOf.md

@@ -0,0 +1,35 @@
+# Freeclimb::OutDialAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**action_url** | **String** | URL to which FreeClimb sends an HTTP POST request.  | 
+**call_connect_url** | **String** | URL to which FreeClimb makes an HTTP POST request informing the result of the OutDial. | 
+**calling_number** | **Float** | he caller ID to show to the called party when FreeClimb calls. This can be one of the following: The To or From number provided in the first Webhook to your webserver. Any phone number you have purchased from FreeClimb. | 
+**destination** | **Float** | E.164 representation of the phone number to Call.  | 
+**if_machine** | **String** | Specifies how FreeClimb should handle this OutDial if an answering machine answers the Call. Valid values: `redirect` invokes the ifMachineUrl for instructions. `hangup` hangs up the Call. The ifMachineUrl will not be invoked. | [optional] 
+**if_machine_url** | **String** | When the `ifMachine` flag is set to `redirect`, this attribute specifies a URL to which FreeClimb makes 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`. Otherwise, it should not be included. | [optional] 
+**send_digits** | **String** | DTMF tones to play to the outdialed Call. This is typically used to dial a number and then dial an extension. | [optional] 
+**status_callback_url** | **String** | When the outdialed Call leg terminates, FreeClimb sends a `callStatus` Webhook to the `statusCallbackUrl`. This is a notification only; any PerCL command returned is ignored. | [optional] 
+**timeout** | **Integer** | Maximum time in seconds the `OutDial` command waits for the called party to answer the Call. When a timeout occurs, FreeClimb invokes the `callConnectUrl` Webhook to report that the out-dialed Call has ended with a status of `noAnswer`. | [optional] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::OutDialAllOf.new(action_url: nil,
+                                 call_connect_url: nil,
+                                 calling_number: nil,
+                                 destination: nil,
+                                 if_machine: nil,
+                                 if_machine_url: nil,
+                                 send_digits: nil,
+                                 status_callback_url: nil,
+                                 timeout: nil,
+                                 privacy_mode: nil)
+```
+
+

data/docs/PaginationModel.md

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

data/docs/Pause.md

@@ -0,0 +1,17 @@
+# Freeclimb::Pause
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**length** | **Integer** | Length in milliseconds. FreeClimb will wait silently before continuing on. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Pause.new(length: nil)
+```
+
+

data/docs/PauseAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::PauseAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**length** | **Integer** | Length in milliseconds. FreeClimb will wait silently before continuing on. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::PauseAllOf.new(length: nil)
+```
+
+

data/docs/PerclCommand.md

@@ -0,0 +1,17 @@
+# Freeclimb::PerclCommand
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**command** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::PerclCommand.new(command: nil)
+```
+
+

data/docs/PerclScript.md

@@ -0,0 +1,17 @@
+# Freeclimb::PerclScript
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**commands** | [**Array<PerclCommand>**](PerclCommand.md) | A JSON array of PerCL commands | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::PerclScript.new(commands: nil)
+```
+
+

data/docs/Play.md

@@ -0,0 +1,23 @@
+# Freeclimb::Play
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands.  | 
+**loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional] 
+**conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio 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] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Play.new(file: nil,
+                                 loop: nil,
+                                 conference_id: nil,
+                                 privacy_mode: nil)
+```
+
+

data/docs/PlayAllOf.md

@@ -0,0 +1,23 @@
+# Freeclimb::PlayAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands.  | 
+**loop** | **Integer** | Number of times the audio file is played. Specifying '0' causes the Play action to loop until the Call is hung up. | [optional] 
+**conference_id** | **String** | ID of the Conference the audio should be rendered to. If this is not specified, the audio 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] 
+**privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::PlayAllOf.new(file: nil,
+                                 loop: nil,
+                                 conference_id: nil,
+                                 privacy_mode: nil)
+```
+
+

data/docs/PlayEarlyMedia.md

@@ -0,0 +1,17 @@
+# Freeclimb::PlayEarlyMedia
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands or any accessible URL. FreeClimb will respect Cache-Control headers for this file. Use these to limit repeated requests for unchanged audio. If no Cache-Control header is provided, the file will be cached for seven days by default. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::PlayEarlyMedia.new(file: nil)
+```
+
+

data/docs/PlayEarlyMediaAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::PlayEarlyMediaAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file** | **String** | RL of the audio file to be played to the caller. The URL can be the `recordingUrl` generated from the `RecordUtterance` or `StartRecordCall` PerCL commands or any accessible URL. FreeClimb will respect Cache-Control headers for this file. Use these to limit repeated requests for unchanged audio. If no Cache-Control header is provided, the file will be cached for seven days by default. | 
+
+## Code Sample
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::PlayEarlyMediaAllOf.new(file: nil)
+```
+
+

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)
 ```