ultracart_api 4.1.51 → 4.1.54

data/lib/ultracart_api/models/conversation_pbx_call_transcript_segment.rb

@@ -0,0 +1,314 @@
+=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 ConversationPbxCallTranscriptSegment
+    # Agent ID if speaker is an agent
+    attr_accessor :agent_id
+
+    # Audio channel identifier (e.g. ch_0, ch_1)
+    attr_accessor :channel
+
+    # Transcription confidence score (0-1)
+    attr_accessor :confidence
+
+    # End time in seconds from beginning of recording
+    attr_accessor :end_time
+
+    # Speaker role
+    attr_accessor :speaker
+
+    # Start time in seconds from beginning of recording
+    attr_accessor :start_time
+
+    # Transcribed text for this segment
+    attr_accessor :text
+
+    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_id' => :'agent_id',
+        :'channel' => :'channel',
+        :'confidence' => :'confidence',
+        :'end_time' => :'end_time',
+        :'speaker' => :'speaker',
+        :'start_time' => :'start_time',
+        :'text' => :'text'
+      }
+    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_id' => :'String',
+        :'channel' => :'String',
+        :'confidence' => :'Float',
+        :'end_time' => :'Float',
+        :'speaker' => :'String',
+        :'start_time' => :'Float',
+        :'text' => :'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::ConversationPbxCallTranscriptSegment` 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::ConversationPbxCallTranscriptSegment`. 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_id')
+        self.agent_id = attributes[:'agent_id']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'confidence')
+        self.confidence = attributes[:'confidence']
+      end
+
+      if attributes.key?(:'end_time')
+        self.end_time = attributes[:'end_time']
+      end
+
+      if attributes.key?(:'speaker')
+        self.speaker = attributes[:'speaker']
+      end
+
+      if attributes.key?(:'start_time')
+        self.start_time = attributes[:'start_time']
+      end
+
+      if attributes.key?(:'text')
+        self.text = attributes[:'text']
+      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?
+      speaker_validator = EnumAttributeValidator.new('String', ["customer", " agent"])
+      return false unless speaker_validator.valid?(@speaker)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] speaker Object to be assigned
+    def speaker=(speaker)
+      validator = EnumAttributeValidator.new('String', ["customer", " agent"])
+      unless validator.valid?(speaker)
+        fail ArgumentError, "invalid value for \"speaker\", must be one of #{validator.allowable_values}."
+      end
+      @speaker = speaker
+    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_id == o.agent_id &&
+          channel == o.channel &&
+          confidence == o.confidence &&
+          end_time == o.end_time &&
+          speaker == o.speaker &&
+          start_time == o.start_time &&
+          text == o.text
+    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_id, channel, confidence, end_time, speaker, start_time, text].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_transfer.rb

