freeclimb 4.9.0 → 5.0.0

data/docs/OutDialAllOf.md

@@ -1,36 +0,0 @@
-# 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** | **String** | 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** | **String** | E.164 representation of the phone number to Call.  |  |
-| **if_machine** | [**IfMachine**](IfMachine.md) |  | [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] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::OutDialAllOf.new(
-  action_url: null,
-  call_connect_url: null,
-  calling_number: null,
-  destination: null,
-  if_machine: null,
-  if_machine_url: null,
-  send_digits: null,
-  status_callback_url: null,
-  timeout: null,
-  privacy_mode: null
-)
-```
-

data/docs/ParkAllOf.md

@@ -1,22 +0,0 @@
-# Freeclimb::ParkAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **wait_url** | **String** | Specifies a URL pointing to a PerCL script containing actions to be executed while the caller is Parked. Once the script returned by the waitUrl runs out of commands to execute, FreeClimb will re-request the waitUrl and start over, essentially looping the script requests indefinitely. |  |
-| **action_url** | **String** | A request is made to this URL when the Call is resumed, which can occur if the Call is resumed via the Unpark command, the REST API (POST to Call resource), or the caller hangs up. The PerCL script returned in response to the actionUrl will be executed on the resumed call. |  |
-| **notification_url** | **String** | URL to be invoked when the Call is parked. The request to the URL contains the standard request parameters. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::ParkAllOf.new(
-  wait_url: null,
-  action_url: null,
-  notification_url: null
-)
-```
-

data/docs/PauseAllOf.md

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

data/docs/PlayAllOf.md

@@ -1,22 +0,0 @@
-# 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] |
-| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::PlayAllOf.new(
-  file: null,
-  loop: null,
-  privacy_mode: null
-)
-```
-

data/docs/PlayEarlyMediaAllOf.md

@@ -1,18 +0,0 @@
-# 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. |  |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::PlayEarlyMediaAllOf.new(
-  file: null
-)
-```
-

data/docs/QueueListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::QueueListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **queues** | [**Array<QueueResult>**](QueueResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::QueueListAllOf.new(
-  queues: null
-)
-```
-

data/docs/QueueMemberListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::QueueMemberListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **queue_members** | [**Array<QueueMember>**](QueueMember.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::QueueMemberListAllOf.new(
-  queue_members: null
-)
-```
-

data/docs/QueueResultAllOf.md

@@ -1,30 +0,0 @@
-# Freeclimb::QueueResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **account_id** | **String** | ID of the account that created this Queue. | [optional] |
-| **queue_id** | **String** | A string that uniquely identifies this Queue resource. | [optional] |
-| **_alias** | **String** | A description for this Queue. | [optional] |
-| **max_size** | **Integer** | The maximum number of Calls permitted in the Queue. Default is 100. Maximum is 1000. | [optional] |
-| **current_size** | **Integer** | Count of Calls currently in the Queue. | [optional] |
-| **average_queue_removal_time** | **Integer** | The average amount of time (in seconds) for a call to be removed from the queue. | [optional] |
-| **subresource_uris** | **Object** | List of subresources for this Queue (which includes Queue members). | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::QueueResultAllOf.new(
-  account_id: null,
-  queue_id: null,
-  _alias: null,
-  max_size: null,
-  current_size: null,
-  average_queue_removal_time: null,
-  subresource_uris: null
-)
-```
-

data/docs/RecordUtteranceAllOf.md

@@ -1,30 +0,0 @@
-# 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] |
-| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::RecordUtteranceAllOf.new(
-  action_url: null,
-  silence_timeout_ms: null,
-  finish_on_key: null,
-  max_length_sec: null,
-  play_beep: null,
-  auto_start: null,
-  privacy_mode: null
-)
-```
-

data/docs/RecordingListAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::RecordingListAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **recordings** | [**Array<RecordingResult>**](RecordingResult.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::RecordingListAllOf.new(
-  recordings: null
-)
-```
-

data/docs/RecordingResultAllOf.md

@@ -1,26 +0,0 @@
-# Freeclimb::RecordingResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **recording_id** | **String** | String that uniquely identifies this recording resource. | [optional] |
-| **account_id** | **String** | ID of the account that created this recording. | [optional] |
-| **call_id** | **String** | ID of the Call that was recorded. If a Conference was recorded, this value is empty and the conferenceId property is populated. | [optional] |
-| **duration_sec** | **Integer** | Length of the recording in seconds. | [optional] |
-| **conference_id** | **String** | ID of the Conference that was recorded. If a Call was recorded, this value is empty and the callId property is populated. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::RecordingResultAllOf.new(
-  recording_id: null,
-  account_id: null,
-  call_id: null,
-  duration_sec: null,
-  conference_id: null
-)
-```
-

data/docs/RedirectAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::RedirectAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_url** | **String** | URL to request a new PerCL script to continue with the current Call's processing. When `Redirect` invokes the `actionUrl`, an `inbound` Webhook is sent. This request therefore looks identical to the initial request (made to the `voiceUrl` of the number that was called) for an inbound Call. |  |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::RedirectAllOf.new(
-  action_url: null
-)
-```
-

data/docs/RejectAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::RejectAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **reason** | **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] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::RejectAllOf.new(
-  reason: null
-)
-```
-

data/docs/RemoveFromConferenceAllOf.md

@@ -1,18 +0,0 @@
-# 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. |  |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::RemoveFromConferenceAllOf.new(
-  call_id: null
-)
-```
-

data/docs/SMSTenDLCBrandsListResultAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::SMSTenDLCBrandsListResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **brands** | [**Array<SMSTenDLCBrand>**](SMSTenDLCBrand.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SMSTenDLCBrandsListResultAllOf.new(
-  brands: null
-)
-```
-

