ultracart_api 4.1.72 → 4.1.74

data/lib/ultracart_api/models/conversation_pbx_call.rb

@@ -24,6 +24,8 @@ module UltracartClient
     # List of AI agent engagements during the call
     attr_accessor :ai_agent_engagements
 
+    attr_accessor :ai_summary
+
     # Twilio call SID for the primary (customer) call leg
     attr_accessor :call_sid
 
@@ -77,12 +79,19 @@ module UltracartClient
     # Timestamp when the call record was last updated
     attr_accessor :updated_at_dts
 
+    # Zoho Desk ticket ID if a ticket was created for this call
+    attr_accessor :zoho_desk_ticket_id
+
+    # URL to the Zoho Desk ticket if a ticket was created for this call
+    attr_accessor :zoho_desk_ticket_url
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'account_sid' => :'account_sid',
         :'agents' => :'agents',
         :'ai_agent_engagements' => :'ai_agent_engagements',
+        :'ai_summary' => :'ai_summary',
         :'call_sid' => :'call_sid',
         :'call_uuid' => :'call_uuid',
         :'caller' => :'caller',
@@ -101,7 +110,9 @@ module UltracartClient
         :'status' => :'status',
         :'timeline' => :'timeline',
         :'transfers' => :'transfers',
-        :'updated_at_dts' => :'updated_at_dts'
+        :'updated_at_dts' => :'updated_at_dts',
+        :'zoho_desk_ticket_id' => :'zoho_desk_ticket_id',
+        :'zoho_desk_ticket_url' => :'zoho_desk_ticket_url'
       }
     end
 
@@ -116,6 +127,7 @@ module UltracartClient
         :'account_sid' => :'String',
         :'agents' => :'Array<ConversationPbxCallAgent>',
         :'ai_agent_engagements' => :'Array<ConversationPbxCallAiEngagement>',
+        :'ai_summary' => :'ConversationPbxCallAiSummary',
         :'call_sid' => :'String',
         :'call_uuid' => :'String',
         :'caller' => :'ConversationPbxCallCaller',
@@ -134,7 +146,9 @@ module UltracartClient
         :'status' => :'String',
         :'timeline' => :'ConversationPbxCallTimeline',
         :'transfers' => :'Array<ConversationPbxCallTransfer>',
-        :'updated_at_dts' => :'String'
+        :'updated_at_dts' => :'String',
+        :'zoho_desk_ticket_id' => :'String',
+        :'zoho_desk_ticket_url' => :'String'
       }
     end
 
@@ -175,6 +189,10 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'ai_summary')
+        self.ai_summary = attributes[:'ai_summary']
+      end
+
       if attributes.key?(:'call_sid')
         self.call_sid = attributes[:'call_sid']
       end
@@ -258,6 +276,14 @@ module UltracartClient
       if attributes.key?(:'updated_at_dts')
         self.updated_at_dts = attributes[:'updated_at_dts']
       end
