ultracart_api 4.1.71 → 4.1.73

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

data/lib/ultracart_api/models/conversation_pbx_queue.rb

@@ -18,6 +18,12 @@ module UltracartClient
     # AI Agent Priority compared to human agents
     attr_accessor :ai_priority
 
+    # If true, AI summaries are generated for answered calls in this queue
+    attr_accessor :ai_summary_enabled
+
+    # Custom instructions injected into the AI summary system prompt for this queue
+    attr_accessor :ai_summary_instructions
+
     # AI timeout seconds
     attr_accessor :ai_timeout_seconds
 
@@ -122,6 +128,12 @@ module UltracartClient
     # Wrap up time in seconds
     attr_accessor :wrap_up_seconds
 
+    # Zoho Desk department ID to create tickets in
+    attr_accessor :zoho_desk_department_id
+
+    # If true, a Zoho Desk ticket is automatically created for answered calls in this queue
+    attr_accessor :zoho_desk_ticket_enabled
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -148,6 +160,8 @@ module UltracartClient
     def self.attribute_map
       {
         :'ai_priority' => :'ai_priority',
+        :'ai_summary_enabled' => :'ai_summary_enabled',
+        :'ai_summary_instructions' => :'ai_summary_instructions',
         :'ai_timeout_seconds' => :'ai_timeout_seconds',
         :'announce_queue_position' => :'announce_queue_position',
         :'automatic_coach_agent_uuid' => :'automatic_coach_agent_uuid',
@@ -182,7 +196,9 @@ module UltracartClient
         :'voicemail' => :'voicemail',
         :'wait_critical_seconds' => :'wait_critical_seconds',
         :'wait_warning_seconds' => :'wait_warning_seconds',
-        :'wrap_up_seconds' => :'wrap_up_seconds'
+        :'wrap_up_seconds' => :'wrap_up_seconds',
+        :'zoho_desk_department_id' => :'zoho_desk_department_id',
+        :'zoho_desk_ticket_enabled' => :'zoho_desk_ticket_enabled'
       }
     end
 
@@ -195,6 +211,8 @@ module UltracartClient
     def self.openapi_types
       {
         :'ai_priority' => :'String',
+        :'ai_summary_enabled' => :'Boolean',
+        :'ai_summary_instructions' => :'String',
         :'ai_timeout_seconds' => :'Integer',
         :'announce_queue_position' => :'Boolean',
         :'automatic_coach_agent_uuid' => :'String',
@@ -229,7 +247,9 @@ module UltracartClient
         :'voicemail' => :'Boolean',
         :'wait_critical_seconds' => :'Integer',
         :'wait_warning_seconds' => :'Integer',
-        :'wrap_up_seconds' => :'Integer'
+        :'wrap_up_seconds' => :'Integer',
+        :'zoho_desk_department_id' => :'String',
+        :'zoho_desk_ticket_enabled' => :'Boolean'
       }
     end
 
@@ -258,6 +278,14 @@ module UltracartClient
         self.ai_priority = attributes[:'ai_priority']
       end
 
+      if attributes.key?(:'ai_summary_enabled')
+        self.ai_summary_enabled = attributes[:'ai_summary_enabled']
+      end
+
+      if attributes.key?(:'ai_summary_instructions')
+        self.ai_summary_instructions = attributes[:'ai_summary_instructions']
+      end
+
       if attributes.key?(:'ai_timeout_seconds')
         self.ai_timeout_seconds = attributes[:'ai_timeout_seconds']
       end
@@ -397,12 +425,24 @@ module UltracartClient
       if attributes.key?(:'wrap_up_seconds')
         self.wrap_up_seconds = attributes[:'wrap_up_seconds']
       end
+
+      if attributes.key?(:'zoho_desk_department_id')
+        self.zoho_desk_department_id = attributes[:'zoho_desk_department_id']
+      end
+
+      if attributes.key?(:'zoho_desk_ticket_enabled')
+        self.zoho_desk_ticket_enabled = attributes[:'zoho_desk_ticket_enabled']
+      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 !@ai_summary_instructions.nil? && @ai_summary_instructions.to_s.length > 100000
+        invalid_properties.push('invalid value for "ai_summary_instructions", the character length must be smaller than or equal to 100000.')
+      end
+
       if !@callback_announce_audio_uuid.nil? && @callback_announce_audio_uuid.to_s.length > 50
         invalid_properties.push('invalid value for "callback_announce_audio_uuid", the character length must be smaller than or equal to 50.')
       end
@@ -451,6 +491,10 @@ module UltracartClient
         invalid_properties.push('invalid value for "twilio_workspace_queue_sid", the character length must be smaller than or equal to 50.')
       end
 
+      if !@zoho_desk_department_id.nil? && @zoho_desk_department_id.to_s.length > 50
+        invalid_properties.push('invalid value for "zoho_desk_department_id", the character length must be smaller than or equal to 50.')
+      end
+
       invalid_properties
     end
 
