freeclimb 4.8.0 → 4.9.0

data/openapi.json

@@ -464,6 +464,7 @@
             "SendDigits": "#/components/schemas/SendDigits",
             "SetListen": "#/components/schemas/SetListen",
             "SetTalk": "#/components/schemas/SetTalk",
+            "SetDTMFPassThrough": "#/components/schemas/SetDTMFPassThrough",
             "Sms": "#/components/schemas/Sms",
             "StartRecordCall": "#/components/schemas/StartRecordCall",
             "TerminateConference": "#/components/schemas/TerminateConference",
@@ -536,6 +537,10 @@
               "talk": {
                 "description": "If `true`, the Participant joins the Conference with talk privileges. This may be modified later via the REST API or `SetTalk` PerCL command. ",
                 "type": "boolean"
+              },
+              "dtmfPassThrough": {
+                "description": "If `true`, the Participant joins the Conference with dtmfPassThrough privileges. This may be modified later via the REST API or `SetDTMFPassThrough` PerCL command. ",
+                "type": "boolean"
               }
             }
           }
@@ -1175,7 +1180,7 @@
         ]
       },
       "SetListen": {
-        "description": "The `SetListen` command enables or disables the listen privilege for a Conference Participant provided both calls are in the same conference. The Participant can hear what the other participants are saying only if this privilege is enabled.",
+        "description": "The `SetListen` command enables or disables the listen privilege for this Conference Participant. The Participant can hear what the other participants are saying only if this privilege is enabled.",
         "x-percl-command": true,
         "x-ref-properties": ["false"],
         "allOf": [
@@ -1195,7 +1200,7 @@
         ]
       },
       "SetTalk": {
-        "description": "The `SetTalk` command enables or disables the talk privilege for a Participant in a Conference provided both calls are in the same conference. If 'true', no audio from that Participant is shared with the other Participants of the Conference.",
+        "description": "The `SetTalk` command enables or disables the talk privilege for this Conference Participant. If 'true', no audio from that Participant is shared with the other Participants of the Conference.",
         "x-percl-command": true,
         "x-ref-properties": ["false"],
         "allOf": [
@@ -1214,6 +1219,26 @@
           }
         ]
       },
+      "SetDTMFPassThrough": {
+        "description": "The `SetDTMFPassThrough` command enables or disables the dtmfPassThrough privilege for this Conference Participant. If 'true', DTMFs will be passed through from this Participant to all other Participants in the Conference",
+        "x-percl-command": true,
+        "x-ref-properties": ["false"],
+        "allOf": [
+          {
+            "$ref": "#/components/schemas/PerclCommand"
+          },
+          {
+            "required": [],
+            "type": "object",
+            "properties": {
+              "dtmfPassThrough": {
+                "description": "Specifying `false` mutes the Participant's dtmf audio.",
+                "type": "boolean"
+              }
+            }
+          }
+        ]
+      },
       "Sms": {
         "description": "The `Sms` command can be used to send an SMS message to a phone number during a phone call. International SMS is disabled by default.",
         "x-percl-command": true,
@@ -1842,6 +1867,11 @@
                 "type": "object",
                 "description": "The list of subresources for this Call. These include things like logs and recordings associated with the Call.",
                 "nullable": true
+              },
+              "applicationId": {
+                "type": "string",
+                "description": "ApplicationId associated with the Call.",
+                "nullable": true
               }
             }
           }
@@ -2155,7 +2185,8 @@
                 "items": {
                   "type": "string",
                   "format": "uri"
-                }
+                },
+                "nullable": true
               }
             }
           }
@@ -2282,7 +2313,8 @@
                 "items": {
                   "type": "string",
                   "format": "uri"
-                }
+                },
+                "nullable": true
               }
             }
           }
@@ -2360,6 +2392,11 @@
                 "description": "True if this Participant has listen privileges in the Conference. False otherwise.",
                 "nullable": true
               },
