freeclimb 4.4.4 → 4.5.1

data/lib/freeclimb/models/transcribe_utterance_record.rb

@@ -0,0 +1,293 @@
+=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 'date'
+require 'time'
+
+module Freeclimb
+  class TranscribeUtteranceRecord
+    attr_accessor :save_recording
+
+    attr_accessor :max_length_sec
+
+    attr_accessor :rcrd_termination_silence_time_ms
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'save_recording' => :'saveRecording',
+        :'max_length_sec' => :'maxLengthSec',
+        :'rcrd_termination_silence_time_ms' => :'rcrdTerminationSilenceTimeMs'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'save_recording' => :'Boolean',
+        :'max_length_sec' => :'Integer',
+        :'rcrd_termination_silence_time_ms' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Freeclimb::TranscribeUtteranceRecord` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Freeclimb::TranscribeUtteranceRecord`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'save_recording')
+        self.save_recording = attributes[:'save_recording']
+      else
+        self.save_recording = false
+      end
+
+      if attributes.key?(:'max_length_sec')
+        self.max_length_sec = attributes[:'max_length_sec']
+      else
+        self.max_length_sec = 60
+      end
+
+      if attributes.key?(:'rcrd_termination_silence_time_ms')
+        self.rcrd_termination_silence_time_ms = attributes[:'rcrd_termination_silence_time_ms']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@max_length_sec.nil? && @max_length_sec > 60
+        invalid_properties.push('invalid value for "max_length_sec", must be smaller than or equal to 60.')
+      end
+
+      if !@max_length_sec.nil? && @max_length_sec < 1
+        invalid_properties.push('invalid value for "max_length_sec", must be greater than or equal to 1.')
+      end
+
+      if !@rcrd_termination_silence_time_ms.nil? && @rcrd_termination_silence_time_ms > 3000
+        invalid_properties.push('invalid value for "rcrd_termination_silence_time_ms", must be smaller than or equal to 3000.')
+      end
+
+      if !@rcrd_termination_silence_time_ms.nil? && @rcrd_termination_silence_time_ms <= 0
+        invalid_properties.push('invalid value for "rcrd_termination_silence_time_ms", must be greater than 0.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      
+      if @save_recording.nil?
+        false
+      elsif @max_length_sec.nil?
+        false
+      elsif @rcrd_termination_silence_time_ms.nil?
+        false
+      else
+        list_invalid_properties.length() == 0
+      end
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] max_length_sec Value to be assigned
+    def max_length_sec=(max_length_sec)
+      if !max_length_sec.nil? && max_length_sec > 60
+        fail ArgumentError, 'invalid value for "max_length_sec", must be smaller than or equal to 60.'
+      end
+
+      if !max_length_sec.nil? && max_length_sec < 1
+        fail ArgumentError, 'invalid value for "max_length_sec", must be greater than or equal to 1.'
+      end
+
+      @max_length_sec = max_length_sec
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] rcrd_termination_silence_time_ms Value to be assigned
+    def rcrd_termination_silence_time_ms=(rcrd_termination_silence_time_ms)
+      if !rcrd_termination_silence_time_ms.nil? && rcrd_termination_silence_time_ms > 3000
+        fail ArgumentError, 'invalid value for "rcrd_termination_silence_time_ms", must be smaller than or equal to 3000.'
+      end
+
+      if !rcrd_termination_silence_time_ms.nil? && rcrd_termination_silence_time_ms <= 0
+        fail ArgumentError, 'invalid value for "rcrd_termination_silence_time_ms", must be greater than 0.'
+      end
+
+      @rcrd_termination_silence_time_ms = rcrd_termination_silence_time_ms
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          save_recording == o.save_recording &&
+          max_length_sec == o.max_length_sec &&
+          rcrd_termination_silence_time_ms == o.rcrd_termination_silence_time_ms
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [save_recording, max_length_sec, rcrd_termination_silence_time_ms].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        # models (e.g. Pet) or oneOf
+        klass = Freeclimb.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/freeclimb/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 5.4.0
 =end
 
 module Freeclimb
-  VERSION = '4.4.4'
+  VERSION = '4.5.1'
 end

