ultracart_api 4.1.80 → 4.1.83

data/lib/ultracart_api/models/conversation_pbx_default_timezone_update_request.rb

@@ -0,0 +1,235 @@
+=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 ConversationPbxDefaultTimezoneUpdateRequest
+    # Merchant default timezone (IANA name, e.g. 'America/New_York')
+    attr_accessor :default_timezone
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'default_timezone' => :'default_timezone'
+      }
+    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
+      {
+        :'default_timezone' => :'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::ConversationPbxDefaultTimezoneUpdateRequest` 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::ConversationPbxDefaultTimezoneUpdateRequest`. 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?(:'default_timezone')
+        self.default_timezone = attributes[:'default_timezone']
+      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 !@default_timezone.nil? && @default_timezone.to_s.length > 60
+        invalid_properties.push('invalid value for "default_timezone", the character length must be smaller than or equal to 60.')
+      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?
+      return false if !@default_timezone.nil? && @default_timezone.to_s.length > 60
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] default_timezone Value to be assigned
+    def default_timezone=(default_timezone)
+      if !default_timezone.nil? && default_timezone.to_s.length > 60
+        fail ArgumentError, 'invalid value for "default_timezone", the character length must be smaller than or equal to 60.'
+      end
+
+      @default_timezone = default_timezone
+    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 &&
+          default_timezone == o.default_timezone
+    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
+      [default_timezone].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_webchat_queue_status_agent.rb

@@ -18,10 +18,19 @@ module UltracartClient
     # Status of the agent
     attr_accessor :agent_status
 
+    # Agent user id (populated by Java so the dispatch-scheduler Lambda can read it directly without parsing conversation_participant_arn)
+    attr_accessor :agent_user_id
+
     attr_accessor :conversation_participant_arn
 
     attr_accessor :conversation_participant_name
 
+    # Active custom status display name for this agent (denormalized)
+    attr_accessor :custom_status_name
+
+    # Active custom status uuid for this agent (null when on a system status)
+    attr_accessor :custom_status_uuid
+
     # Date/time that this agent took their last chat
     attr_accessor :last_chat_dts
 
