freeclimb 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce9ee766863f3719656d6d09ccba0a61e19b729105d856370d0cd940c3ffef3a
-  data.tar.gz: f8b434df5680d102601079c1a7e7adc44a1b48fe3fabeb4a104042403666cbeb
+  metadata.gz: 1935ef64917bf8f57f192700f55a1be2d9d72919e52a9575fb6a6927374a70b4
+  data.tar.gz: 0b5f639007c5014f4d8142d95cc09de4ba679b34d7d528a0ebf12b22f0260c79
 SHA512:
-  metadata.gz: cc4cfa23f11cc76dee7555e83368f85f2c5fc1dc994079cd097d01507ee9224aaef370c9cacd62adcec8d8a69ebf2c9813aa41a0814a5f7b2646b839f547bc8e
-  data.tar.gz: 560cda13db84b53413675f19a2f4b3f30b618bc832dad6f97bf93f3b9789da4b5a76f48d8d98113f5ca38e066414884ef1c4e6c06e6d4bd34a58e20af0e21ce5
+  metadata.gz: 6c3304b07b5ef6d666006a23d5555a6eeccfa4a84d30f7195d423f669c01fedd4806d51598cec39cf3e2c2f5aed1f806efa0fb67c7563cd2297fe6717034f97c
+  data.tar.gz: a910d4da9ae6f235c98cccd228a7ffb356013ad9d317faa9852d617141e88318b4d0ebe54531cea892f53aabe4cf48e1cebc33a7e52e25cc9c57ae606115f7b4

data/CHANGELOG.md

@@ -6,6 +6,18 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 None
+<a name="4.0.2"></a>
+## [4.0.2] - 2022-10-07
+### Added
+- Add `playBeep` enum to `update_conference_request`
+
+<a name="4.0.1"></a>
+## [4.0.1] - 2022-07-20
+### Added
+- Add `Park` PerCL command
+- Add `Unpark` PerCL command
+### Changed
+- Default loop value for Say command is set to `1`
 
 <a name="4.0.0"></a>
 ## [4.0.0] - 2022-03-03

data/Gemfile

@@ -8,5 +8,5 @@ group :development, :test do
   gem 'rubocop', '~> 0.66.0'
   gem "webmock", "~> 3.14"
   gem "factory_bot", "~> 6.2"
-  gem 'rusty_camel', "~> 1.0.4"
+  gem "facets", "~> 3.1"
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    freeclimb (4.0.0)
+    freeclimb (4.0.2)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM
@@ -23,13 +23,11 @@ GEM
     diff-lcs (1.3)
     ethon (0.15.0)
       ffi (>= 1.15.0)
+    facets (3.1.0)
     factory_bot (6.2.0)
       activesupport (>= 5.0.0)
     ffi (1.15.5)
     hashdiff (1.0.1)
-    helix_runtime (0.5.0)
-      rake (>= 10.0)
-      thor (~> 0.19.4)
     i18n (1.9.1)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.4)
@@ -71,9 +69,6 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.1)
-    rusty_camel (1.0.4)
-      helix_runtime (~> 0.5.0)
-    thor (0.19.4)
     typhoeus (1.4.0)
       ethon (>= 0.9.0)
     tzinfo (2.0.4)
@@ -88,13 +83,13 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  facets (~> 3.1)
   factory_bot (~> 6.2)
   freeclimb!
   pry-byebug
   rake (~> 13.0.6)
   rspec (~> 3.6, >= 3.6.0)
   rubocop (~> 0.66.0)
-  rusty_camel (~> 1.0.4)
   webmock (~> 3.14)
 
 BUNDLED WITH

data/README.md

