ultracart_api 4.1.80 → 4.1.83

data/lib/ultracart_api/models/conversation_agent_status_event.rb

@@ -0,0 +1,522 @@
+=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 ConversationAgentStatusEvent
+    # Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:<user_id>' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk.
+    attr_accessor :agent_identifier
+
+    # Agent display name at the time of the event
+    attr_accessor :agent_name
+
+    # Agent type
+    attr_accessor :agent_type
+
+    # Agent user id (links across channels)
+    attr_accessor :agent_user_id
+
+    # Channel
+    attr_accessor :channel
+
+    # Custom status name (when applicable)
+    attr_accessor :custom_status_name
+
+    # Custom status uuid (when applicable)
+    attr_accessor :custom_status_uuid
+
+    # Time spent in the previous status, in seconds
+    attr_accessor :duration_in_previous_seconds
+
+    # Event timestamp (ISO 8601)
+    attr_accessor :event_dts
+
+    # Event UUID (natural key for ES + BQ)
+    attr_accessor :event_uuid
+
+    # Merchant Id
+    attr_accessor :merchant_id
+
+    # Canonical new routing semantic
+    attr_accessor :new_routing_effect
+
+    # Channel-native new status name
+    attr_accessor :new_status
+
+    # Parent merchant id (denormalized for ES routing parity)
+    attr_accessor :parent_merchant_id
+
+    # Canonical previous routing semantic
+    attr_accessor :previous_routing_effect
+
+    # Channel-native previous status name
+    attr_accessor :previous_status
+
+    # What triggered the transition
+    attr_accessor :trigger
+
+    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_identifier' => :'agent_identifier',
+        :'agent_name' => :'agent_name',
+        :'agent_type' => :'agent_type',
+        :'agent_user_id' => :'agent_user_id',
+        :'channel' => :'channel',
+        :'custom_status_name' => :'custom_status_name',
+        :'custom_status_uuid' => :'custom_status_uuid',
+        :'duration_in_previous_seconds' => :'duration_in_previous_seconds',
+        :'event_dts' => :'event_dts',
+        :'event_uuid' => :'event_uuid',
+        :'merchant_id' => :'merchant_id',
+        :'new_routing_effect' => :'new_routing_effect',
+        :'new_status' => :'new_status',
+        :'parent_merchant_id' => :'parent_merchant_id',
+        :'previous_routing_effect' => :'previous_routing_effect',
+        :'previous_status' => :'previous_status',
+        :'trigger' => :'trigger'
+      }
+    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_identifier' => :'String',
+        :'agent_name' => :'String',
+        :'agent_type' => :'String',
+        :'agent_user_id' => :'String',
+        :'channel' => :'String',
+        :'custom_status_name' => :'String',
+        :'custom_status_uuid' => :'String',
+        :'duration_in_previous_seconds' => :'Integer',
+        :'event_dts' => :'String',
+        :'event_uuid' => :'String',
+        :'merchant_id' => :'String',
+        :'new_routing_effect' => :'String',
+        :'new_status' => :'String',
+        :'parent_merchant_id' => :'String',
+        :'previous_routing_effect' => :'String',
+        :'previous_status' => :'String',
+        :'trigger' => :'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::ConversationAgentStatusEvent` 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::ConversationAgentStatusEvent`. 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_identifier')
+        self.agent_identifier = attributes[:'agent_identifier']
+      end
+
+      if attributes.key?(:'agent_name')
+        self.agent_name = attributes[:'agent_name']
+      end
+
+      if attributes.key?(:'agent_type')
+        self.agent_type = attributes[:'agent_type']
+      end
+
+      if attributes.key?(:'agent_user_id')
+        self.agent_user_id = attributes[:'agent_user_id']
+      end
+
+      if attributes.key?(:'channel')
+        self.channel = attributes[:'channel']
+      end
+
+      if attributes.key?(:'custom_status_name')
+        self.custom_status_name = attributes[:'custom_status_name']
+      end
+
+      if attributes.key?(:'custom_status_uuid')
+        self.custom_status_uuid = attributes[:'custom_status_uuid']
+      end
+
+      if attributes.key?(:'duration_in_previous_seconds')
+        self.duration_in_previous_seconds = attributes[:'duration_in_previous_seconds']
+      end
+
+      if attributes.key?(:'event_dts')
+        self.event_dts = attributes[:'event_dts']
+      end
+
+      if attributes.key?(:'event_uuid')
+        self.event_uuid = attributes[:'event_uuid']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'new_routing_effect')
+        self.new_routing_effect = attributes[:'new_routing_effect']
+      end
+
+      if attributes.key?(:'new_status')
+        self.new_status = attributes[:'new_status']
+      end
+
+      if attributes.key?(:'parent_merchant_id')
+        self.parent_merchant_id = attributes[:'parent_merchant_id']
+      end
+
+      if attributes.key?(:'previous_routing_effect')
+        self.previous_routing_effect = attributes[:'previous_routing_effect']
+      end
+
+      if attributes.key?(:'previous_status')
+        self.previous_status = attributes[:'previous_status']
+      end
+
+      if attributes.key?(:'trigger')
+        self.trigger = attributes[:'trigger']
+      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 !@custom_status_uuid.nil? && @custom_status_uuid.to_s.length > 50
+        invalid_properties.push('invalid value for "custom_status_uuid", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@event_uuid.nil? && @event_uuid.to_s.length > 36
+        invalid_properties.push('invalid value for "event_uuid", the character length must be smaller than or equal to 36.')
+      end
+
+      if !@merchant_id.nil? && @merchant_id.to_s.length > 5
+        invalid_properties.push('invalid value for "merchant_id", the character length must be smaller than or equal to 5.')
+      end
+
+      if !@parent_merchant_id.nil? && @parent_merchant_id.to_s.length > 5
+        invalid_properties.push('invalid value for "parent_merchant_id", the character length must be smaller than or equal to 5.')
+      end
+
+      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?
+      agent_type_validator = EnumAttributeValidator.new('String', ["human", "ai"])
+      return false unless agent_type_validator.valid?(@agent_type)
+      channel_validator = EnumAttributeValidator.new('String', ["pbx", "chat"])
+      return false unless channel_validator.valid?(@channel)
+      return false if !@custom_status_uuid.nil? && @custom_status_uuid.to_s.length > 50
+      return false if !@event_uuid.nil? && @event_uuid.to_s.length > 36
+      return false if !@merchant_id.nil? && @merchant_id.to_s.length > 5
+      new_routing_effect_validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
+      return false unless new_routing_effect_validator.valid?(@new_routing_effect)
+      return false if !@parent_merchant_id.nil? && @parent_merchant_id.to_s.length > 5
+      previous_routing_effect_validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
+      return false unless previous_routing_effect_validator.valid?(@previous_routing_effect)
+      trigger_validator = EnumAttributeValidator.new('String', ["manual", "system", "auto_disconnect"])
+      return false unless trigger_validator.valid?(@trigger)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] agent_type Object to be assigned
+    def agent_type=(agent_type)
+      validator = EnumAttributeValidator.new('String', ["human", "ai"])
+      unless validator.valid?(agent_type)
+        fail ArgumentError, "invalid value for \"agent_type\", must be one of #{validator.allowable_values}."
+      end
+      @agent_type = agent_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] channel Object to be assigned
+    def channel=(channel)
+      validator = EnumAttributeValidator.new('String', ["pbx", "chat"])
+      unless validator.valid?(channel)
+        fail ArgumentError, "invalid value for \"channel\", must be one of #{validator.allowable_values}."
+      end
+      @channel = channel
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] custom_status_uuid Value to be assigned
+    def custom_status_uuid=(custom_status_uuid)
+      if !custom_status_uuid.nil? && custom_status_uuid.to_s.length > 50
+        fail ArgumentError, 'invalid value for "custom_status_uuid", the character length must be smaller than or equal to 50.'
+      end
+
+      @custom_status_uuid = custom_status_uuid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] event_uuid Value to be assigned
+    def event_uuid=(event_uuid)
+      if !event_uuid.nil? && event_uuid.to_s.length > 36
+        fail ArgumentError, 'invalid value for "event_uuid", the character length must be smaller than or equal to 36.'
+      end
+
+      @event_uuid = event_uuid
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] merchant_id Value to be assigned
+    def merchant_id=(merchant_id)
+      if !merchant_id.nil? && merchant_id.to_s.length > 5
+        fail ArgumentError, 'invalid value for "merchant_id", the character length must be smaller than or equal to 5.'
+      end
+
+      @merchant_id = merchant_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] new_routing_effect Object to be assigned
+    def new_routing_effect=(new_routing_effect)
+      validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
+      unless validator.valid?(new_routing_effect)
+        fail ArgumentError, "invalid value for \"new_routing_effect\", must be one of #{validator.allowable_values}."
+      end
+      @new_routing_effect = new_routing_effect
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] parent_merchant_id Value to be assigned
+    def parent_merchant_id=(parent_merchant_id)
+      if !parent_merchant_id.nil? && parent_merchant_id.to_s.length > 5
+        fail ArgumentError, 'invalid value for "parent_merchant_id", the character length must be smaller than or equal to 5.'
+      end
+
+      @parent_merchant_id = parent_merchant_id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] previous_routing_effect Object to be assigned
+    def previous_routing_effect=(previous_routing_effect)
+      validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
+      unless validator.valid?(previous_routing_effect)
+        fail ArgumentError, "invalid value for \"previous_routing_effect\", must be one of #{validator.allowable_values}."
+      end
+      @previous_routing_effect = previous_routing_effect
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] trigger Object to be assigned
+    def trigger=(trigger)
+      validator = EnumAttributeValidator.new('String', ["manual", "system", "auto_disconnect"])
+      unless validator.valid?(trigger)
+        fail ArgumentError, "invalid value for \"trigger\", must be one of #{validator.allowable_values}."
+      end
+      @trigger = trigger
+    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_identifier == o.agent_identifier &&
+          agent_name == o.agent_name &&
+          agent_type == o.agent_type &&
+          agent_user_id == o.agent_user_id &&
+          channel == o.channel &&
+          custom_status_name == o.custom_status_name &&
+          custom_status_uuid == o.custom_status_uuid &&
+          duration_in_previous_seconds == o.duration_in_previous_seconds &&
+          event_dts == o.event_dts &&
+          event_uuid == o.event_uuid &&
+          merchant_id == o.merchant_id &&
+          new_routing_effect == o.new_routing_effect &&
+          new_status == o.new_status &&
+          parent_merchant_id == o.parent_merchant_id &&
+          previous_routing_effect == o.previous_routing_effect &&
+          previous_status == o.previous_status &&
+          trigger == o.trigger
+    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_identifier, agent_name, agent_type, agent_user_id, channel, custom_status_name, custom_status_uuid, duration_in_previous_seconds, event_dts, event_uuid, merchant_id, new_routing_effect, new_status, parent_merchant_id, previous_routing_effect, previous_status, trigger].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