ultracart_api 4.1.51 → 4.1.54

data/lib/ultracart_api/models/conversation_pbx_call_ai_engagement.rb

@@ -0,0 +1,347 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationPbxCallAiEngagement
+    # Display name of the AI agent
+    attr_accessor :agent_name
+
+    # UUID of the AI agent configuration used
+    attr_accessor :agent_uuid
+
+    attr_accessor :cost
+
+    # Timestamp when the AI engagement ended
+    attr_accessor :ended_at_dts
+
+    # Type of AI engagement
+    attr_accessor :engagement_type
+
+    # Unique identifier for this AI engagement session
+    attr_accessor :session_uuid
+
+    # Timestamp when the AI engagement started
+    attr_accessor :started_at_dts
+
+    # Status of the AI engagement
+    attr_accessor :status
+
+    # List of tool calls made by the AI agent during this engagement
+    attr_accessor :tool_calls
+
+    # List of coaching whispers sent during this engagement
+    attr_accessor :whispers
+
+    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
+      {
+        :'agent_name' => :'agent_name',
+        :'agent_uuid' => :'agent_uuid',
+        :'cost' => :'cost',
+        :'ended_at_dts' => :'ended_at_dts',
+        :'engagement_type' => :'engagement_type',
+        :'session_uuid' => :'session_uuid',
+        :'started_at_dts' => :'started_at_dts',
+        :'status' => :'status',
+        :'tool_calls' => :'tool_calls',
+        :'whispers' => :'whispers'
+      }
+    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
+      {
+        :'agent_name' => :'String',
+        :'agent_uuid' => :'String',
+        :'cost' => :'ConversationPbxCallAiCost',
+        :'ended_at_dts' => :'String',
+        :'engagement_type' => :'String',
+        :'session_uuid' => :'String',
+        :'started_at_dts' => :'String',
+        :'status' => :'String',
+        :'tool_calls' => :'Array<ConversationPbxCallAiToolCall>',
+        :'whispers' => :'Array<ConversationPbxCallAiWhisper>'
+      }
+    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 `UltracartClient::ConversationPbxCallAiEngagement` 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 `UltracartClient::ConversationPbxCallAiEngagement`. 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?(:'agent_name')
+        self.agent_name = attributes[:'agent_name']
+      end
+
+      if attributes.key?(:'agent_uuid')
+        self.agent_uuid = attributes[:'agent_uuid']
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'ended_at_dts')
+        self.ended_at_dts = attributes[:'ended_at_dts']
+      end
+
+      if attributes.key?(:'engagement_type')
+        self.engagement_type = attributes[:'engagement_type']
+      end
+
+      if attributes.key?(:'session_uuid')
+        self.session_uuid = attributes[:'session_uuid']
+      end
+
+      if attributes.key?(:'started_at_dts')
+        self.started_at_dts = attributes[:'started_at_dts']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'tool_calls')
+        if (value = attributes[:'tool_calls']).is_a?(Array)
+          self.tool_calls = value
+        end
+      end
+
+      if attributes.key?(:'whispers')
+        if (value = attributes[:'whispers']).is_a?(Array)
+          self.whispers = value
+        end
+      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
+      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?
+      engagement_type_validator = EnumAttributeValidator.new('String', ["ai_agent", "ai_coach"])
+      return false unless engagement_type_validator.valid?(@engagement_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] engagement_type Object to be assigned
+    def engagement_type=(engagement_type)
+      validator = EnumAttributeValidator.new('String', ["ai_agent", "ai_coach"])
+      unless validator.valid?(engagement_type)
+        fail ArgumentError, "invalid value for \"engagement_type\", must be one of #{validator.allowable_values}."
+      end
+      @engagement_type = engagement_type
+    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 &&
+          agent_name == o.agent_name &&
+          agent_uuid == o.agent_uuid &&
+          cost == o.cost &&
+          ended_at_dts == o.ended_at_dts &&
+          engagement_type == o.engagement_type &&
+          session_uuid == o.session_uuid &&
+          started_at_dts == o.started_at_dts &&
+          status == o.status &&
+          tool_calls == o.tool_calls &&
+          whispers == o.whispers
+    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
+      [agent_name, agent_uuid, cost, ended_at_dts, engagement_type, session_uuid, started_at_dts, status, tool_calls, whispers].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = UltracartClient.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/ultracart_api/models/conversation_pbx_call_ai_tool_call.rb

@@ -0,0 +1,300 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class ConversationPbxCallAiToolCall
+    # Timestamp when the tool was called
+    attr_accessor :called_at_dts
+
+    # Timestamp when the tool call completed
+    attr_accessor :completed_at_dts
+
+    # Duration of the tool call in milliseconds
+    attr_accessor :duration_ms
+
+    # Error message if the tool call failed
+    attr_accessor :error_message
+
+    # Parameters passed to the tool (structure varies by tool)
+    attr_accessor :parameters
+
+    # Result returned by the tool (structure varies by tool)
+    attr_accessor :result
+
+    # Whether the tool call succeeded
+    attr_accessor :success
+
+    # Unique identifier for this tool call
+    attr_accessor :tool_call_uuid
+
+    # Name of the tool that was called
+    attr_accessor :tool_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'called_at_dts' => :'called_at_dts',
+        :'completed_at_dts' => :'completed_at_dts',
+        :'duration_ms' => :'duration_ms',
+        :'error_message' => :'error_message',
+        :'parameters' => :'parameters',
+        :'result' => :'result',
+        :'success' => :'success',
+        :'tool_call_uuid' => :'tool_call_uuid',
+        :'tool_name' => :'tool_name'
+      }
+    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
+      {
+        :'called_at_dts' => :'String',
+        :'completed_at_dts' => :'String',
+        :'duration_ms' => :'Integer',
+        :'error_message' => :'String',
+        :'parameters' => :'Object',
+        :'result' => :'Object',
+        :'success' => :'Boolean',
+        :'tool_call_uuid' => :'String',
+        :'tool_name' => :'String'
+      }
+    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 `UltracartClient::ConversationPbxCallAiToolCall` 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 `UltracartClient::ConversationPbxCallAiToolCall`. 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?(:'called_at_dts')
+        self.called_at_dts = attributes[:'called_at_dts']
+      end
+
+      if attributes.key?(:'completed_at_dts')
+        self.completed_at_dts = attributes[:'completed_at_dts']
+      end
+
+      if attributes.key?(:'duration_ms')
+        self.duration_ms = attributes[:'duration_ms']
+      end
+
+      if attributes.key?(:'error_message')
+        self.error_message = attributes[:'error_message']
+      end
+
+      if attributes.key?(:'parameters')
+        self.parameters = attributes[:'parameters']
+      end
+
+      if attributes.key?(:'result')
+        self.result = attributes[:'result']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'tool_call_uuid')
+        self.tool_call_uuid = attributes[:'tool_call_uuid']
+      end
+
+      if attributes.key?(:'tool_name')
+        self.tool_name = attributes[:'tool_name']
+      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
+      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?
+      true
+    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 &&
+          called_at_dts == o.called_at_dts &&
+          completed_at_dts == o.completed_at_dts &&
+          duration_ms == o.duration_ms &&
+          error_message == o.error_message &&
+          parameters == o.parameters &&
+          result == o.result &&
+          success == o.success &&
+          tool_call_uuid == o.tool_call_uuid &&
+          tool_name == o.tool_name
+    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
+      [called_at_dts, completed_at_dts, duration_ms, error_message, parameters, result, success, tool_call_uuid, tool_name].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      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 = UltracartClient.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