freeclimb 4.4.4 → 4.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c3d184e3a414b40637aae3f456402764dc6dd5fc7c0229cc560592484ccf3c42
-  data.tar.gz: 9bd698bdcde3ae0884b11cede080012c2f3d71a1a322d78fbf38ed0d34cd082f
+  metadata.gz: '049c6713b0d493afd15688755443a96d3f75146187de35bed8d84974582e683f'
+  data.tar.gz: 7e7c8ee7dc4806fe9039e4c291db8c41235a717333ce53c62783c3e19a6bb370
 SHA512:
-  metadata.gz: 628694f4a73f5075284e424d551cd4992ee957960499fb4f515a5a7e351f48b82be9d517a255a886f3b177c4ed51c70076b1eb644cf680f5d4ae558b750951b8
-  data.tar.gz: a1f6735f74f3bce0ea8c1e36d851206ba3498c361ea12163ef92e635d443655c0d959fbfd6ef2db518636c3d82a35ceae2181392828b0d6f1b52fcf8aa3be30a
+  metadata.gz: 2a101994eec9e9194a30a195e760848e78fd0cc3a1f1b78cf7e1133d16a32a124aa95713dc73099cc9a4b1c10ac8f26fd86a835b2fd9181c79bd49ceeff0d721
+  data.tar.gz: 287e20c6220adc27ab06253f5f85d93be35f2af9fd966066e0ef85352dab57c335db24b04e4f2b2397a5e62aff7997905099e8db02280da4eb5d057168415087

data/CHANGELOG.md

@@ -9,6 +9,23 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 None
 
+<a name="4.5.1"></a>
+
+## [4.5.1] - 2023-09-01
+
+### Added
+
+- TranscribeUtterance into a PerCL command
+- MIT License
+
+<a name="4.5.0"></a>
+
+## [4.5.0] - 2023-08-15
+
+### Added
+
+- Transcribe Utterance Feature
+
 <a name="4.4.4"></a>
 
 ## [4.4.4] - 2023-08-24

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    freeclimb (4.4.4)
+    freeclimb (4.5.1)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/LICENSE.txt

@@ -0,0 +1,10 @@
+MIT License
+-------------
+
+Copyright (c) 2023 FreeClimbAPI
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

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.4.4
+- Package version: 4.5.1
 - 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.4.4'
+    gem 'freeclimb', '~> 4.5.1'
 
 and run from your terminal
 
@@ -44,9 +44,9 @@ gem build freeclimb.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./freeclimb-4.4.4.gem
+gem install ./freeclimb-4.5.1.gem
 ```
-(for development, run `gem install --dev ./freeclimb-4.4.4.gem` to install the development dependencies)
+(for development, run `gem install --dev ./freeclimb-4.5.1.gem` to install the development dependencies)
 
 ## Getting Started
 
@@ -286,6 +286,8 @@ Class | Method | HTTP request | Description
  - [Freeclimb::StartRecordCall](docs/StartRecordCall.md)
  - [Freeclimb::TerminateConference](docs/TerminateConference.md)
  - [Freeclimb::TerminateConferenceAllOf](docs/TerminateConferenceAllOf.md)
+ - [Freeclimb::TranscribeUtterance](docs/TranscribeUtterance.md)
+ - [Freeclimb::TranscribeUtteranceRecord](docs/TranscribeUtteranceRecord.md)
  - [Freeclimb::Unpark](docs/Unpark.md)
  - [Freeclimb::UpdateCallRequest](docs/UpdateCallRequest.md)
  - [Freeclimb::UpdateCallRequestStatus](docs/UpdateCallRequestStatus.md)

data/docs/SMSTenDLCCampaign.md

@@ -72,7 +72,7 @@ instance = Freeclimb::SMSTenDLCCampaign.new(
   help_message: null,
   reference_id: null,
   mock: null,
-  next_renewal_or_expiration_date: Fri Dec 31 18:00:00 CST 1999
+  next_renewal_or_expiration_date: Fri Dec 31 19:00:00 EST 1999
 )
 ```
 

data/docs/TranscribeUtterance.md