@@ -0,0 +1,260 @@
+=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 ConversationPbxCallTransfer
+    # Reason provided for the transfer
+    attr_accessor :transfer_reason
+
+    # Type of transfer performed
+    attr_accessor :transfer_type
+
+    # Timestamp when the transfer occurred
+    attr_accessor :transferred_at_dts
+
+    # ID of the agent who initiated the transfer
+    attr_accessor :transferred_by_agent_id
+
+    # Destination of the transfer (agent ID, queue name, or phone number)
+    attr_accessor :transferred_to
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'transfer_reason' => :'transfer_reason',
+        :'transfer_type' => :'transfer_type',
+        :'transferred_at_dts' => :'transferred_at_dts',
+        :'transferred_by_agent_id' => :'transferred_by_agent_id',
+        :'transferred_to' => :'transferred_to'
+      }
+    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
+      {
+        :'transfer_reason' => :'String',
+        :'transfer_type' => :'String',
+        :'transferred_at_dts' => :'String',
+        :'transferred_by_agent_id' => :'String',
+        :'transferred_to' => :'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::ConversationPbxCallTransfer` 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::ConversationPbxCallTransfer`. 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?(:'transfer_reason')
+        self.transfer_reason = attributes[:'transfer_reason']
+      end
+
+      if attributes.key?(:'transfer_type')
+        self.transfer_type = attributes[:'transfer_type']
+      end
+
+      if attributes.key?(:'transferred_at_dts')
+        self.transferred_at_dts = attributes[:'transferred_at_dts']
+      end
+
+      if attributes.key?(:'transferred_by_agent_id')
+        self.transferred_by_agent_id = attributes[:'transferred_by_agent_id']
+      end
+
+      if attributes.key?(:'transferred_to')
+        self.transferred_to = attributes[:'transferred_to']
+      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 &&
+          transfer_reason == o.transfer_reason &&
+          transfer_type == o.transfer_type &&
+          transferred_at_dts == o.transferred_at_dts &&
+          transferred_by_agent_id == o.transferred_by_agent_id &&
+          transferred_to == o.transferred_to
+    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
+      [transfer_reason, transfer_type, transferred_at_dts, transferred_by_agent_id, transferred_to].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_phone_number.rb

@@ -27,6 +27,9 @@ module UltracartClient
     # Conversation Pbx Phone Number UUID
     attr_accessor :conversation_pbx_phone_number_uuid
 
+    # Default phone number for outbound calling.
+    attr_accessor :default_phone_number
+
     # If true, this phone number cannot be deleted through the API. It must be deleted via the Twilio console.
     attr_accessor :deletion_protected
 
@@ -65,6 +68,7 @@ module UltracartClient
         :'action_target' => :'action_target',
         :'address_sid' => :'address_sid',
         :'conversation_pbx_phone_number_uuid' => :'conversation_pbx_phone_number_uuid',
+        :'default_phone_number' => :'default_phone_number',
         :'deletion_protected' => :'deletion_protected',
         :'merchant_id' => :'merchant_id',
         :'phone_number' => :'phone_number'
@@ -83,6 +87,7 @@ module UltracartClient
         :'action_target' => :'String',
         :'address_sid' => :'String',
         :'conversation_pbx_phone_number_uuid' => :'String',
+        :'default_phone_number' => :'Boolean',
         :'deletion_protected' => :'Boolean',
         :'merchant_id' => :'String',
         :'phone_number' => :'String'
@@ -126,6 +131,10 @@ module UltracartClient
         self.conversation_pbx_phone_number_uuid = attributes[:'conversation_pbx_phone_number_uuid']
       end
 
+      if attributes.key?(:'default_phone_number')
+        self.default_phone_number = attributes[:'default_phone_number']
+      end
+
       if attributes.key?(:'deletion_protected')
         self.deletion_protected = attributes[:'deletion_protected']
       end
@@ -253,6 +262,7 @@ module UltracartClient
           action_target == o.action_target &&
           address_sid == o.address_sid &&
           conversation_pbx_phone_number_uuid == o.conversation_pbx_phone_number_uuid &&
+          default_phone_number == o.default_phone_number &&
           deletion_protected == o.deletion_protected &&
           merchant_id == o.merchant_id &&
           phone_number == o.phone_number
@@ -267,7 +277,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [action, action_target, address_sid, conversation_pbx_phone_number_uuid, deletion_protected, merchant_id, phone_number].hash
+      [action, action_target, address_sid, conversation_pbx_phone_number_uuid, default_phone_number, deletion_protected, merchant_id, phone_number].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.1.51'
+  VERSION = '4.1.54'
 end

data/lib/ultracart_api.rb

@@ -212,6 +212,25 @@ require 'ultracart_api/models/conversation_pbx_audio_usage_response'
 require 'ultracart_api/models/conversation_pbx_audios_response'
 require 'ultracart_api/models/conversation_pbx_available_phone_number'
 require 'ultracart_api/models/conversation_pbx_available_phone_numbers_response'
+require 'ultracart_api/models/conversation_pbx_call'
+require 'ultracart_api/models/conversation_pbx_call_agent'
+require 'ultracart_api/models/conversation_pbx_call_ai_cost'
+require 'ultracart_api/models/conversation_pbx_call_ai_engagement'
+require 'ultracart_api/models/conversation_pbx_call_ai_tool_call'
+require 'ultracart_api/models/conversation_pbx_call_ai_whisper'
+require 'ultracart_api/models/conversation_pbx_call_caller'
+require 'ultracart_api/models/conversation_pbx_call_financial'
+require 'ultracart_api/models/conversation_pbx_call_hold'
+require 'ultracart_api/models/conversation_pbx_call_queue'
+require 'ultracart_api/models/conversation_pbx_call_recording'
+require 'ultracart_api/models/conversation_pbx_call_response'
+require 'ultracart_api/models/conversation_pbx_call_routing'
+require 'ultracart_api/models/conversation_pbx_call_search_request'
+require 'ultracart_api/models/conversation_pbx_call_search_response'
+require 'ultracart_api/models/conversation_pbx_call_timeline'
+require 'ultracart_api/models/conversation_pbx_call_transcript'
+require 'ultracart_api/models/conversation_pbx_call_transcript_segment'
+require 'ultracart_api/models/conversation_pbx_call_transfer'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_request'
 require 'ultracart_api/models/conversation_pbx_customer_snapshot_response'
 require 'ultracart_api/models/conversation_pbx_hardware_phone'