freeclimb 4.5.2 → 4.6.1

data/docs/MessageRequest.md

@@ -12,7 +12,7 @@
 | **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] |
-| **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
+| **media_urls** | **Array<String>** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional] |
 
 ## Example
 
@@ -28,7 +28,7 @@ instance = Freeclimb::MessageRequest.new(
   to: null,
   text: null,
   notification_url: null,
-  account_id: null
+  media_urls: null
 )
 ```
 

data/docs/MessageRequestAllOf.md

@@ -8,7 +8,7 @@
 | **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] |
-| **account_id** | **String** | String that uniquely identifies this account resource. | [optional] |
+| **media_urls** | **Array<String>** | an array of HTTP URLs which are to be used as attachments to the message. This will force the message into being an MMS message and must be done using a from number which is MMS capabile. | [optional] |
 
 ## Example
 
@@ -20,7 +20,7 @@ instance = Freeclimb::MessageRequestAllOf.new(
   to: null,
   text: null,
   notification_url: null,
-  account_id: null
+  media_urls: null
 )
 ```
 

data/docs/MessageResult.md

@@ -19,6 +19,7 @@
 | **brand_id** | **String** | The unique identifier for the brand associated with the message | [optional] |
 | **campaign_id** | **String** | The unique identifier for the campaign associated with the message | [optional] |
 | **segment_count** | **Float** | The number of segments into which the message was split | [optional] |
+| **media_urls** | **Array<String>** | an array of HTTP URLs which were attached this this message | [optional] |
 
 ## Example
 
@@ -40,7 +41,8 @@ instance = Freeclimb::MessageResult.new(
   notification_url: null,
   brand_id: null,
   campaign_id: null,
-  segment_count: null
+  segment_count: null,
+  media_urls: null
 )
 ```
 

data/docs/MessageResultAllOf.md

@@ -15,6 +15,7 @@
 | **brand_id** | **String** | The unique identifier for the brand associated with the message | [optional] |
 | **campaign_id** | **String** | The unique identifier for the campaign associated with the message | [optional] |
 | **segment_count** | **Float** | The number of segments into which the message was split | [optional] |
+| **media_urls** | **Array<String>** | an array of HTTP URLs which were attached this this message | [optional] |
 
 ## Example
 
@@ -32,7 +33,8 @@ instance = Freeclimb::MessageResultAllOf.new(
   notification_url: null,
   brand_id: null,
   campaign_id: null,
-  segment_count: null
+  segment_count: null,
+  media_urls: null
 )
 ```
 

data/docs/Play.md

@@ -6,7 +6,6 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
 
 ## Example
@@ -17,7 +16,6 @@ require 'freeclimb'
 instance = Freeclimb::Play.new(
   file: null,
   loop: null,
-  conference_id: null,
   privacy_mode: null
 )
 ```

data/docs/PlayAllOf.md

@@ -6,7 +6,6 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
 
 ## Example
@@ -17,7 +16,6 @@ require 'freeclimb'
 instance = Freeclimb::PlayAllOf.new(
   file: null,
   loop: null,
-  conference_id: null,
   privacy_mode: null
 )
 ```

data/docs/RemoveFromConference.md

@@ -4,15 +4,12 @@
 
 | 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::RemoveFromConference.new(
-  call_id: null
-)
+instance = Freeclimb::RemoveFromConference::[NAME OF ENUM]
 ```
 

data/docs/SMSTenDLCCampaign.md

@@ -32,6 +32,11 @@
 | **sample5** | **String** | Message sample. Some campaign tiers require 5 or more message samples. | [optional] |
 | **message_flow** | **String** | Message flow description. | [optional] |
 | **help_message** | **String** | Help message of the campaign. | [optional] |
+| **optin_keywords** | **String** | Subscriber opt-in keywords. Multiple keywords are comma separated without space. | [optional] |
+| **optout_keywords** | **String** | Subscriber opt-out keywords. Multiple keywords are comma separated without space. | [optional] |
+| **help_keywords** | **String** | Subscriber help keywords. Multiple keywords are comma separated without space. | [optional] |
+| **optin_message** | **String** | Subscriber opt-in message. | [optional] |
+| **optout_message** | **String** | Subscriber opt-out message. | [optional] |
 | **reference_id** | **String** | Caller supplied campaign reference ID. If supplied, the value must be unique across all submitted campaigns. Can be used to prevent duplicate campaign registrations. | [optional] |
 | **mock** | **Boolean** | Campaign created from mock brand. Mocked campaign cannot be shared with an upstream CNP. |  |
 | **next_renewal_or_expiration_date** | **Date** | When the campaign would be due for its next renew/bill date. | [optional] |
@@ -70,6 +75,11 @@ instance = Freeclimb::SMSTenDLCCampaign.new(
   sample5: null,
   message_flow: null,
   help_message: null,
+  optin_keywords: null,
+  optout_keywords: null,
+  help_keywords: null,
+  optin_message: null,
+  optout_message: null,
   reference_id: null,
   mock: null,
   next_renewal_or_expiration_date: Fri Dec 31 19:00:00 EST 1999

data/docs/SMSTollFreeCampaign.md

@@ -0,0 +1,30 @@
+# Freeclimb::SMSTollFreeCampaign
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **account_id** | **String** | ID of the account that created this toll-free campaign |  |
+| **campaign_id** | **String** | Alphanumeric identifier used by the platform to identify this toll-free campaign |  |
+| **use_case** | **String** |  |  |
+| **registration_status** | **String** | Current toll-free campaign registration status.Possible values: UNREGISTERED,INITIATED,PENDING,DECLINED,REGISTERED. A newly created campaign defaults to INITIATED status.  |  |
+| **date_created** | **String** |  |  |
+| **date_updated** | **String** |  |  |
+| **revision** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTollFreeCampaign.new(
+  account_id: null,
+  campaign_id: null,
+  use_case: null,
+  registration_status: null,
+  date_created: null,
+  date_updated: null,
+  revision: null
+)
+```
+

