ultracart_api 4.0.54.rc → 4.0.57.rc

data/lib/ultracart_api/api/storefront_api.rb

@@ -6894,6 +6894,62 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get storefronts (internal use only for security reasons)
+    # @param [Hash] opts the optional parameters
+    # @return [StoreFrontsResponse]
+    def get_store_fronts(opts = {})
+      data, _status_code, _headers = get_store_fronts_with_http_info(opts)
+      data
+    end
+
+    # Get storefronts (internal use only for security reasons)
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(StoreFrontsResponse, Integer, Hash)>] StoreFrontsResponse data, response status code and response headers
+    def get_store_fronts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_store_fronts ...'
+      end
+      # resource path
+      local_var_path = '/storefront'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'StoreFrontsResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_store_fronts",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_store_fronts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get thumbnail parameters
     # @param thumbnail_parameters [ThumbnailParametersRequest] Thumbnail Parameters
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/cart_marketing.rb

@@ -18,6 +18,9 @@ module UltracartClient
     # The advertising source the customer indicated
     attr_accessor :advertising_source
 
+    # True if the customer agrees to receiving marketing SMS messages
+    attr_accessor :cell_phone_opt_in
+
     # True if the customer agrees to receiving marketing emails
     attr_accessor :mailing_list_opt_in
 
@@ -25,6 +28,7 @@ module UltracartClient
     def self.attribute_map
       {
         :'advertising_source' => :'advertising_source',
+        :'cell_phone_opt_in' => :'cell_phone_opt_in',
         :'mailing_list_opt_in' => :'mailing_list_opt_in'
       }
     end
@@ -38,6 +42,7 @@ module UltracartClient
     def self.openapi_types
       {
         :'advertising_source' => :'String',
+        :'cell_phone_opt_in' => :'Boolean',
         :'mailing_list_opt_in' => :'Boolean'
       }
     end
@@ -67,6 +72,10 @@ module UltracartClient
         self.advertising_source = attributes[:'advertising_source']
       end
 
+      if attributes.key?(:'cell_phone_opt_in')
+        self.cell_phone_opt_in = attributes[:'cell_phone_opt_in']
+      end
+
       if attributes.key?(:'mailing_list_opt_in')
         self.mailing_list_opt_in = attributes[:'mailing_list_opt_in']
       end
@@ -91,6 +100,7 @@ module UltracartClient
       return true if self.equal?(o)
       self.class == o.class &&
           advertising_source == o.advertising_source &&
+          cell_phone_opt_in == o.cell_phone_opt_in &&
           mailing_list_opt_in == o.mailing_list_opt_in
     end
 
@@ -103,7 +113,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [advertising_source, mailing_list_opt_in].hash
+      [advertising_source, cell_phone_opt_in, mailing_list_opt_in].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_participant.rb

@@ -30,6 +30,8 @@ module UltracartClient
     # Left conversation date/time
     attr_accessor :left_dts
 
+    attr_accessor :profile_image_url
+
     attr_accessor :status
 
     attr_accessor :unread_messages
@@ -43,6 +45,7 @@ module UltracartClient
         :'joined_dts' => :'joined_dts',
         :'last_message_dts' => :'last_message_dts',
         :'left_dts' => :'left_dts',
+        :'profile_image_url' => :'profile_image_url',
         :'status' => :'status',
         :'unread_messages' => :'unread_messages'
       }
@@ -62,6 +65,7 @@ module UltracartClient
         :'joined_dts' => :'String',
         :'last_message_dts' => :'String',
         :'left_dts' => :'String',
+        :'profile_image_url' => :'String',
         :'status' => :'String',
         :'unread_messages' => :'Integer'
       }
@@ -112,6 +116,10 @@ module UltracartClient
         self.left_dts = attributes[:'left_dts']
       end
 
+      if attributes.key?(:'profile_image_url')
+        self.profile_image_url = attributes[:'profile_image_url']
+      end
+
       if attributes.key?(:'status')
         self.status = attributes[:'status']
       end
