freeclimb 1.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96848f5e9258bdb1f080bd928925f8a8deb8def5956ffc3e848309eb956cacfe
-  data.tar.gz: 9be42d0ea3f8d94043a01fea3a1bf7376e79ea1429db4dd6bfd91d268fff318f
+  metadata.gz: e154bc07735aebfee157d698a0dae1ffffed71bb6cf3a051805e027ad04aab9a
+  data.tar.gz: 2b7b6796a53c70ac1ba607725e4ef36febf565f30b048bfc97bed865f0852436
 SHA512:
-  metadata.gz: 3da7ff28bbf1e87c054db51b174adccfcb0018014d80eba4ea4560fa62535cb984877dfdf8fd7c4960cc91252c35299fb4ff274e3a3f1d5a4e32e91dd741ec1e
-  data.tar.gz: 1a0cf62e4a11071b5959642f17cba3a05a5e68f4d7a1cf7b4aed8cfa0bb3eb2bf385e206405b366ba91c30d3060666a4c3f275746f9ad1fa9e19ba3ae3b78632
+  metadata.gz: 2a604b6a3b6db99b9d091d2cdc12b3214d4126cbad0ebf1a451645a5066ae2ff6a6d52cc3eef3cade135b3a091ada73e57e79386e3e8cd4920272fef86b58eb5
+  data.tar.gz: 45d86984e83e1bb6981a86b4d3db0c673af5d7801a1203ee93be801c4641e4a945fa429a7ce5ae2654e664250102b18a6eccd3b4741a358e0c8d7775eb476b5f

data/CHANGELOG.md

@@ -0,0 +1,89 @@
+# 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.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.2)
+    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: 1.0.3
+- Package version: 2.1.0
 - 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-1.0.3.gem
+gem install ./freeclimb-2.1.0.gem
 ```
 
-(for development, run `gem install --dev ./freeclimb-1.0.3.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-2.1.0.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', '~> 1.0.3'
+    gem 'freeclimb', '~> 2.1.0'
     
 ### Install from Ruby gems
 ```shell
@@ -178,7 +178,6 @@ Class | Method | HTTP request | Description
  - [Freeclimb::CreateConferenceAllOf](docs/CreateConferenceAllOf.md)
  - [Freeclimb::CreateConferenceRequest](docs/CreateConferenceRequest.md)
  - [Freeclimb::Dequeue](docs/Dequeue.md)
- - [Freeclimb::DequeueMemberRequest](docs/DequeueMemberRequest.md)
  - [Freeclimb::Enqueue](docs/Enqueue.md)
  - [Freeclimb::EnqueueAllOf](docs/EnqueueAllOf.md)
  - [Freeclimb::FilterLogsRequest](docs/FilterLogsRequest.md)
@@ -186,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)
@@ -229,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)
@@ -256,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/AccountRequest.md

@@ -6,7 +6,6 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **_alias** | **String** | Description for this account. | [optional] 
 **label** | **String** | Group to which this account belongs. | [optional] 
-**request_id** | **String** | RequestId for this request starting with prefix *RQ* followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will 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] 
 
 ## Code Sample
 
@@ -14,8 +13,7 @@ Name | Type | Description | Notes
 require 'freeclimb'
 
 instance = Freeclimb::AccountRequest.new(_alias: nil,
-                                 label: nil,
-                                 request_id: nil)
+                                 label: nil)
 ```
 
 

data/docs/ApplicationRequest.md

@@ -11,7 +11,6 @@ Name | Type | Description | Notes
 **status_callback_url** | **String** | The URL that FreeClimb will request to pass call status (such as call ended) to the application.  Note: This is a notification only; any PerCL returned will be ignored. | [optional] 
 **sms_url** | **String** | The URL that FreeClimb will request when a phone number assigned to this application receives an incoming SMS message. Used for inbound SMS only.  Note: Any PerCL returned will be ignored. | [optional] 
 **sms_fallback_url** | **String** | The URL that FreeClimb will request if it times out waiting for a response from the smsUrl. Used for inbound SMS only.  Note: Any PerCL returned will be ignored. | [optional] 
-**request_id** | **String** | The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will 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] 
 
 ## Code Sample
 