data/docs/SMSTollFreeCampaignsListResult.md

@@ -0,0 +1,32 @@
+# Freeclimb::SMSTollFreeCampaignsListResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** | Total amount of requested resource. | [optional] |
+| **start** | **Integer** | Resource index at start of current page | [optional] |
+| **_end** | **Integer** | Resource index at end of current page | [optional] |
+| **page** | **Integer** | Current page | [optional] |
+| **num_pages** | **Integer** | Total number of pages | [optional] |
+| **page_size** | **Integer** | Number of items per page | [optional] |
+| **next_page_uri** | **String** | Uri to retrieve the next page of items | [optional] |
+| **brands** | [**Array<SMSTollFreeCampaign>**](SMSTollFreeCampaign.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::SMSTollFreeCampaignsListResult.new(
+  total: null,
+  start: null,
+  _end: null,
+  page: null,
+  num_pages: null,
+  page_size: null,
+  next_page_uri: null,
+  brands: null
+)
+```
+

data/docs/SMSTollFreeCampaignsListResultAllOf.md

@@ -0,0 +1,18 @@
+# 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/Say.md

@@ -7,7 +7,6 @@
 | **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] |
-| **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] |
 | **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
 
 ## Example
@@ -19,7 +18,6 @@ instance = Freeclimb::Say.new(
   text: null,
   language: null,
   loop: null,
-  conference_id: null,
   privacy_mode: null
 )
 ```

data/docs/SayAllOf.md

@@ -7,7 +7,6 @@
 | **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] |
-| **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] |
 | **privacy_mode** | **Boolean** | Parameter `privacyMode` will not log the `text` as required by PCI compliance. | [optional] |
 
 ## Example
@@ -19,7 +18,6 @@ instance = Freeclimb::SayAllOf.new(
   text: null,
   language: null,
   loop: null,
-  conference_id: null,
   privacy_mode: null
 )
 ```

data/docs/SetListen.md

@@ -4,7 +4,6 @@
 
 | 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] |
 
 ## Example
@@ -13,7 +12,6 @@
 require 'freeclimb'
 
 instance = Freeclimb::SetListen.new(
-  call_id: null,
   listen: null
 )
 ```

data/docs/SetListenAllOf.md

@@ -4,7 +4,6 @@
 
 | 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] |
 
 ## Example
@@ -13,7 +12,6 @@
 require 'freeclimb'
 
 instance = Freeclimb::SetListenAllOf.new(
-  call_id: null,
   listen: null
 )
 ```

data/docs/SetTalk.md

@@ -4,7 +4,6 @@
 
 | 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] |
 
 ## Example
@@ -13,7 +12,6 @@
 require 'freeclimb'
 
 instance = Freeclimb::SetTalk.new(
-  call_id: null,
   talk: null
 )
 ```

data/docs/SetTalkAllOf.md

@@ -4,7 +4,6 @@
 
 | 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] |
 
 ## Example
@@ -13,7 +12,6 @@
 require 'freeclimb'
 
 instance = Freeclimb::SetTalkAllOf.new(
-  call_id: null,
   talk: null
 )
 ```

data/docs/TFN.md

@@ -0,0 +1,18 @@
+# Freeclimb::TFN
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **campaign_id** | **String** | alphanumeric identifier for the TollFree campaign associated with this number |  |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TFN.new(
+  campaign_id: null
+)
+```
+

data/docs/TerminateConference.md

@@ -4,15 +4,12 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **conference_id** | **String** | ID of the conference to terminate. |  |
 
 ## Example
 
 ```ruby
 require 'freeclimb'
 
-instance = Freeclimb::TerminateConference.new(
-  conference_id: null
-)
+instance = Freeclimb::TerminateConference::[NAME OF ENUM]
 ```
 

data/docs/TranscribeUtterance.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **action_url** | **String** |  |  |
 | **play_beep** | **Boolean** |  | [optional][default to false] |
-| **record** | [**TranscribeUtteranceRecord**](TranscribeUtteranceRecord.md) |  | [optional] |
+| **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] |

data/docs/TranscribeUtteranceAllOf.md

@@ -0,0 +1,28 @@
+# 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

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