+              "dtmfPassThrough": {
+                "type": "boolean",
+                "description": "True if this Participant had dtmfPassThrough privileges in the Conference. False otherwise.",
+                "nullable": true
+              },
               "startConfOnEnter": {
                 "type": "boolean",
                 "description": "True if this Participant joining the Conference caused the Conference to start (status = inProgress). False otherwise.",
@@ -2379,6 +2416,10 @@
           "listen": {
             "type": "boolean",
             "description": "(Optional) Default is `true`. Setting to `false` silences the Conference for this Participant. FreeClimb returns an error and ignores any other value."
+          },
+          "dtmfPassThrough": {
+            "type": "boolean",
+            "description": "(Optional) Default is `true`. Setting to `false` mutes dtmf audio for this Participant. FreeClimb returns an error and ignores any other value."
           }
         }
       },
@@ -4936,6 +4977,15 @@
               "type": "boolean"
             }
           },
+          {
+            "name": "dtmfPassThrough",
+            "in": "query",
+            "description": "Only show Participants with the dtmfPassThrough privilege.",
+            "required": false,
+            "schema": {
+              "type": "boolean"
+            }
+          },
           {
             "$ref": "#/components/parameters/AccountId"
           },

data/spec/models/set_dtmf_pass_through_spec.rb

@@ -0,0 +1,163 @@
+=begin
+#FreeClimb API
+
+#FreeClimb is a cloud-based application programming interface (API) that puts the power of the Vail platform in your hands. FreeClimb simplifies the process of creating applications that can use a full range of telephony features without requiring specialized or on-site telephony equipment. Using the FreeClimb REST API to write applications is easy! You have the option to use the language of your choice or hit the API directly. Your application can execute a command by issuing a RESTful request to the FreeClimb API. The base URL to send HTTP requests to the FreeClimb REST API is: /apiserver. FreeClimb authenticates and processes your request.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@freeclimb.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.4.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Freeclimb::SetDTMFPassThrough
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Freeclimb::SetDTMFPassThrough do
+  let(:instance) { Freeclimb::SetDTMFPassThrough.new }
+
+  describe 'test an instance of SetDTMFPassThrough' do
+    it 'should create an instance of SetDTMFPassThrough' do
+      expect(instance).to be_instance_of(Freeclimb::SetDTMFPassThrough)
+    end
+  end
+  
+  describe 'test attribute "dtmf_pass_through"' do
+    it 'should work' do
+      instance.dtmf_pass_through = false
+      expect(instance.dtmf_pass_through).to eq(false)        
+        
+    end
+  end
+
+  describe 'test method "initialize"' do
+    it 'properly initializes with values' do
+        expect{instance = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: true,
+        )}.not_to raise_error()
+    end
+    it 'fails to initialize with input argument that is not a hash in Freeclimb::SetDTMFPassThrough' do
+        expect{instance = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: true,
+          invalid_attribute: true
+        )}.to raise_error(ArgumentError)
+    end
+    it 'fails to initialize with invalid attribute' do
+        expect{instance = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: true,
+          invalid_attribute: true
+        )}.to raise_error(ArgumentError)
+    end
+  end
+  
+  describe 'test method "valid"' do
+    it 'checks if properties are valid' do
+      instance = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: true,
+      )
+      expect(instance.valid?).to eq(true)
+    end
+
+
+    skip 'checks if properties are invalid' do
+      instance = Freeclimb::SetDTMFPassThrough.new(
+        
+      )
+      expect(instance.valid?).to eq(false)
+    end
+    
+  end
+
+  describe 'test method "eql?"' do
+    it 'checks if objects are equal' do
+      obj = Object.new()
+      instance_1 = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: true,
+      )
+      instance_2 = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: true,
+      )
+      expect(instance_1.eql?(instance_2)).to eq(true)
+    end
+    
+    it 'checks if objects are not equal' do
+      instance_1 = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: true,
+      )
+      instance_2 = Freeclimb::SetDTMFPassThrough.new(
+          dtmf_pass_through: false,
+      )
+      expect(instance_1.eql?(instance_2)).to eq(false)
+    end
+  end
+  
+  describe 'test method "hash"' do
+    it 'calculates hash code' do
+      instance = Freeclimb::SetDTMFPassThrough.new(
+      dtmf_pass_through: true,
+    )
+    expect(instance.hash).to be_a_kind_of(Integer)
+    end
+  end
+
+  describe 'test method "build_from_hash"' do
+    it 'builds equivalent model from hash code' do
+      instance_1 = Freeclimb::SetDTMFPassThrough.new(
+        dtmf_pass_through: true,
+      )
+      instance_2 = Freeclimb::SetDTMFPassThrough.new
+      expect(instance_2.build_from_hash(instance_1.hash)).to eq(instance_1.build_from_hash(instance_1.hash))
+    end
+  end
+
+  describe 'test method "_deserialize"' do
+    instance = Freeclimb::SetDTMFPassThrough.new(
+        dtmf_pass_through: true,
+    )
+    it 'deserializes the data of dtmf_pass_through' do
+      expect(instance._deserialize("Boolean", instance.dtmf_pass_through)).to be_a_kind_of(TrueClass)
+    end
+  end
+
+  describe 'test method "to_s"' do
+    it 'returns the string representation of the object' do
+      instance = Freeclimb::SetDTMFPassThrough.new(
+        dtmf_pass_through: true,
+      )
+      expect(instance.to_s).to eq(instance.to_hash.to_s)
+    end
+  end
+
+  describe 'test method "to_hash"' do
+    it 'returns the object in the form of hash' do
+      instance = Freeclimb::SetDTMFPassThrough.new(
+        dtmf_pass_through: true,
+      )
+      expect(instance.to_hash).to be_a_kind_of(Hash)
+    end
+    it 'creates equal hash for two equal objects' do
+      obj = Object.new()
+      instance_1 = Freeclimb::SetDTMFPassThrough.new(
+        dtmf_pass_through: true,
+      )
+      instance_2 = Freeclimb::SetDTMFPassThrough.new(
+        dtmf_pass_through: true,
+      )
+      expect(instance_1.to_hash).to eq(instance_2.to_hash)
+    end
+  end
+
+  describe 'test method "_to_hash"' do
+    instance = Freeclimb::SetDTMFPassThrough.new(
+        dtmf_pass_through: true,
+      )
+    it 'returns dtmf_pass_through in the form of hash' do
+      expect(instance._to_hash(instance.dtmf_pass_through)).to eq(instance.dtmf_pass_through)
+    end
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freeclimb
 version: !ruby/object:Gem::Version
