freeclimb 2.0.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89a0a05b6000e3c8fc68bc43ee19378adfd809d62d989622c34e5fb7b4fcf609
-  data.tar.gz: c0b44914411d928fa8ddb3bd6ec8495438dd1d69d6ef308be3c27e6ff91079af
+  metadata.gz: 2b2432d5b30385e65f3c0e9a9fc9c2731de5cd03377ef0df110269772cb3d1fd
+  data.tar.gz: eb91292c2fa6fa794fbf1c0c7c5925b79c023a6eea28d167848d9c9aa6f91036
 SHA512:
-  metadata.gz: '0278ffee2048c13fbadf559f67667615d9c808537e2ef399b8403f4d8be3f09756f4e47bdf7bd892c055a443f0cbf3c215f3e23ecedb0190b933e7fd024b8f93'
-  data.tar.gz: '0982c76756c8605f3c6f0a0736fd4db3a9d6af6a0fad59e433c8645900e5a412da34b0de143828d1bcb5ee42ab884825ed9c989369511e04f4fc78bd57c2023f'
+  metadata.gz: 648bb6a97a082a2baf5b5edf02effb1312f98ae1cc67e4b309e843905abd98343b8805e9f6e365be7d96517d4b5f6b5bd09cf0f791c3cf5dadd9ecac90128e82
+  data.tar.gz: f238c728fac55b34900af24c2d37072ede3948fd73460ea4f6c9aad62237153095473dc47813d7fba0ea25b1d76aba72be90bc6379420497cc1e6129070cdca5

data/CHANGELOG.md