@@ -459,6 +503,7 @@ module UltracartClient
     def valid?
       ai_priority_validator = EnumAttributeValidator.new('String', ["neutral", "first", "backup"])
       return false unless ai_priority_validator.valid?(@ai_priority)
+      return false if !@ai_summary_instructions.nil? && @ai_summary_instructions.to_s.length > 100000
       return false if !@callback_announce_audio_uuid.nil? && @callback_announce_audio_uuid.to_s.length > 50
       return false if !@callback_confirm_audio_uuid.nil? && @callback_confirm_audio_uuid.to_s.length > 50
       return false if !@conversation_voicemail_mailbox_uuid.nil? && @conversation_voicemail_mailbox_uuid.to_s.length > 50
@@ -475,6 +520,7 @@ module UltracartClient
       return false if !@say_voice.nil? && @say_voice.to_s.length > 50
       return false if !@twilio_taskrouter_workflow_sid.nil? && @twilio_taskrouter_workflow_sid.to_s.length > 100
       return false if !@twilio_workspace_queue_sid.nil? && @twilio_workspace_queue_sid.to_s.length > 50
+      return false if !@zoho_desk_department_id.nil? && @zoho_desk_department_id.to_s.length > 50
       true
     end
 
@@ -488,6 +534,16 @@ module UltracartClient
       @ai_priority = ai_priority
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] ai_summary_instructions Value to be assigned
+    def ai_summary_instructions=(ai_summary_instructions)
+      if !ai_summary_instructions.nil? && ai_summary_instructions.to_s.length > 100000
+        fail ArgumentError, 'invalid value for "ai_summary_instructions", the character length must be smaller than or equal to 100000.'
+      end
+
+      @ai_summary_instructions = ai_summary_instructions
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] callback_announce_audio_uuid Value to be assigned
     def callback_announce_audio_uuid=(callback_announce_audio_uuid)
@@ -608,12 +664,24 @@ module UltracartClient
       @twilio_workspace_queue_sid = twilio_workspace_queue_sid
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] zoho_desk_department_id Value to be assigned
+    def zoho_desk_department_id=(zoho_desk_department_id)
+      if !zoho_desk_department_id.nil? && zoho_desk_department_id.to_s.length > 50
+        fail ArgumentError, 'invalid value for "zoho_desk_department_id", the character length must be smaller than or equal to 50.'
+      end
+
+      @zoho_desk_department_id = zoho_desk_department_id
+    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 &&
           ai_priority == o.ai_priority &&
+          ai_summary_enabled == o.ai_summary_enabled &&
+          ai_summary_instructions == o.ai_summary_instructions &&
           ai_timeout_seconds == o.ai_timeout_seconds &&
           announce_queue_position == o.announce_queue_position &&
           automatic_coach_agent_uuid == o.automatic_coach_agent_uuid &&
@@ -648,7 +716,9 @@ module UltracartClient
           voicemail == o.voicemail &&
           wait_critical_seconds == o.wait_critical_seconds &&
           wait_warning_seconds == o.wait_warning_seconds &&
-          wrap_up_seconds == o.wrap_up_seconds
+          wrap_up_seconds == o.wrap_up_seconds &&
+          zoho_desk_department_id == o.zoho_desk_department_id &&
+          zoho_desk_ticket_enabled == o.zoho_desk_ticket_enabled
     end
 
     # @see the `==` method
@@ -660,7 +730,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [ai_priority, ai_timeout_seconds, announce_queue_position, automatic_coach_agent_uuid, callback_announce_audio_uuid, callback_announce_say, callback_confirm_audio_uuid, callback_confirm_say, callback_enabled, callback_hours_only, callback_max_attempts, callback_max_offers, callback_max_pending, callback_offer_after_seconds, callback_offer_interval_seconds, callback_retry_delay_seconds, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail, wait_critical_seconds, wait_warning_seconds, wrap_up_seconds].hash
+      [ai_priority, ai_summary_enabled, ai_summary_instructions, ai_timeout_seconds, announce_queue_position, automatic_coach_agent_uuid, callback_announce_audio_uuid, callback_announce_say, callback_confirm_audio_uuid, callback_confirm_say, callback_enabled, callback_hours_only, callback_max_attempts, callback_max_offers, callback_max_pending, callback_offer_after_seconds, callback_offer_interval_seconds, callback_retry_delay_seconds, conversation_pbx_queue_uuid, conversation_voicemail_mailbox_uuid, hold_conversation_pbx_audio_uuid, max_hold_seconds, members, merchant_id, name, no_agent_available_play_audio_uuid, no_agent_available_say, no_agent_available_say_voice, play_audio_uuid, record_call, say, say_voice, twilio_taskrouter_workflow_sid, twilio_workspace_queue_sid, voicemail, wait_critical_seconds, wait_warning_seconds, wrap_up_seconds, zoho_desk_department_id, zoho_desk_ticket_enabled].hash
     end
 
     # Builds the object from hash