-  version: 4.8.0
+  version: 4.9.0
 platform: ruby
 authors:
 - OpenAPI-Generator
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-22 00:00:00.000000000 Z
+date: 2024-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -199,6 +199,8 @@ files:
 - docs/SayAllOf.md
 - docs/SendDigits.md
 - docs/SendDigitsAllOf.md
+- docs/SetDTMFPassThrough.md
+- docs/SetDTMFPassThroughAllOf.md
 - docs/SetListen.md
 - docs/SetListenAllOf.md
 - docs/SetTalk.md
@@ -339,6 +341,8 @@ files:
 - lib/freeclimb/models/say_all_of.rb
 - lib/freeclimb/models/send_digits.rb
 - lib/freeclimb/models/send_digits_all_of.rb
+- lib/freeclimb/models/set_dtmf_pass_through.rb
+- lib/freeclimb/models/set_dtmf_pass_through_all_of.rb
 - lib/freeclimb/models/set_listen.rb
 - lib/freeclimb/models/set_listen_all_of.rb
 - lib/freeclimb/models/set_talk.rb
@@ -456,6 +460,7 @@ files:
 - spec/models/request_type_spec.rb
 - spec/models/say_spec.rb
 - spec/models/send_digits_spec.rb
+- spec/models/set_dtmf_pass_through_spec.rb
 - spec/models/set_listen_spec.rb
 - spec/models/set_talk_spec.rb
 - spec/models/sms_spec.rb
@@ -539,6 +544,7 @@ test_files:
 - spec/models/message_direction_spec.rb
 - spec/models/application_request_spec.rb
 - spec/models/queue_member_list_spec.rb
+- spec/models/set_dtmf_pass_through_spec.rb
 - spec/models/update_call_request_spec.rb
 - spec/models/play_spec.rb
 - spec/models/sms_ten_dlc_campaigns_list_result_spec.rb