+
+      if attributes.key?(:'zoho_desk_ticket_id')
+        self.zoho_desk_ticket_id = attributes[:'zoho_desk_ticket_id']
+      end
+
+      if attributes.key?(:'zoho_desk_ticket_url')
+        self.zoho_desk_ticket_url = attributes[:'zoho_desk_ticket_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -281,6 +307,7 @@ module UltracartClient
           account_sid == o.account_sid &&
           agents == o.agents &&
           ai_agent_engagements == o.ai_agent_engagements &&
+          ai_summary == o.ai_summary &&
           call_sid == o.call_sid &&
           call_uuid == o.call_uuid &&
           caller == o.caller &&
@@ -299,7 +326,9 @@ module UltracartClient
           status == o.status &&
           timeline == o.timeline &&
           transfers == o.transfers &&
-          updated_at_dts == o.updated_at_dts
+          updated_at_dts == o.updated_at_dts &&
+          zoho_desk_ticket_id == o.zoho_desk_ticket_id &&
+          zoho_desk_ticket_url == o.zoho_desk_ticket_url
     end
 
     # @see the `==` method
@@ -311,7 +340,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [account_sid, agents, ai_agent_engagements, call_sid, call_uuid, caller, conference_sid, created_at_dts, customer_name, customer_profile_oid, disposition, email, financial, holds, merchant_id, recording_sids, recordings, routing, status, timeline, transfers, updated_at_dts].hash
+      [account_sid, agents, ai_agent_engagements, ai_summary, call_sid, call_uuid, caller, conference_sid, created_at_dts, customer_name, customer_profile_oid, disposition, email, financial, holds, merchant_id, recording_sids, recordings, routing, status, timeline, transfers, updated_at_dts, zoho_desk_ticket_id, zoho_desk_ticket_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_pbx_call_ai_summary.rb

@@ -0,0 +1,358 @@
+=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 ConversationPbxCallAiSummary
+    # Action items identified during the call
+    attr_accessor :action_items
+
+    # Category of the call (e.g. support, sales, billing)
+    attr_accessor :call_category
+
+    # Number of output tokens used to generate the summary
+    attr_accessor :completion_tokens
+
+    # Cost of generating the summary in the specified currency
+    attr_accessor :cost
+
+    # Currency code for the summary cost (always USD)
+    attr_accessor :cost_currency
+
+    # Timestamp when the summary was generated
+    attr_accessor :generated_at_dts
+
+    # Key topics discussed during the call
+    attr_accessor :key_topics
+
+    # AI model used to generate the summary (e.g. grok-4.1-fast)
+    attr_accessor :model
+
+    # Number of input tokens used to generate the summary
+    attr_accessor :prompt_tokens
+
+    # Overall sentiment of the call
+    attr_accessor :sentiment
+
+    # 2-3 sentence synopsis of the call
+    attr_accessor :summary
+
+    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
+      {
+        :'action_items' => :'action_items',
+        :'call_category' => :'call_category',
+        :'completion_tokens' => :'completion_tokens',
+        :'cost' => :'cost',
+        :'cost_currency' => :'cost_currency',
+        :'generated_at_dts' => :'generated_at_dts',
+        :'key_topics' => :'key_topics',
+        :'model' => :'model',
+        :'prompt_tokens' => :'prompt_tokens',
+        :'sentiment' => :'sentiment',
+        :'summary' => :'summary'
+      }
+    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_items' => :'Array<String>',
+        :'call_category' => :'String',
+        :'completion_tokens' => :'Integer',
+        :'cost' => :'Float',
+        :'cost_currency' => :'String',
+        :'generated_at_dts' => :'String',
+        :'key_topics' => :'Array<String>',
+        :'model' => :'String',
+        :'prompt_tokens' => :'Integer',
+        :'sentiment' => :'String',
+        :'summary' => :'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::ConversationPbxCallAiSummary` 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::ConversationPbxCallAiSummary`. 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_items')
+        if (value = attributes[:'action_items']).is_a?(Array)
+          self.action_items = value
+        end
+      end
+
+      if attributes.key?(:'call_category')
+        self.call_category = attributes[:'call_category']
+      end
+
+      if attributes.key?(:'completion_tokens')
+        self.completion_tokens = attributes[:'completion_tokens']
+      end
+
+      if attributes.key?(:'cost')
+        self.cost = attributes[:'cost']
+      end
+
+      if attributes.key?(:'cost_currency')
+        self.cost_currency = attributes[:'cost_currency']
+      end
+
+      if attributes.key?(:'generated_at_dts')
+        self.generated_at_dts = attributes[:'generated_at_dts']
+      end
+
+      if attributes.key?(:'key_topics')
+        if (value = attributes[:'key_topics']).is_a?(Array)
+          self.key_topics = value
+        end
+      end
+
+      if attributes.key?(:'model')
+        self.model = attributes[:'model']
+      end
+
+      if attributes.key?(:'prompt_tokens')
+        self.prompt_tokens = attributes[:'prompt_tokens']
+      end
+
+      if attributes.key?(:'sentiment')
+        self.sentiment = attributes[:'sentiment']
+      end
+
+      if attributes.key?(:'summary')
+        self.summary = attributes[:'summary']
+      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?
+      sentiment_validator = EnumAttributeValidator.new('String', ["positive", "neutral", "negative"])
+      return false unless sentiment_validator.valid?(@sentiment)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sentiment Object to be assigned
+    def sentiment=(sentiment)
+      validator = EnumAttributeValidator.new('String', ["positive", "neutral", "negative"])
+      unless validator.valid?(sentiment)
+        fail ArgumentError, "invalid value for \"sentiment\", must be one of #{validator.allowable_values}."
+      end
+      @sentiment = sentiment
+    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_items == o.action_items &&
+          call_category == o.call_category &&
+          completion_tokens == o.completion_tokens &&
+          cost == o.cost &&
+          cost_currency == o.cost_currency &&
+          generated_at_dts == o.generated_at_dts &&
+          key_topics == o.key_topics &&
+          model == o.model &&
+          prompt_tokens == o.prompt_tokens &&
+          sentiment == o.sentiment &&
+          summary == o.summary
+    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_items, call_category, completion_tokens, cost, cost_currency, generated_at_dts, key_topics, model, prompt_tokens, sentiment, summary].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_financial.rb