data/lib/freeclimb.rb

@@ -125,6 +125,8 @@ require 'freeclimb/models/set_listen_all_of'
 require 'freeclimb/models/set_talk_all_of'
 require 'freeclimb/models/sms_all_of'
 require 'freeclimb/models/terminate_conference_all_of'
+require 'freeclimb/models/transcribe_utterance'
+require 'freeclimb/models/transcribe_utterance_record'
 require 'freeclimb/models/update_call_request'
 require 'freeclimb/models/update_call_request_status'
 require 'freeclimb/models/update_conference_participant_request'

data/openapi.json

@@ -467,6 +467,7 @@
             "Sms": "#/components/schemas/Sms",
             "StartRecordCall": "#/components/schemas/StartRecordCall",
             "TerminateConference": "#/components/schemas/TerminateConference",
+            "TranscribeUtterance": "#/components/schemas/TranscribeUtterance",
             "Unpark": "#/components/schemas/Unpark"
           }
         },
@@ -3262,6 +3263,78 @@
           "identityStatus": "VERIFIED",
           "createDate": "2022-07-01T20:29:23Z"
         }
+      },
+      "TranscribeUtterance": {
+        "title": "TranscribeUtterance",
+        "x-stoplight": {
+          "id": "u509r3zqc38ze"
+        },
+        "x-percl-command": true,
+        "type": "object",
+        "description": "The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.\n\n`TranscribeUtterance` is blocking and is a terminal command. As such, the actionUrl property is required, and control of the Call picks up using the `PerCL` returned in response of the `actionUrl`. Recording and Transcription information is returned in the actionUrl request. If the reason this command ended was due to the call hanging up, any PerCL returned will not execute.",
+        "properties": {
+          "actionUrl": {
+            "type": "string"
+          },
+          "playBeep": {
+            "type": "boolean",
+            "default": false
+          },
+          "record": {
+            "type": "object",
+            "properties": {
+              "saveRecording": {
+                "type": "boolean",
+                "default": false
+              },
+              "maxLengthSec": {
+                "type": "integer",
+                "minimum": 1,
+                "maximum": 60,
+                "default": 60
+              },
+              "rcrdTerminationSilenceTimeMs": {
+                "type": "integer",
+                "exclusiveMinimum": true,
+                "minimum": 0,
+                "maximum": 3000
+              }
+            }
+          },
+          "privacyForLogging": {
+            "type": "boolean",
+            "default": false
+          },
+          "privacyForRecording": {
+            "type": "boolean",
+            "default": false
+          },
+          "prompts": {
+            "type": "array",
+            "items": {}
+          }
+        },
+        "required": ["actionUrl"],
+        "x-examples": {
+          "Example 1": {
+            "TranscribeUtterance": {
+              "actionUrl": "http://foo.vail/handleTranscription",
+              "record": {
+                "maxLengthSec": 60,
+                "saveRecording": true,
+                "rcrdTerminationSilenceTimeMs": 2000
+              },
+              "playBeep": true,
+              "prompts": [
+                {
+                  "Play": {
+                    "file": "https://yoursite.com/path/to/please-record-greeting.wav"
+                  }
+                }
+              ]
+            }
+          }
+        }
       }
     }
   },

data/spec/api/default_api_spec.rb

@@ -222,6 +222,12 @@ describe 'DefaultApi' do
 
     @has_campaign_list_incoming_numbers_test_value = true
 
+    @campaign_id_list_sms_messages_test_value = 'CX56XX4'
+
+    @brand_id_list_sms_messages_test_value = 'BX56XX4'
+
+    @is10_dlc_list_sms_messages_test_value = true
+
     @queue_request_update_a_queue_test_value = Freeclimb::QueueRequest.new
 
     @application_request_update_an_application_test_value = Freeclimb::ApplicationRequest.new
@@ -1256,6 +1262,9 @@ describe 'DefaultApi' do
   # @option opts [String] :begin_time Only show Messages sent at or after this time (GMT), given as *YYYY-MM-DD hh:mm:ss*.
   # @option opts [String] :end_time Only show messages sent at or before this time (GMT), given as *YYYY-MM-DD hh:mm*..
   # @option opts [MessageDirection] :direction Either `inbound` or `outbound`. Only show Messages that were either *sent from* or *received by* FreeClimb.