@@ -145,6 +153,7 @@ module UltracartClient
           joined_dts == o.joined_dts &&
           last_message_dts == o.last_message_dts &&
           left_dts == o.left_dts &&
+          profile_image_url == o.profile_image_url &&
           status == o.status &&
           unread_messages == o.unread_messages
     end
@@ -158,7 +167,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [conversation_participant_arn, conversation_participant_name, conversation_participant_uuid, joined_dts, last_message_dts, left_dts, status, unread_messages].hash
+      [conversation_participant_arn, conversation_participant_name, conversation_participant_uuid, joined_dts, last_message_dts, left_dts, profile_image_url, status, unread_messages].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_webchat_queue_status_agent.rb

@@ -15,6 +15,7 @@ require 'time'
 
 module UltracartClient
   class ConversationWebchatQueueStatusAgent
+    # Status of the agent
     attr_accessor :agent_status
 
     attr_accessor :conversation_participant_arn
@@ -26,6 +27,31 @@ module UltracartClient
 
     attr_accessor :next_round_robin
 
+    # Profile image URL
+    attr_accessor :profile_image_url
+
+    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
       {
@@ -33,7 +59,8 @@ module UltracartClient
         :'conversation_participant_arn' => :'conversation_participant_arn',
         :'conversation_participant_name' => :'conversation_participant_name',
         :'last_chat_dts' => :'last_chat_dts',
-        :'next_round_robin' => :'next_round_robin'
+        :'next_round_robin' => :'next_round_robin',
+        :'profile_image_url' => :'profile_image_url'
       }
     end
 
@@ -49,7 +76,8 @@ module UltracartClient
         :'conversation_participant_arn' => :'String',
         :'conversation_participant_name' => :'String',
         :'last_chat_dts' => :'String',
-        :'next_round_robin' => :'Boolean'
+        :'next_round_robin' => :'Boolean',
+        :'profile_image_url' => :'String'
       }
     end
 
@@ -93,6 +121,10 @@ module UltracartClient
       if attributes.key?(:'next_round_robin')
         self.next_round_robin = attributes[:'next_round_robin']
       end
+
+      if attributes.key?(:'profile_image_url')
+        self.profile_image_url = attributes[:'profile_image_url']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -105,9 +137,21 @@ module UltracartClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
+      agent_status_validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
+      return false unless agent_status_validator.valid?(@agent_status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] agent_status Object to be assigned
+    def agent_status=(agent_status)
+      validator = EnumAttributeValidator.new('String', ["available", "busy", "unavailable"])
+      unless validator.valid?(agent_status)
+        fail ArgumentError, "invalid value for \"agent_status\", must be one of #{validator.allowable_values}."
+      end
+      @agent_status = agent_status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -117,7 +161,8 @@ module UltracartClient
           conversation_participant_arn == o.conversation_participant_arn &&
           conversation_participant_name == o.conversation_participant_name &&
           last_chat_dts == o.last_chat_dts &&
-          next_round_robin == o.next_round_robin
+          next_round_robin == o.next_round_robin &&
+          profile_image_url == o.profile_image_url
     end
 
     # @see the `==` method
@@ -129,7 +174,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].hash
+      [agent_status, conversation_participant_arn, conversation_participant_name, last_chat_dts, next_round_robin, profile_image_url].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/customer_magic_link_response.rb

@@ -0,0 +1,257 @@
+=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 CustomerMagicLinkResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    # URL
+    attr_accessor :url
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'url' => :'url',
+        :'warning' => :'warning'
+      }
+    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
+      {
+        :'error' => :'Error',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'url' => :'String',
+        :'warning' => :'Warning'
+      }
+    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::CustomerMagicLinkResponse` 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::CustomerMagicLinkResponse`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          error == o.error &&
+          metadata == o.metadata &&
+          success == o.success &&
+          url == o.url &&
+          warning == o.warning
+    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
+      [error, metadata, success, url, warning].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