@@ -24,6 +24,9 @@ module UltracartClient
     # Currency for AI agent cost
     attr_accessor :ai_agent_cost_currency
 
+    # AI summary generation cost (LLM call made by pbx-transcript-formatter after the call ends)
+    attr_accessor :ai_summary_cost
+
     # Currency for call price (default USD)
     attr_accessor :call_currency
 
@@ -42,6 +45,7 @@ module UltracartClient
         :'ai_agent_billed_minutes' => :'ai_agent_billed_minutes',
         :'ai_agent_cost' => :'ai_agent_cost',
         :'ai_agent_cost_currency' => :'ai_agent_cost_currency',
+        :'ai_summary_cost' => :'ai_summary_cost',
         :'call_currency' => :'call_currency',
         :'call_price' => :'call_price',
         :'call_price_estimated' => :'call_price_estimated',
@@ -60,6 +64,7 @@ module UltracartClient
         :'ai_agent_billed_minutes' => :'Float',
         :'ai_agent_cost' => :'Float',
         :'ai_agent_cost_currency' => :'String',
+        :'ai_summary_cost' => :'Float',
         :'call_currency' => :'String',
         :'call_price' => :'Float',
         :'call_price_estimated' => :'Boolean',
@@ -100,6 +105,10 @@ module UltracartClient
         self.ai_agent_cost_currency = attributes[:'ai_agent_cost_currency']
       end
 
+      if attributes.key?(:'ai_summary_cost')
+        self.ai_summary_cost = attributes[:'ai_summary_cost']
+      end
+
       if attributes.key?(:'call_currency')
         self.call_currency = attributes[:'call_currency']
       end
@@ -138,6 +147,7 @@ module UltracartClient
           ai_agent_billed_minutes == o.ai_agent_billed_minutes &&
           ai_agent_cost == o.ai_agent_cost &&
           ai_agent_cost_currency == o.ai_agent_cost_currency &&
+          ai_summary_cost == o.ai_summary_cost &&
           call_currency == o.call_currency &&
           call_price == o.call_price &&
           call_price_estimated == o.call_price_estimated &&
@@ -153,7 +163,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ai_agent_billed_minutes, ai_agent_cost, ai_agent_cost_currency, call_currency, call_price, call_price_estimated, transcription_cost].hash
+      [ai_agent_billed_minutes, ai_agent_cost, ai_agent_cost_currency, ai_summary_cost, call_currency, call_price, call_price_estimated, transcription_cost].hash
     end
 
     # Builds the object from hash