@@ -7,7 +7,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: 4.0.0
+- Package version: 4.0.2
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [https://www.freeclimb.com/support/](https://www.freeclimb.com/support/)
 
@@ -15,7 +15,7 @@ For more information, please visit [https://www.freeclimb.com/support/](https://
 
 Add this to the Gemfile:
 
-    gem 'freeclimb', '~> 4.0.0'
+    gem 'freeclimb', '~> 4.0.2'
 
 and run from your terminal
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./freeclimb-4.0.0.gem
+gem install ./freeclimb-4.0.2.gem
 ```
-(for development, run `gem install --dev ./freeclimb-4.0.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-4.0.2.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -208,6 +208,8 @@ Class | Method | HTTP request | Description
  - [Freeclimb::OutDial](docs/OutDial.md)
  - [Freeclimb::OutDialAllOf](docs/OutDialAllOf.md)
  - [Freeclimb::PaginationModel](docs/PaginationModel.md)
+ - [Freeclimb::Park](docs/Park.md)
+ - [Freeclimb::ParkAllOf](docs/ParkAllOf.md)
  - [Freeclimb::Pause](docs/Pause.md)
  - [Freeclimb::PauseAllOf](docs/PauseAllOf.md)
  - [Freeclimb::PerclCommand](docs/PerclCommand.md)
@@ -249,6 +251,7 @@ Class | Method | HTTP request | Description
  - [Freeclimb::StartRecordCall](docs/StartRecordCall.md)
  - [Freeclimb::TerminateConference](docs/TerminateConference.md)
  - [Freeclimb::TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
+ - [Freeclimb::Unpark](docs/Unpark.md)
  - [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
  - [Freeclimb::UpdateConferenceParticipantRequest](docs/UpdateConferenceParticipantRequest.md)
  - [Freeclimb::UpdateConferenceRequest](docs/UpdateConferenceRequest.md)

data/docs/AvailableNumber.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **capabilities** | [**Capabilities**](Capabilities.md) |  | [optional] |
+| **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
 | **phone_number** | **String** | The phone number, in E.164 format (+ country code and phone number: +18003608245). | [optional] |
 | **voice_enabled** | **Boolean** | Typically set to true for all numbers. | [optional] |
 | **sms_enabled** | **Boolean** | Indicates whether the phone number can send and receive SMS messages. | [optional] |
@@ -18,6 +19,7 @@ require 'freeclimb'
 
 instance = Freeclimb::AvailableNumber.new(
   capabilities: null,
+  campaign_id: null,
   phone_number: null,
   voice_enabled: null,
   sms_enabled: null,

data/docs/IncomingNumberResult.md

@@ -9,6 +9,7 @@
 | **date_updated** | **String** | The date that this resource was last updated (GMT) in RFC 1123 format (e.g., Mon, 15 Jun 2009 20:45:30 GMT). | [optional] |
 | **revision** | **Integer** | Revision count for the resource. This count is set to 1 on creation and is incremented every time it is updated. | [optional] |
 | **capabilities** | [**Capabilities**](Capabilities.md) |  | [optional] |
+| **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
 | **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | [optional] |
 | **account_id** | **String** | ID of the account that owns this phone number. | [optional] |
 | **application_id** | **String** | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional] |
@@ -30,6 +31,7 @@ instance = Freeclimb::IncomingNumberResult.new(
   date_updated: null,
   revision: null,
   capabilities: null,
+  campaign_id: null,
   phone_number_id: null,
   account_id: null,
   application_id: null,

data/docs/IncomingNumberResultAllOf.md

@@ -5,6 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **capabilities** | [**Capabilities**](Capabilities.md) |  | [optional] |
+| **campaign_id** | **String** | The campaign ID generated by the campaign registry | [optional] |
 | **phone_number_id** | **String** | String that uniquely identifies this phone number resource. | [optional] |
 | **account_id** | **String** | ID of the account that owns this phone number. | [optional] |
 | **application_id** | **String** | ID of the Application that FreeClimb should contact if a Call or SMS arrives for this phone number or a Call from this number is placed. An incoming phone number is not useful until associated with an applicationId. | [optional] |
@@ -22,6 +23,7 @@ require 'freeclimb'
 
 instance = Freeclimb::IncomingNumberResultAllOf.new(
   capabilities: null,
+  campaign_id: null,
   phone_number_id: null,
   account_id: null,
   application_id: null,

data/docs/Park.md

@@ -0,0 +1,22 @@
+# Freeclimb::Park
+
+## 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::Park.new(
+  wait_url: null,
+  action_url: null,
+  notification_url: null
+)
+```
+

data/docs/ParkAllOf.md

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

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **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] |
 

data/docs/SayAllOf.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **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] |
+| **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] |
 

data/docs/Unpark.md

@@ -0,0 +1,15 @@
+# Freeclimb::Unpark
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::Unpark.new()
+```
+

data/lib/freeclimb/models/available_number.rb

@@ -17,6 +17,9 @@ module Freeclimb
   class AvailableNumber
     attr_accessor :capabilities
 
+    # The campaign ID generated by the campaign registry
+    attr_accessor :campaign_id
+
     # The phone number, in E.164 format (+ country code and phone number: +18003608245).
     attr_accessor :phone_number
 
@@ -36,6 +39,7 @@ module Freeclimb
     def self.attribute_map
       {
         :'capabilities' => :'capabilities',
+        :'campaign_id' => :'campaignId',
         :'phone_number' => :'phoneNumber',
         :'voice_enabled' => :'voiceEnabled',
         :'sms_enabled' => :'smsEnabled',
@@ -53,6 +57,7 @@ module Freeclimb
     def self.openapi_types
       {
         :'capabilities' => :'Capabilities',
+        :'campaign_id' => :'String',
         :'phone_number' => :'String',
         :'voice_enabled' => :'Boolean',
         :'sms_enabled' => :'Boolean',
@@ -64,6 +69,7 @@ module Freeclimb
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'campaign_id',
         :'phone_number',
         :'voice_enabled',
         :'sms_enabled',
@@ -91,6 +97,10 @@ module Freeclimb
         self.capabilities = attributes[:'capabilities']
       end
 
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
       if attributes.key?(:'phone_number')
         self.phone_number = attributes[:'phone_number']
       end
@@ -131,6 +141,7 @@ module Freeclimb
       return true if self.equal?(o)
       self.class == o.class &&
           capabilities == o.capabilities &&
+          campaign_id == o.campaign_id &&
           phone_number == o.phone_number &&
           voice_enabled == o.voice_enabled &&
           sms_enabled == o.sms_enabled &&
@@ -147,7 +158,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [capabilities, phone_number, voice_enabled, sms_enabled, region, country].hash
+      [capabilities, campaign_id, phone_number, voice_enabled, sms_enabled, region, country].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/incoming_number_result.rb

@@ -29,6 +29,9 @@ module Freeclimb
 
     attr_accessor :capabilities
 
+    # The campaign ID generated by the campaign registry
+    attr_accessor :campaign_id
+
     # String that uniquely identifies this phone number resource.
     attr_accessor :phone_number_id
 
@@ -64,6 +67,7 @@ module Freeclimb
         :'date_updated' => :'dateUpdated',
         :'revision' => :'revision',
         :'capabilities' => :'capabilities',
+        :'campaign_id' => :'campaignId',
         :'phone_number_id' => :'phoneNumberId',
         :'account_id' => :'accountId',
         :'application_id' => :'applicationId',
@@ -89,6 +93,7 @@ module Freeclimb
         :'date_updated' => :'String',
         :'revision' => :'Integer',
         :'capabilities' => :'Capabilities',
+        :'campaign_id' => :'String',
         :'phone_number_id' => :'String',
         :'account_id' => :'String',
         :'application_id' => :'String',
@@ -104,6 +109,7 @@ module Freeclimb
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'campaign_id',
         :'phone_number_id',
         :'account_id',
         :'application_id',
@@ -159,6 +165,10 @@ module Freeclimb
         self.capabilities = attributes[:'capabilities']
       end
 
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
       if attributes.key?(:'phone_number_id')
         self.phone_number_id = attributes[:'phone_number_id']
       end
@@ -219,6 +229,7 @@ module Freeclimb
           date_updated == o.date_updated &&
           revision == o.revision &&
           capabilities == o.capabilities &&
+          campaign_id == o.campaign_id &&
           phone_number_id == o.phone_number_id &&
           account_id == o.account_id &&
           application_id == o.application_id &&
@@ -239,7 +250,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [uri, date_created, date_updated, revision, capabilities, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled].hash
+      [uri, date_created, date_updated, revision, capabilities, campaign_id, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled].hash
     end
 
     # Builds the object from hash

data/lib/freeclimb/models/incoming_number_result_all_of.rb

@@ -17,6 +17,9 @@ module Freeclimb
   class IncomingNumberResultAllOf
     attr_accessor :capabilities
 
+    # The campaign ID generated by the campaign registry
+    attr_accessor :campaign_id
+
     # String that uniquely identifies this phone number resource.
     attr_accessor :phone_number_id
 
@@ -48,6 +51,7 @@ module Freeclimb
     def self.attribute_map
       {
         :'capabilities' => :'capabilities',
+        :'campaign_id' => :'campaignId',
         :'phone_number_id' => :'phoneNumberId',
         :'account_id' => :'accountId',
         :'application_id' => :'applicationId',
@@ -69,6 +73,7 @@ module Freeclimb
     def self.openapi_types
       {
         :'capabilities' => :'Capabilities',
+        :'campaign_id' => :'String',
         :'phone_number_id' => :'String',
         :'account_id' => :'String',
         :'application_id' => :'String',
@@ -84,6 +89,7 @@ module Freeclimb
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'campaign_id',
         :'phone_number_id',
         :'account_id',
         :'application_id',
@@ -115,6 +121,10 @@ module Freeclimb
         self.capabilities = attributes[:'capabilities']
       end
 
+      if attributes.key?(:'campaign_id')
+        self.campaign_id = attributes[:'campaign_id']
+      end
+
       if attributes.key?(:'phone_number_id')
         self.phone_number_id = attributes[:'phone_number_id']
       end
@@ -171,6 +181,7 @@ module Freeclimb
       return true if self.equal?(o)
       self.class == o.class &&
           capabilities == o.capabilities &&
+          campaign_id == o.campaign_id &&
           phone_number_id == o.phone_number_id &&
           account_id == o.account_id &&
           application_id == o.application_id &&
@@ -191,7 +202,7 @@ module Freeclimb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [capabilities, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled].hash
+      [capabilities, campaign_id, phone_number_id, account_id, application_id, phone_number, _alias, region, country, voice_enabled, sms_enabled].hash
     end
 
     # Builds the object from hash