@@ -24,8 +23,7 @@ instance = Freeclimb::ApplicationRequest.new(_alias: nil,
                                  call_connect_url: nil,
                                  status_callback_url: nil,
                                  sms_url: nil,
-                                 sms_fallback_url: nil,
-                                 request_id: nil)
+                                 sms_fallback_url: nil)
 ```
 
 

data/docs/BuyIncomingNumberRequest.md

@@ -7,7 +7,6 @@ Name | Type | Description | Notes
 **phone_number** | **String** | Phone number to purchase in E.164 format (as returned in the list of Available Phone Numbers). | 
 **_alias** | **String** | Description for this new incoming phone number (max 64 characters). | [optional] 
 **application_id** | **String** | ID of the application that should handle phone calls to the number. | [optional] 
-**request_id** | **String** | RequestId for this request starting with prefix `RQ` followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will 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] 
 
 ## Code Sample
 
@@ -16,8 +15,7 @@ require 'freeclimb'
 
 instance = Freeclimb::BuyIncomingNumberRequest.new(phone_number: nil,
                                  _alias: nil,
-                                 application_id: nil,
-                                 request_id: nil)
+                                 application_id: nil)
 ```
 
 

data/docs/CreateConferenceRequest.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **record** | **Boolean** | Setting to `true` records the entire Conference. | [optional] 
 **wait_url** | **String** | If specified, a URL for the audio file that provides custom hold music for the Conference when it is in the populated state. Otherwise, FreeClimb uses a system default audio file. This is always fetched using HTTP GET and is fetched just once — when the Conference is created. | [optional] 
 **status_callback_url** | **String** | This URL is invoked when the status of the Conference changes. For more information, see **statusCallbackUrl** (below). | [optional] 
-**request_id** | **String** | The requestId for this request starting with prefix \"RQ\" followed by 40 hexadecimal characters. FreeClimb logs generated while processing this request will 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] 
 
 ## Code Sample
 
@@ -20,8 +19,7 @@ instance = Freeclimb::CreateConferenceRequest.new(_alias: nil,
                                  play_beep: nil,
                                  record: nil,
                                  wait_url: nil,
-                                 status_callback_url: nil,
-                                 request_id: nil)
+                                 status_callback_url: nil)
 ```
 
 

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
 
@@ -464,7 +462,7 @@ nil (empty response body)
 
 ## dequeue_a_member
 
-> QueueMember dequeue_a_member(queue_id, call_id, opts)
+> QueueMember dequeue_a_member(queue_id, call_id)
 
 Dequeue a Member
 
@@ -483,13 +481,10 @@ end
 api_instance = Freeclimb::DefaultApi.new
 queue_id = 'queue_id_example' # String | String that uniquely identifies the Queue that the Member belongs to.
 call_id = 'call_id_example' # String | ID if the Call that the Member belongs to
-opts = {
-  dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue member request details
-}
 
 begin
   #Dequeue a Member
-  result = api_instance.dequeue_a_member(queue_id, call_id, opts)
+  result = api_instance.dequeue_a_member(queue_id, call_id)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->dequeue_a_member: #{e}"
@@ -503,7 +498,6 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **queue_id** | **String**| String that uniquely identifies the Queue that the Member belongs to. | 
  **call_id** | **String**| ID if the Call that the Member belongs to | 
- **dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue member request details | [optional] 
 
 ### Return type
 
@@ -515,13 +509,13 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
 ## dequeue_head_member
 
-> QueueMember dequeue_head_member(queue_id, opts)
+> QueueMember dequeue_head_member(queue_id)
 
 Dequeue Head Member
 
@@ -539,13 +533,10 @@ end
 
 api_instance = Freeclimb::DefaultApi.new
 queue_id = 'queue_id_example' # String | String that uniquely identifies this queue resource.
-opts = {
-  dequeue_member_request: Freeclimb::DequeueMemberRequest.new # DequeueMemberRequest | Dequeue head member request details
-}
 
 begin
   #Dequeue Head Member
-  result = api_instance.dequeue_head_member(queue_id, opts)
+  result = api_instance.dequeue_head_member(queue_id)
   p result
 rescue Freeclimb::ApiError => e
   puts "Exception when calling DefaultApi->dequeue_head_member: #{e}"
@@ -558,7 +549,6 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **queue_id** | **String**| String that uniquely identifies this queue resource. | 
- **dequeue_member_request** | [**DequeueMemberRequest**](DequeueMemberRequest.md)| Dequeue head member request details | [optional] 
 
 ### Return type
 
@@ -570,7 +560,7 @@ Name | Type | Description  | Notes
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
+- **Content-Type**: Not defined
 - **Accept**: application/json
 
 
@@ -627,7 +617,7 @@ Name | Type | Description  | Notes
 
 ## filter_logs
 
-> LogList filter_logs(opts)
+> LogList filter_logs(filter_logs_request)
 
 Filter Logs
 
@@ -644,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}"
@@ -662,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
 
@@ -2018,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
 
@@ -2035,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}"
@@ -2053,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
 
@@ -2177,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
 
@@ -2195,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
@@ -2213,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