@@ -0,0 +1,95 @@
+# Ruby SDK Changelog
+All notable changes to this project will be documented in this file.
+
+The format of this changelog is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+None
+
+
+<a name="2.1.1"></a>
+## [2.1.1] - 2020-12-16
+### Added
+- Add `privacyMode` option to RecordUtterance PerCL command
+
+<a name="2.1.0"></a>
+## [2.1.0] - 2020-12-16
+### Added
+- Add `Reject` PerCL command
+- Add `Hangup` PerCL command
+
+### Fixed
+- Updated description and requirement of `action_url` attribute of `Redirect` PerCL command
+
+<a name="2.0.3"></a>
+## [2.0.3] - 2020-12-16
+### Added
+- Additional message statuses for TFN functionality
+
+<a name="2.0.2"></a>
+## [2.0.2] - 2020-08-13
+### Added
+- Add `privacyMode` option
+
+<a name="1.2.1"></a>
+## [1.2.1] - 2020-10-14
+### Changed
+- Rename `setPersyUrl` to `setUrl`
+
+### Fixed
+- Properly handle empty response bodies
+- Other Minor bug fixes
+
+<a name="1.2"></a>
+## [1.2] - 2019-10-16
+### Changed
+- Persephony is now FreeClimb
+- Code cleanup
+- Documentation Updates
+- Test Update
+
+### Fixed
+- Update common response handler to not use bodu twice
+
+<a name="1.1.1"></a>
+## [1.1.1] - 2019-06-27
+### Changed
+- Minor updates to docs and code cleanup
+
+
+<a name="1.1.0"></a>
+## [1.1.0] - 2019-06-07
+### Pull Requests
+- Merge pull request [#22](https://gitlab.vailsys.com/vail-cloud-services/fc-boilerplates/javascript-sdk/issues/22) from PersephonyAPI/maintenance
+
+
+<a name="1.0.0"></a>
+## [1.0.0] - 2019-06-04
+### Changed
+- Change default api target
+
+
+<a name="0.1.0"></a>
+## [0.1.0] - 2019-05-30
+### Added
+- `PlayEarlyMedia` PerCL Command
+
+<a name="0.0.2"></a>
+## [0.0.2] - 2018-11-29
+### Remove
+- Remove `callConnectUrl` and `statusCallbackUrl` from api.calls#create
+
+<a name="0.0.1"></a>
+## [0.0.1] - 2018-11-13
+### Added
+- PerCL Support
+- FreeClimb API Support
+- README, LICENSE
+- docs
+
+### Changed
+- Initial Release
+
+
+[Unreleased]: https://github.com/FreeClimbAPI/ruby-sdk/compare/v1.0.1...HEAD

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    freeclimb (1.0.4)
+    freeclimb (2.0.0)
       json (~> 2.1, >= 2.1.0)
       typhoeus (~> 1.0, >= 1.0.1)
 

data/README.md

@@ -5,7 +5,7 @@ FreeClimb is a cloud-based application programming interface (API) that puts the
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 1.0.0
-- Package version: 2.0.0
+- Package version: 2.1.1
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Installation
@@ -21,16 +21,16 @@ gem build freeclimb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./freeclimb-2.0.0.gem
+gem install ./freeclimb-2.1.1.gem
 ```
 
-(for development, run `gem install --dev ./freeclimb-2.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-2.1.1.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'freeclimb', '~> 2.0.0'
+    gem 'freeclimb', '~> 2.1.1'
     
 ### Install from Ruby gems
 ```shell
@@ -185,6 +185,8 @@ Class | Method | HTTP request | Description
  - [Freeclimb::GetDigitsAllOf](docs/GetDigitsAllOf.md)
  - [Freeclimb::GetSpeech](docs/GetSpeech.md)
  - [Freeclimb::GetSpeechAllOf](docs/GetSpeechAllOf.md)
+ - [Freeclimb::Hangup](docs/Hangup.md)
+ - [Freeclimb::HangupAllOf](docs/HangupAllOf.md)
  - [Freeclimb::IncomingNumberList](docs/IncomingNumberList.md)
  - [Freeclimb::IncomingNumberListAllOf](docs/IncomingNumberListAllOf.md)
  - [Freeclimb::IncomingNumberRequest](docs/IncomingNumberRequest.md)
@@ -228,6 +230,8 @@ Class | Method | HTTP request | Description
  - [Freeclimb::RecordingResultAllOf](docs/RecordingResultAllOf.md)
  - [Freeclimb::Redirect](docs/Redirect.md)
  - [Freeclimb::RedirectAllOf](docs/RedirectAllOf.md)
+ - [Freeclimb::Reject](docs/Reject.md)
+ - [Freeclimb::RejectAllOf](docs/RejectAllOf.md)
  - [Freeclimb::RemoveFromConference](docs/RemoveFromConference.md)
  - [Freeclimb::RemoveFromConferenceAllOf](docs/RemoveFromConferenceAllOf.md)
  - [Freeclimb::Say](docs/Say.md)
@@ -255,3 +259,6 @@ Class | Method | HTTP request | Description
 
 - **Type**: HTTP basic authentication
 
+## Getting Help
+
+If you are experiencing difficulties, [contact support](https://freeclimb.com/support).

data/docs/DefaultApi.md

@@ -102,7 +102,7 @@ This endpoint does not need any parameter.
 
 ## buy_a_phone_number
 
-> IncomingNumberResult buy_a_phone_number(opts)
+> IncomingNumberResult buy_a_phone_number(buy_incoming_number_request)
 
 Buy a Phone Number
 
@@ -119,13 +119,11 @@ Freeclimb.configure do |config|
 end
 
 api_instance = Freeclimb::DefaultApi.new
-opts = {
-  buy_incoming_number_request: Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
-}
+buy_incoming_number_request = Freeclimb::BuyIncomingNumberRequest.new # BuyIncomingNumberRequest | Incoming Number transaction details
 
 begin
   #Buy a Phone Number
-  result = api_instance.buy_a_phone_number(opts)
+  result = api_instance.buy_a_phone_number(buy_incoming_number_request)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->buy_a_phone_number: #{e}"
@@ -137,7 +135,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details | [optional] 
+ **buy_incoming_number_request** | [**BuyIncomingNumberRequest**](BuyIncomingNumberRequest.md)| Incoming Number transaction details | 
 
 ### Return type
 
@@ -619,7 +617,7 @@ Name | Type | Description  | Notes
 
 ## filter_logs
 
-> LogList filter_logs(opts)
+> LogList filter_logs(filter_logs_request)
 
 Filter Logs
 
@@ -636,13 +634,11 @@ Freeclimb.configure do |config|
 end
 
 api_instance = Freeclimb::DefaultApi.new
-opts = {
-  filter_logs_request: Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
-}
+filter_logs_request = Freeclimb::FilterLogsRequest.new # FilterLogsRequest | Filter logs request paramters
 
 begin
   #Filter Logs
-  result = api_instance.filter_logs(opts)
+  result = api_instance.filter_logs(filter_logs_request)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->filter_logs: #{e}"
@@ -654,7 +650,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters | [optional] 
+ **filter_logs_request** | [**FilterLogsRequest**](FilterLogsRequest.md)| Filter logs request paramters | 
 
 ### Return type
 
@@ -2010,7 +2006,7 @@ nil (empty response body)
 
 ## send_an_sms_message
 
-> MessageResult send_an_sms_message(opts)
+> MessageResult send_an_sms_message(message_request)
 
 Send an SMS Message
 
@@ -2027,13 +2023,11 @@ Freeclimb.configure do |config|
 end
 
 api_instance = Freeclimb::DefaultApi.new
-opts = {
-  message_request: Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
-}
+message_request = Freeclimb::MessageRequest.new # MessageRequest | Details to create a message
 
 begin
   #Send an SMS Message
-  result = api_instance.send_an_sms_message(opts)
+  result = api_instance.send_an_sms_message(message_request)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->send_an_sms_message: #{e}"
@@ -2045,7 +2039,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message | [optional] 
+ **message_request** | [**MessageRequest**](MessageRequest.md)| Details to create a message | 
 
 ### Return type
 
@@ -2169,7 +2163,7 @@ Name | Type | Description  | Notes
 
 ## update_a_live_call
 
-> update_a_live_call(call_id, opts)
+> update_a_live_call(call_id, update_call_request)
 
 Update a Live Call
 
@@ -2187,13 +2181,11 @@ end
 
 api_instance = Freeclimb::DefaultApi.new
 call_id = 'call_id_example' # String | String that uniquely identifies this call resource.
-opts = {
-  update_call_request: Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
-}
+update_call_request = Freeclimb::UpdateCallRequest.new # UpdateCallRequest | Call details to update
 
 begin
   #Update a Live Call
-  api_instance.update_a_live_call(call_id, opts)
+  api_instance.update_a_live_call(call_id, update_call_request)
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->update_a_live_call: #{e}"
 end
@@ -2205,7 +2197,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **call_id** | **String**| String that uniquely identifies this call resource. | 
- **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update | [optional] 
+ **update_call_request** | [**UpdateCallRequest**](UpdateCallRequest.md)| Call details to update | 
 
 ### Return type
 

data/docs/GetDigits.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **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
 
@@ -25,7 +26,8 @@ instance = Freeclimb::GetDigits.new(action_url: nil,
                                  initial_timeout_ms: nil,
                                  max_digits: nil,
                                  min_digits: nil,
-                                 prompts: nil)
+                                 prompts: nil,
+                                 privacy_mode: nil)
 ```
 
 

data/docs/GetDigitsAllOf.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **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
 
@@ -25,7 +26,8 @@ instance = Freeclimb::GetDigitsAllOf.new(action_url: nil,
                                  initial_timeout_ms: nil,
                                  max_digits: nil,
                                  min_digits: nil,
-                                 prompts: nil)
+                                 prompts: nil,
+                                 privacy_mode: nil)
 ```
 
 

data/docs/GetSpeech.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **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] 
-**enforce_pci** | **Boolean** | Parameter enforcePCI will not log the `text` as required by PCI compliance. | [optional] 
+**privacy_mode** | **Boolean** | Parameter privacyMode will not log the `text` as required by PCI compliance. | [optional] 
 
 ## Code Sample
 
@@ -35,7 +35,7 @@ instance = Freeclimb::GetSpeech.new(action_url: nil,
                                  sensitivity_level: nil,
                                  speech_complete_timeout_ms: nil,
                                  speech_incomplete_timeout_ms: nil,
-                                 enforce_pci: nil)
+                                 privacy_mode: nil)
 ```
 
 