data/docs/SMSTenDLCCampaignsListResultAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::SMSTenDLCCampaignsListResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **campaigns** | [**Array<SMSTenDLCCampaign>**](SMSTenDLCCampaign.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SMSTenDLCCampaignsListResultAllOf.new(
-  campaigns: null
-)
-```
-

data/docs/SMSTenDLCPartnerCampaignsListResultAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::SMSTenDLCPartnerCampaignsListResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **partner_campaigns** | [**Array<SMSTenDLCPartnerCampaign>**](SMSTenDLCPartnerCampaign.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SMSTenDLCPartnerCampaignsListResultAllOf.new(
-  partner_campaigns: null
-)
-```
-

data/docs/SMSTollFreeCampaignsListResultAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::SMSTollFreeCampaignsListResultAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **brands** | [**Array<SMSTollFreeCampaign>**](SMSTollFreeCampaign.md) |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SMSTollFreeCampaignsListResultAllOf.new(
-  brands: null
-)
-```
-

data/docs/SayAllOf.md

@@ -1,24 +0,0 @@
-# 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][default to 1] |
-| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SayAllOf.new(
-  text: null,
-  language: null,
-  loop: null,
-  privacy_mode: null
-)
-```
-

data/docs/SendDigitsAllOf.md

@@ -1,22 +0,0 @@
-# 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] |
-| **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SendDigitsAllOf.new(
-  digits: null,
-  pause_ms: null,
-  privacy_mode: null
-)
-```
-

data/docs/SetDTMFPassThroughAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::SetDTMFPassThroughAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **dtmf_pass_through** | **Boolean** | Specifying `false` mutes the Participant's dtmf audio. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SetDTMFPassThroughAllOf.new(
-  dtmf_pass_through: null
-)
-```
-

data/docs/SetListenAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::SetListenAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **listen** | **Boolean** | Specifying `false` will silence the Conference for this Participant. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SetListenAllOf.new(
-  listen: null
-)
-```
-

data/docs/SetTalkAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::SetTalkAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **talk** | **Boolean** | Specifying `false` mutes the Participant. | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SetTalkAllOf.new(
-  talk: null
-)
-```
-

data/docs/SmsAllOf.md

@@ -1,24 +0,0 @@
-# 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] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::SmsAllOf.new(
-  to: null,
-  from: null,
-  text: null,
-  notification_url: null
-)
-```
-

data/docs/TerminateConferenceAllOf.md

@@ -1,18 +0,0 @@
-# Freeclimb::TerminateConferenceAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **conference_id** | **String** | ID of the conference to terminate. |  |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::TerminateConferenceAllOf.new(
-  conference_id: null
-)
-```
-

data/docs/TranscribeUtteranceAllOf.md

@@ -1,28 +0,0 @@
-# Freeclimb::TranscribeUtteranceAllOf
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **action_url** | **String** |  |  |
-| **play_beep** | **Boolean** |  | [optional][default to false] |
-| **record** | [**TranscribeUtteranceAllOfRecord**](TranscribeUtteranceAllOfRecord.md) |  | [optional] |
-| **privacy_for_logging** | **Boolean** |  | [optional][default to false] |
-| **privacy_for_recording** | **Boolean** |  | [optional][default to false] |
-| **prompts** | **Array<Object>** |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::TranscribeUtteranceAllOf.new(
-  action_url: null,
-  play_beep: null,
-  record: null,
-  privacy_for_logging: null,
-  privacy_for_recording: null,
-  prompts: null
-)
-```
-

data/docs/TranscribeUtteranceAllOfRecord.md

@@ -1,22 +0,0 @@
-# Freeclimb::TranscribeUtteranceAllOfRecord
-
-## Properties
-
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **save_recording** | **Boolean** |  | [optional][default to false] |
-| **max_length_sec** | **Integer** |  | [optional][default to 60] |
-| **rcrd_termination_silence_time_ms** | **Integer** |  | [optional] |
-
-## Example
-
-```ruby
-require 'freeclimb'
-
-instance = Freeclimb::TranscribeUtteranceAllOfRecord.new(
-  save_recording: null,
-  max_length_sec: null,
-  rcrd_termination_silence_time_ms: null
-)
-```
-