@@ -56,8 +65,11 @@ module UltracartClient
     def self.attribute_map
       {
         :'agent_status' => :'agent_status',
+        :'agent_user_id' => :'agent_user_id',
         :'conversation_participant_arn' => :'conversation_participant_arn',
         :'conversation_participant_name' => :'conversation_participant_name',
+        :'custom_status_name' => :'custom_status_name',
+        :'custom_status_uuid' => :'custom_status_uuid',
         :'last_chat_dts' => :'last_chat_dts',
         :'next_round_robin' => :'next_round_robin',
         :'profile_image_url' => :'profile_image_url'
@@ -73,8 +85,11 @@ module UltracartClient
     def self.openapi_types
       {
         :'agent_status' => :'String',
+        :'agent_user_id' => :'String',
         :'conversation_participant_arn' => :'String',
         :'conversation_participant_name' => :'String',
+        :'custom_status_name' => :'String',
+        :'custom_status_uuid' => :'String',
         :'last_chat_dts' => :'String',
         :'next_round_robin' => :'Boolean',
         :'profile_image_url' => :'String'
@@ -106,6 +121,10 @@ module UltracartClient
         self.agent_status = attributes[:'agent_status']
       end
 
+      if attributes.key?(:'agent_user_id')
+        self.agent_user_id = attributes[:'agent_user_id']
+      end
+
       if attributes.key?(:'conversation_participant_arn')
         self.conversation_participant_arn = attributes[:'conversation_participant_arn']
       end
@@ -114,6 +133,14 @@ module UltracartClient
         self.conversation_participant_name = attributes[:'conversation_participant_name']
       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?(:'last_chat_dts')
         self.last_chat_dts = attributes[:'last_chat_dts']
       end
@@ -158,8 +185,11 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           agent_status == o.agent_status &&
+          agent_user_id == o.agent_user_id &&
           conversation_participant_arn == o.conversation_participant_arn &&
           conversation_participant_name == o.conversation_participant_name &&
+          custom_status_name == o.custom_status_name &&
+          custom_status_uuid == o.custom_status_uuid &&
           last_chat_dts == o.last_chat_dts &&
           next_round_robin == o.next_round_robin &&
           profile_image_url == o.profile_image_url
@@ -174,7 +204,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [agent_status, conversation_participant_arn, conversation_participant_name, last_chat_dts, next_round_robin, profile_image_url].hash
+      [agent_status, agent_user_id, conversation_participant_arn, conversation_participant_name, custom_status_name, custom_status_uuid, last_chat_dts, next_round_robin, profile_image_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_webchat_queue_status_update_request.rb

@@ -18,6 +18,12 @@ module UltracartClient
     # Status of the agent
     attr_accessor :agent_status
 
+    # Custom status display name (denormalized so the queue panel can render without a config lookup)
+    attr_accessor :custom_status_name
+
+    # Custom status uuid (when picking a custom status). Pair with custom_status_name.
+    attr_accessor :custom_status_uuid
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -43,7 +49,9 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'agent_status' => :'agent_status'
+        :'agent_status' => :'agent_status',
+        :'custom_status_name' => :'custom_status_name',
+        :'custom_status_uuid' => :'custom_status_uuid'
       }
     end
 
@@ -55,7 +63,9 @@ module UltracartClient
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'agent_status' => :'String'
+        :'agent_status' => :'String',
+        :'custom_status_name' => :'String',
+        :'custom_status_uuid' => :'String'
       }
     end
 
@@ -83,6 +93,14 @@ module UltracartClient
       if attributes.key?(:'agent_status')
         self.agent_status = attributes[:'agent_status']
       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
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -115,7 +133,9 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          agent_status == o.agent_status
+          agent_status == o.agent_status &&
+          custom_status_name == o.custom_status_name &&
+          custom_status_uuid == o.custom_status_uuid
     end
 
     # @see the `==` method
@@ -127,7 +147,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [agent_status].hash
+      [agent_status, custom_status_name, custom_status_uuid].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/timeline_summary.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 TimelineSummary
+    # Seconds the agent was Available (incl. Busy)
+    attr_accessor :available_seconds
+
+    # Average handle time across calls and chats, in seconds
+    attr_accessor :avg_handle_time_seconds
+
+    # Calls the agent missed (inbound, disposition=missed)
+    attr_accessor :calls_missed
+
+    # Calls the agent took
+    attr_accessor :calls_taken
+
+    # Chats the agent handled
+    attr_accessor :chats_handled
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'available_seconds' => :'available_seconds',
+        :'avg_handle_time_seconds' => :'avg_handle_time_seconds',
+        :'calls_missed' => :'calls_missed',
+        :'calls_taken' => :'calls_taken',
+        :'chats_handled' => :'chats_handled'
+      }
+    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
+      {
+        :'available_seconds' => :'Integer',
+        :'avg_handle_time_seconds' => :'Integer',
+        :'calls_missed' => :'Integer',
+        :'calls_taken' => :'Integer',
+        :'chats_handled' => :'Integer'
+      }
+    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::TimelineSummary` 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::TimelineSummary`. 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?(:'available_seconds')
+        self.available_seconds = attributes[:'available_seconds']
+      end
+
+      if attributes.key?(:'avg_handle_time_seconds')
+        self.avg_handle_time_seconds = attributes[:'avg_handle_time_seconds']
+      end
+
+      if attributes.key?(:'calls_missed')
+        self.calls_missed = attributes[:'calls_missed']
+      end
+
+      if attributes.key?(:'calls_taken')
+        self.calls_taken = attributes[:'calls_taken']
+      end
+
+      if attributes.key?(:'chats_handled')
+        self.chats_handled = attributes[:'chats_handled']
+      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 &&
+          available_seconds == o.available_seconds &&
+          avg_handle_time_seconds == o.avg_handle_time_seconds &&
+          calls_missed == o.calls_missed &&
+          calls_taken == o.calls_taken &&
+          chats_handled == o.chats_handled
+    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
+      [available_seconds, avg_handle_time_seconds, calls_missed, calls_taken, chats_handled].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/version.rb

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