freeclimb 4.9.0 → 5.0.0

data/lib/freeclimb/models/get_speech_webhook.rb

@@ -0,0 +1,423 @@
+=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: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Freeclimb
+  # The GetSpeech command has completed and its actionUrl is being invoked. A PerCL response is expected, unless reason is hangup.
+  class GetSpeechWebhook < Webhook
+    def self.deserialize(payload)
+      return nil if payload.nil? || payload.empty?
+      data = JSON.parse("[#{payload}]")[0]
+      inverted_attributes = self.attribute_map.invert
+      hash = self.acceptable_attributes.uniq.map { |k| [inverted_attributes[k], data[k.to_s]] }.to_h
+      GetSpeechWebhook.new(hash)
+    end
+    # Context or reason why this request is being made. Will be getSpeech - The GetSpeech command has completed and its actionUrl is being invoked.
+    attr_accessor :request_type
+
+    # Unique ID for this Call, generated by FreeClimb.
+    attr_accessor :call_id
+
+    # Account ID associated with your account.
+    attr_accessor :account_id
+
+    # Phone number of the party that initiated the Call (in E.164 format).
+    attr_accessor :from
+
+    # Phone number provisioned to you and to which this Call is directed (in E.164 format).
+    attr_accessor :to
+
+    attr_accessor :call_status
+
+    attr_accessor :direction
+
+    # Unique ID of the Conference.
+    attr_accessor :conference_id
+
+    # This is only populated if the request pertains to a Queue. Otherwise, it is set to null.
+    attr_accessor :queue_id
+
+    attr_accessor :reason
+
+    # Semantic content (either a string if speech was recognized or a digit if a digit was input instead of speech) returned from the entry or tag that was recognized within the grammar. The content will be replaced by 'xxxxx' when privacyMode is set to true. This field is populated only if the reason field is set to recognition or digit.
+    attr_accessor :recognition_result
+
+    # Level of confidence in the obtained result. This is a value in the range 0 to 100 – with 0 being total lack of confidence and 100 being absolute certainty in the recognition. This field is populated only if the reason field is set to recognition.
+    attr_accessor :confidence
+
+    # ID of the Call that created this leg (child call).
+    attr_accessor :parent_call_id
+
+    # Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.12 - speech recognition.
+    attr_accessor :completion_reason
+
+    # Advanced diagnostic information if reason was error. See RFC 6787 section 9.4.11 - speech recognition.
+    attr_accessor :completion_cause
+
+    # Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification.
+    attr_accessor :mrcp_code
+
+    # Advanced diagnostic information if reason was error. See RFC 6787 section 5.4 - MRCPv2 specification.
+    attr_accessor :mrcp_diagnostic
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'request_type' => :'requestType',
+        :'call_id' => :'callId',
+        :'account_id' => :'accountId',
+        :'from' => :'from',
+        :'to' => :'to',
+        :'call_status' => :'callStatus',
+        :'direction' => :'direction',
+        :'conference_id' => :'conferenceId',
+        :'queue_id' => :'queueId',
+        :'reason' => :'reason',
+        :'recognition_result' => :'recognitionResult',
+        :'confidence' => :'confidence',
+        :'parent_call_id' => :'parentCallId',
+        :'completion_reason' => :'completionReason',
+        :'completion_cause' => :'completionCause',
+        :'mrcp_code' => :'mrcpCode',
+        :'mrcp_diagnostic' => :'mrcpDiagnostic'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about, including the ones defined in its parent(s)
+    def self.acceptable_attributes
+      attribute_map.values.concat(superclass.acceptable_attributes)
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'request_type' => :'String',
+        :'call_id' => :'String',
+        :'account_id' => :'String',
+        :'from' => :'String',
+        :'to' => :'String',
+        :'call_status' => :'CallStatus',
+        :'direction' => :'CallDirection',
+        :'conference_id' => :'String',
+        :'queue_id' => :'String',
+        :'reason' => :'GetSpeechReason',
+        :'recognition_result' => :'String',
+        :'confidence' => :'Integer',
+        :'parent_call_id' => :'String',
+        :'completion_reason' => :'String',
+        :'completion_cause' => :'String',
+        :'mrcp_code' => :'Integer',
+        :'mrcp_diagnostic' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'call_status',
+        :'direction',
+        :'queue_id',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'Webhook'
+      ]
+    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::GetSpeechWebhook` 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::GetSpeechWebhook`. 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
+      }
+
+      # call parent's initialize
+      super(attributes)
+
+      if attributes.key?(:'request_type')
+        self.request_type = attributes[:'request_type']
+      end
+
+      if attributes.key?(:'call_id')
+        self.call_id = attributes[:'call_id']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'from')
+        self.from = attributes[:'from']
+      end
+
+      if attributes.key?(:'to')
+        self.to = attributes[:'to']
+      end
+
+      if attributes.key?(:'call_status')
+        self.call_status = attributes[:'call_status']
+      end
+
+      if attributes.key?(:'direction')
+        self.direction = attributes[:'direction']
+      end
+
+      if attributes.key?(:'conference_id')
+        self.conference_id = attributes[:'conference_id']
+      end
+
+      if attributes.key?(:'queue_id')
+        self.queue_id = attributes[:'queue_id']
+      end
+
+      if attributes.key?(:'reason')
+        self.reason = attributes[:'reason']
+      end
+
+      if attributes.key?(:'recognition_result')
+        self.recognition_result = attributes[:'recognition_result']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'parent_call_id')
+        self.parent_call_id = attributes[:'parent_call_id']
+      end
+
+      if attributes.key?(:'completion_reason')
+        self.completion_reason = attributes[:'completion_reason']
+      end
+
+      if attributes.key?(:'completion_cause')
+        self.completion_cause = attributes[:'completion_cause']
+      end
+
+      if attributes.key?(:'mrcp_code')
+        self.mrcp_code = attributes[:'mrcp_code']
+      end
+
+      if attributes.key?(:'mrcp_diagnostic')
+        self.mrcp_diagnostic = attributes[:'mrcp_diagnostic']
+      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 = super
+      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 @request_type.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 &&
+          request_type == o.request_type &&
+          call_id == o.call_id &&
+          account_id == o.account_id &&
+          from == o.from &&
+          to == o.to &&
+          call_status == o.call_status &&
+          direction == o.direction &&
+          conference_id == o.conference_id &&
+          queue_id == o.queue_id &&
+          reason == o.reason &&
+          recognition_result == o.recognition_result &&
+          confidence == o.confidence &&
+          parent_call_id == o.parent_call_id &&
+          completion_reason == o.completion_reason &&
+          completion_cause == o.completion_cause &&
+          mrcp_code == o.mrcp_code &&
+          mrcp_diagnostic == o.mrcp_diagnostic && super(o)
+    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
+      [request_type, call_id, account_id, from, to, call_status, direction, conference_id, queue_id, reason, recognition_result, confidence, parent_call_id, completion_reason, completion_cause, mrcp_code, mrcp_diagnostic].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)
+      super(attributes)
+      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

data/lib/freeclimb/models/grammar_file_built_in.rb

@@ -6,7 +6,7 @@
 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
+OpenAPI Generator version: 7.9.0
 
 =end
 

data/lib/freeclimb/models/grammar_type.rb

@@ -6,7 +6,7 @@
 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
+OpenAPI Generator version: 7.9.0
 
 =end
 

data/lib/freeclimb/models/hangup.rb

@@ -6,7 +6,7 @@
 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
+OpenAPI Generator version: 7.9.0
 
 =end
 
@@ -47,7 +47,6 @@ module Freeclimb
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'HangupAllOf',
       :'PerclCommand'
       ]
     end
@@ -232,7 +231,5 @@ module Freeclimb
         value
       end
     end
-
   end
-
 end

data/lib/freeclimb/models/if_machine.rb

@@ -6,7 +6,7 @@
 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
+OpenAPI Generator version: 7.9.0
 
 =end