@@ -0,0 +1,28 @@
+# Freeclimb::TranscribeUtterance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action_url** | **String** |  |  |
+| **play_beep** | **Boolean** |  | [optional][default to false] |
+| **record** | [**TranscribeUtteranceRecord**](TranscribeUtteranceRecord.md) |  | [optional] |
+| **privacy_for_logging** | **Boolean** |  | [optional][default to false] |
+| **privacy_for_recording** | **Boolean** |  | [optional][default to false] |
+| **prompts** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TranscribeUtterance.new(
+  action_url: null,
+  play_beep: null,
+  record: null,
+  privacy_for_logging: null,
+  privacy_for_recording: null,
+  prompts: null
+)
+```
+

data/docs/TranscribeUtteranceRecord.md

@@ -0,0 +1,22 @@
+# Freeclimb::TranscribeUtteranceRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **save_recording** | **Boolean** |  | [optional][default to false] |
+| **max_length_sec** | **Integer** |  | [optional][default to 60] |
+| **rcrd_termination_silence_time_ms** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'freeclimb'
+
+instance = Freeclimb::TranscribeUtteranceRecord.new(
+  save_recording: null,
+  max_length_sec: null,
+  rcrd_termination_silence_time_ms: null
+)
+```
+

data/lib/freeclimb/models/transcribe_utterance.rb

@@ -0,0 +1,299 @@
+=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
+  # The `TranscribeUtterance` command transcribes the caller’s voice and returns transcription of the audio and optionally returns the recording of the audio transcribed.  `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.
+  class TranscribeUtterance < PerclCommand
+    attr_accessor :action_url
+
+    attr_accessor :play_beep
+
+    attr_accessor :record
+
+    attr_accessor :privacy_for_logging
+
+    attr_accessor :privacy_for_recording
+
+    attr_accessor :prompts
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'action_url' => :'actionUrl',
+        :'play_beep' => :'playBeep',
+        :'record' => :'record',
+        :'privacy_for_logging' => :'privacyForLogging',
+        :'privacy_for_recording' => :'privacyForRecording',
+        :'prompts' => :'prompts'
+      }
+    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
+      {
+        :'action_url' => :'String',
+        :'play_beep' => :'Boolean',
+        :'record' => :'TranscribeUtteranceRecord',
+        :'privacy_for_logging' => :'Boolean',
+        :'privacy_for_recording' => :'Boolean',
+        :'prompts' => :'Array<Object>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'PerclCommand'
+      ]
+    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::TranscribeUtterance` 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::TranscribeUtterance`. 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?(:'action_url')
+        self.action_url = attributes[:'action_url']
+      end
+
+      if attributes.key?(:'play_beep')
+        self.play_beep = attributes[:'play_beep']
+      else
+        self.play_beep = false
+      end
+
+      if attributes.key?(:'record')
+        self.record = attributes[:'record']
+      end
+
+      if attributes.key?(:'privacy_for_logging')
+        self.privacy_for_logging = attributes[:'privacy_for_logging']
+      else
+        self.privacy_for_logging = false
+      end
+
+      if attributes.key?(:'privacy_for_recording')
+        self.privacy_for_recording = attributes[:'privacy_for_recording']
+      else
+        self.privacy_for_recording = false
+      end
+
+      if attributes.key?(:'prompts')
+        if (value = attributes[:'prompts']).is_a?(Array)
+          self.prompts = value
+        end
+      end
+      self.command = "TranscribeUtterance"
+    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 @action_url.nil?
+        invalid_properties.push('invalid value for "action_url", action_url cannot be nil.')
+      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 @action_url.nil?
+        false
+      elsif @play_beep.nil?
+        false
+      elsif @record.nil?
+        false
+      elsif @privacy_for_logging.nil?
+        false
+      elsif @privacy_for_recording.nil?
+        false
+      elsif @prompts.nil?
+        false
+      else
+        list_invalid_properties.length() == 0
+      end
+    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 &&
+          action_url == o.action_url &&
+          play_beep == o.play_beep &&
+          record == o.record &&
+          privacy_for_logging == o.privacy_for_logging &&
+          privacy_for_recording == o.privacy_for_recording &&
+          prompts == o.prompts
+    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
+      [action_url, play_beep, record, privacy_for_logging, privacy_for_recording, prompts].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 = super
+      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