+  # @option opts [String] :campaign_id Only show messages associated with this campaign ID.
+  # @option opts [String] :brand_id Only show messages associated with this brand ID
+  # @option opts [Boolean] :is10_dlc Only show messages that were sent as part of a 10DLC campaign.
   # @return [MessagesList]
   describe 'list_sms_messages test' do
     it 'should work' do
@@ -1265,11 +1274,14 @@ describe 'DefaultApi' do
       begin_time = @begin_time_list_sms_messages_test_value
       end_time = @end_time_list_sms_messages_test_value
       direction = @direction_list_sms_messages_test_value
+      campaign_id = @campaign_id_list_sms_messages_test_value
+      brand_id = @brand_id_list_sms_messages_test_value
+      is10_dlc = @is10_dlc_list_sms_messages_test_value
       
       result = @api_instance.list_sms_messages(
         
         {
-          :to => to,:from => from,:begin_time => begin_time,:end_time => end_time,:direction => direction,
+          :to => to,:from => from,:begin_time => begin_time,:end_time => end_time,:direction => direction,:campaign_id => campaign_id,:brand_id => brand_id,:is10_dlc => is10_dlc,
         }
       )
  

data/spec/models/transcribe_utterance_record_spec.rb

@@ -0,0 +1,222 @@
+=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::TranscribeUtteranceRecord
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Freeclimb::TranscribeUtteranceRecord do
+  let(:instance) { Freeclimb::TranscribeUtteranceRecord.new }
+
+  describe 'test an instance of TranscribeUtteranceRecord' do
+    it 'should create an instance of TranscribeUtteranceRecord' do
+      expect(instance).to be_instance_of(Freeclimb::TranscribeUtteranceRecord)
+    end
+  end
+  
+  describe 'test attribute "save_recording"' do
+    it 'should work' do
+      instance.save_recording = false
+      expect(instance.save_recording).to eq(false)        
+    end
+  end
+
+  describe 'test attribute "max_length_sec"' do
+    it 'should work' do
+      instance.max_length_sec = 1
+      expect(instance.max_length_sec).to eq(1) 
+    end
+  end
+
+  describe 'test attribute "rcrd_termination_silence_time_ms"' do
+    it 'should work' do
+      instance.rcrd_termination_silence_time_ms = 1
+      expect(instance.rcrd_termination_silence_time_ms).to eq(1) 
+    end
+  end
+
+  describe 'test method "initialize"' do
+    it 'properly initializes with values' do
+        expect{instance = Freeclimb::TranscribeUtteranceRecord.new(
+          save_recording: true,
+          max_length_sec: 1,
+          rcrd_termination_silence_time_ms: 1,
+        )}.not_to raise_error()
+    end
+    it 'fails to initialize with input argument that is not a hash in Freeclimb::TranscribeUtteranceRecord' do
+        expect{instance = Freeclimb::TranscribeUtteranceRecord.new(
+          save_recording: true,
+          max_length_sec: 1,
+          rcrd_termination_silence_time_ms: 1,
+          invalid_attribute: true
+        )}.to raise_error(ArgumentError)
+    end
+    it 'fails to initialize with invalid attribute' do
+        expect{instance = Freeclimb::TranscribeUtteranceRecord.new(
+          save_recording: true,
+          max_length_sec: 1,
+          rcrd_termination_silence_time_ms: 1,
+          invalid_attribute: true
+        )}.to raise_error(ArgumentError)
+    end
+  end
+
+  describe 'test method "valid"' do
+    it 'checks if properties are valid' do
+      instance = Freeclimb::TranscribeUtteranceRecord.new(
+          save_recording: true,
+          max_length_sec: 1,
+          rcrd_termination_silence_time_ms: 1,
+      )
+      expect(instance.valid?).to eq(true)
+    end
+    it 'checks if properties are invalid' do
+      instance = Freeclimb::TranscribeUtteranceRecord.new(
+        save_recording: nil,
+      )
+      expect(instance.valid?).to eq(false)
+    end
+    it 'checks if model is empty' do
+      instance = Freeclimb::TranscribeUtteranceRecord.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::TranscribeUtteranceRecord.new(
+          save_recording: true,
+          max_length_sec: 1,
+          rcrd_termination_silence_time_ms: 1,
+      )
+      instance_2 = Freeclimb::TranscribeUtteranceRecord.new(
+          save_recording: true,
+          max_length_sec: 1,
+          rcrd_termination_silence_time_ms: 1,
+      )
+      expect(instance_1.eql?(instance_2)).to eq(true)
+    end
+    it 'checks if objects are not equal' do
+      instance_1 = Freeclimb::TranscribeUtteranceRecord.new(
+          save_recording: true,
+          max_length_sec: 2,
+          rcrd_termination_silence_time_ms: 2,
+      )
+      instance_2 = Freeclimb::TranscribeUtteranceRecord.new(
+          save_recording: false,
+          max_length_sec: 1,
+          rcrd_termination_silence_time_ms: 1,
+      )
+      expect(instance_1.eql?(instance_2)).to eq(false)
+    end
+  end
+
+  describe 'test method "hash"' do
+    it 'calculates hash code' do
+      instance = Freeclimb::TranscribeUtteranceRecord.new(
+      save_recording: true,
+      max_length_sec: 1,
+      rcrd_termination_silence_time_ms: 1,
+    )
+    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::TranscribeUtteranceRecord.new(
+        save_recording: true,
+        max_length_sec: 1,
+        rcrd_termination_silence_time_ms: 1,
+      )
+      instance_2 = Freeclimb::TranscribeUtteranceRecord.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::TranscribeUtteranceRecord.new(
+        save_recording: true,
+        max_length_sec: 1,
+        rcrd_termination_silence_time_ms: 1,
+    )
+    it 'deserializes the data of save_recording' do
+      expect(instance._deserialize("Boolean", instance.save_recording)).to be_a_kind_of(TrueClass)
+    end
+    it 'deserializes the data of max_length_sec' do
+      expect(instance._deserialize("Integer", instance.max_length_sec)).to be_a_kind_of(Integer)
+    end
+    it 'deserializes the data of rcrd_termination_silence_time_ms' do
+      expect(instance._deserialize("Integer", instance.rcrd_termination_silence_time_ms)).to be_a_kind_of(Integer)
+    end
+  end
+
+  describe 'test method "to_s"' do
+    it 'returns the string representation of the object' do
+      instance = Freeclimb::TranscribeUtteranceRecord.new(
+        save_recording: true,
+        max_length_sec: 1,
+        rcrd_termination_silence_time_ms: 1,
+      )
+      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::TranscribeUtteranceRecord.new(
+        save_recording: true,
+        max_length_sec: 1,
+        rcrd_termination_silence_time_ms: 1,
+      )
+      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::TranscribeUtteranceRecord.new(
+        save_recording: true,
+        max_length_sec: 1,
+        rcrd_termination_silence_time_ms: 1,
+      )
+      instance_2 = Freeclimb::TranscribeUtteranceRecord.new(
+        save_recording: true,
+        max_length_sec: 1,
+        rcrd_termination_silence_time_ms: 1,
+      )
+      expect(instance_1.to_hash).to eq(instance_2.to_hash)
+    end
+  end
+
+  describe 'test method "_to_hash"' do
+    instance = Freeclimb::TranscribeUtteranceRecord.new(
+        save_recording: true,
+      
+        max_length_sec: 1,
+      
+        rcrd_termination_silence_time_ms: 1,
+      )
+    it 'returns save_recording in the form of hash' do
+      expect(instance._to_hash(instance.save_recording)).to eq(instance.save_recording)
+    end
+    it 'returns max_length_sec in the form of hash' do
+      expect(instance._to_hash(instance.max_length_sec)).to eq(instance.max_length_sec)
+    end
+    it 'returns rcrd_termination_silence_time_ms in the form of hash' do
+      expect(instance._to_hash(instance.rcrd_termination_silence_time_ms)).to eq(instance.rcrd_termination_silence_time_ms)
+    end
+  end
+
+end