ultracart_api 4.1.51 → 4.1.54

data/lib/ultracart_api/models/conversation_pbx_call.rb

@@ -0,0 +1,438 @@
+=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 ConversationPbxCall
+    # Twilio account SID
+    attr_accessor :account_sid
+
+    # List of agents who participated in this call
+    attr_accessor :agents
+
+    # List of AI agent engagements during the call
+    attr_accessor :ai_agent_engagements
+
+    # Twilio call SID for the primary (customer) call leg
+    attr_accessor :call_sid
+
+    # Unique identifier for this call record
+    attr_accessor :call_uuid
+
+    attr_accessor :caller
+
+    # Twilio conference SID if this call used conferencing
+    attr_accessor :conference_sid
+
+    # Timestamp when the call record was created
+    attr_accessor :created_at_dts
+
+    # Customer name associated with this call
+    attr_accessor :customer_name
+
+    # UltraCart customer profile OID if the caller was matched to a customer
+    attr_accessor :customer_profile_oid
+
+    # Call disposition describing how the call ended
+    attr_accessor :disposition
+
+    # Email address of the caller if known
+    attr_accessor :email
+
+    attr_accessor :financial
+
+    # List of hold events during the call
+    attr_accessor :holds
+
+    # Merchant identifier
+    attr_accessor :merchant_id
+
+    # List of all Twilio recording SIDs associated with this call
+    attr_accessor :recording_sids
+
+    # List of recordings made during the call
+    attr_accessor :recordings
+
+    attr_accessor :routing
+
+    # Final status of the call
+    attr_accessor :status
+
+    attr_accessor :timeline
+
+    # List of transfer events during the call
+    attr_accessor :transfers
+
+    # Timestamp when the call record was last updated
+    attr_accessor :updated_at_dts
+
+    # 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',
+        :'call_sid' => :'call_sid',
+        :'call_uuid' => :'call_uuid',
+        :'caller' => :'caller',
+        :'conference_sid' => :'conference_sid',
+        :'created_at_dts' => :'created_at_dts',
+        :'customer_name' => :'customer_name',
+        :'customer_profile_oid' => :'customer_profile_oid',
+        :'disposition' => :'disposition',
+        :'email' => :'email',
+        :'financial' => :'financial',
+        :'holds' => :'holds',
+        :'merchant_id' => :'merchant_id',
+        :'recording_sids' => :'recording_sids',
+        :'recordings' => :'recordings',
+        :'routing' => :'routing',
+        :'status' => :'status',
+        :'timeline' => :'timeline',
+        :'transfers' => :'transfers',
+        :'updated_at_dts' => :'updated_at_dts'
+      }
+    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
+      {
+        :'account_sid' => :'String',
+        :'agents' => :'Array<ConversationPbxCallAgent>',
+        :'ai_agent_engagements' => :'Array<ConversationPbxCallAiEngagement>',
+        :'call_sid' => :'String',
+        :'call_uuid' => :'String',
+        :'caller' => :'ConversationPbxCallCaller',
+        :'conference_sid' => :'String',
+        :'created_at_dts' => :'String',
+        :'customer_name' => :'String',
+        :'customer_profile_oid' => :'String',
+        :'disposition' => :'String',
+        :'email' => :'String',
+        :'financial' => :'ConversationPbxCallFinancial',
+        :'holds' => :'Array<ConversationPbxCallHold>',
+        :'merchant_id' => :'String',
+        :'recording_sids' => :'Array<String>',
+        :'recordings' => :'Array<ConversationPbxCallRecording>',
+        :'routing' => :'ConversationPbxCallRouting',
+        :'status' => :'String',
+        :'timeline' => :'ConversationPbxCallTimeline',
+        :'transfers' => :'Array<ConversationPbxCallTransfer>',
+        :'updated_at_dts' => :'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::ConversationPbxCall` 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::ConversationPbxCall`. 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?(:'account_sid')
+        self.account_sid = attributes[:'account_sid']
+      end
+
+      if attributes.key?(:'agents')
+        if (value = attributes[:'agents']).is_a?(Array)
+          self.agents = value
+        end
+      end
+
+      if attributes.key?(:'ai_agent_engagements')
+        if (value = attributes[:'ai_agent_engagements']).is_a?(Array)
+          self.ai_agent_engagements = value
+        end
+      end
+
+      if attributes.key?(:'call_sid')
+        self.call_sid = attributes[:'call_sid']
+      end
+
+      if attributes.key?(:'call_uuid')
+        self.call_uuid = attributes[:'call_uuid']
+      end
+
+      if attributes.key?(:'caller')
+        self.caller = attributes[:'caller']
+      end
+
+      if attributes.key?(:'conference_sid')
+        self.conference_sid = attributes[:'conference_sid']
+      end
+
+      if attributes.key?(:'created_at_dts')
+        self.created_at_dts = attributes[:'created_at_dts']
+      end
+
+      if attributes.key?(:'customer_name')
+        self.customer_name = attributes[:'customer_name']
+      end
+
+      if attributes.key?(:'customer_profile_oid')
+        self.customer_profile_oid = attributes[:'customer_profile_oid']
+      end
+
+      if attributes.key?(:'disposition')
+        self.disposition = attributes[:'disposition']
+      end
+
+      if attributes.key?(:'email')
+        self.email = attributes[:'email']
+      end
+
+      if attributes.key?(:'financial')
+        self.financial = attributes[:'financial']
+      end
+
+      if attributes.key?(:'holds')
+        if (value = attributes[:'holds']).is_a?(Array)
+          self.holds = value
+        end
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'recording_sids')
+        if (value = attributes[:'recording_sids']).is_a?(Array)
+          self.recording_sids = value
+        end
+      end
+
+      if attributes.key?(:'recordings')
+        if (value = attributes[:'recordings']).is_a?(Array)
+          self.recordings = value
+        end
+      end
+
+      if attributes.key?(:'routing')
+        self.routing = attributes[:'routing']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'timeline')
+        self.timeline = attributes[:'timeline']
+      end
+
+      if attributes.key?(:'transfers')
+        if (value = attributes[:'transfers']).is_a?(Array)
+          self.transfers = value
+        end
+      end
+
+      if attributes.key?(:'updated_at_dts')
+        self.updated_at_dts = attributes[:'updated_at_dts']
+      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 &&
+          account_sid == o.account_sid &&
+          agents == o.agents &&
+          ai_agent_engagements == o.ai_agent_engagements &&
+          call_sid == o.call_sid &&
+          call_uuid == o.call_uuid &&
+          caller == o.caller &&
+          conference_sid == o.conference_sid &&
+          created_at_dts == o.created_at_dts &&
+          customer_name == o.customer_name &&
+          customer_profile_oid == o.customer_profile_oid &&
+          disposition == o.disposition &&
+          email == o.email &&
+          financial == o.financial &&
+          holds == o.holds &&
+          merchant_id == o.merchant_id &&
+          recording_sids == o.recording_sids &&
+          recordings == o.recordings &&
+          routing == o.routing &&
+          status == o.status &&
+          timeline == o.timeline &&
+          transfers == o.transfers &&
+          updated_at_dts == o.updated_at_dts
+    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
+      [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
+    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