data/docs/GetSpeechAllOf.md

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
 **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] 
-**enforce_pci** | **Boolean** | Parameter enforcePCI will not log the `text` as required by PCI compliance. | [optional] 
+**privacy_mode** | **Boolean** | Parameter privacyMode will not log the `text` as required by PCI compliance. | [optional] 
 
 ## Code Sample
 
@@ -35,7 +35,7 @@ instance = Freeclimb::GetSpeechAllOf.new(action_url: nil,
                                  sensitivity_level: nil,
                                  speech_complete_timeout_ms: nil,
                                  speech_incomplete_timeout_ms: nil,
-                                 enforce_pci: nil)
+                                 privacy_mode: nil)
 ```
 
 

data/docs/Hangup.md

@@ -0,0 +1,17 @@
+# Freeclimb::Hangup
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **String** | The user defined reason for the hangup. 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::Hangup.new(reason: nil)
+```
+
+

data/docs/HangupAllOf.md

@@ -0,0 +1,17 @@
+# Freeclimb::HangupAllOf
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**reason** | **String** | The user defined reason for the hangup. 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::HangupAllOf.new(reason: nil)
+```
+
+

data/docs/MakeCallRequest.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **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] 
 **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
 
@@ -25,7 +26,8 @@ instance = Freeclimb::MakeCallRequest.new(from: nil,
                                  if_machine: nil,
                                  if_machine_url: nil,
                                  timeout: nil,
-                                 parent_call_id: nil)
+                                 parent_call_id: nil,
+                                 privacy_mode: 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] 

data/docs/MessageResultAllOf.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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]