ultracart_api 3.11.13 → 3.11.15

data/lib/ultracart_api/api/order_api.rb

@@ -93,6 +93,63 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Set a refund block on an order
+    # Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
+    # @param order_id The order id to block a refund on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :block_reason Block reason code (optional)
+    # @return [nil]
+    def block_refund_on_order(order_id, opts = {})
+      block_refund_on_order_with_http_info(order_id, opts)
+      nil
+    end
+
+    # Set a refund block on an order
+    # Sets a refund block on an order to prevent a user from performing a refund.  Commonly used when a chargeback has been received. 
+    # @param order_id The order id to block a refund on.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :block_reason Block reason code (optional)
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def block_refund_on_order_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.block_refund_on_order ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.block_refund_on_order"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/refund_block'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'block_reason'] = opts[:'block_reason'] if !opts[:'block_reason'].nil?
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#block_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Cancel an order
     # Cancel an order on the UltraCart account.  If the success flag is false, then consult the error message for why it failed. 
     # @param order_id The order id to cancel.
@@ -1607,6 +1664,60 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Remove a refund block on an order
+    # Removes a refund block on an order to prevent a user from performing a refund. 
+    # @param order_id The order id to unblock a refund on.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def unblock_refund_on_order(order_id, opts = {})
+      unblock_refund_on_order_with_http_info(order_id, opts)
+      nil
+    end
+
+    # Remove a refund block on an order
+    # Removes a refund block on an order to prevent a user from performing a refund. 
+    # @param order_id The order id to unblock a refund on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def unblock_refund_on_order_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.unblock_refund_on_order ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.unblock_refund_on_order"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/refund_unblock'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#unblock_refund_on_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Update A/R Retry Configuration
     # Update A/R Retry Configuration.  This is primarily an internal API call.  It is doubtful you would ever need to use it. 
     # @param retry_config AccountsReceivableRetryConfig object

data/lib/ultracart_api/models/cart_upsell_after.rb

@@ -20,15 +20,23 @@ module UltracartClient
     # The amount of inactivity in minutes after which the cart should be finalized into an order.  This will calculate the finalize_after_dts field.
     attr_accessor :finalize_after_minutes
 
-    # Upsell path code
+    # Upsell path code (this is for legacy upsells only)
     attr_accessor :upsell_path_code
 
+    # Upsell path name to start on (StoreFront Upsells).  Will only be respected on a handoff API call.
+    attr_accessor :upsell_path_name
+
+    # Upsell path variation to start on (StoreFront Upsells).   Will only be respected on a handoff API call.
+    attr_accessor :upsell_path_variation
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'finalize_after_dts' => :'finalize_after_dts',
         :'finalize_after_minutes' => :'finalize_after_minutes',
-        :'upsell_path_code' => :'upsell_path_code'
+        :'upsell_path_code' => :'upsell_path_code',
+        :'upsell_path_name' => :'upsell_path_name',
+        :'upsell_path_variation' => :'upsell_path_variation'
       }
     end
 
@@ -37,7 +45,9 @@ module UltracartClient
       {
         :'finalize_after_dts' => :'String',
         :'finalize_after_minutes' => :'Integer',
-        :'upsell_path_code' => :'String'
+        :'upsell_path_code' => :'String',
+        :'upsell_path_name' => :'String',
+        :'upsell_path_variation' => :'String'
       }
     end
 
@@ -60,6 +70,14 @@ module UltracartClient
       if attributes.has_key?(:'upsell_path_code')
         self.upsell_path_code = attributes[:'upsell_path_code']
       end
+
+      if attributes.has_key?(:'upsell_path_name')
+        self.upsell_path_name = attributes[:'upsell_path_name']
+      end
+
+      if attributes.has_key?(:'upsell_path_variation')
+        self.upsell_path_variation = attributes[:'upsell_path_variation']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -97,7 +115,9 @@ module UltracartClient
       self.class == o.class &&
           finalize_after_dts == o.finalize_after_dts &&
           finalize_after_minutes == o.finalize_after_minutes &&
-          upsell_path_code == o.upsell_path_code
+          upsell_path_code == o.upsell_path_code &&
+          upsell_path_name == o.upsell_path_name &&
+          upsell_path_variation == o.upsell_path_variation
     end
 
     # @see the `==` method
@@ -109,7 +129,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [finalize_after_dts, finalize_after_minutes, upsell_path_code].hash
+      [finalize_after_dts, finalize_after_minutes, upsell_path_code, upsell_path_name, upsell_path_variation].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/conversation_virtual_agent_capabilities.rb

@@ -24,6 +24,12 @@ module UltracartClient
 
     attr_accessor :open_support_ticket
 
+    # Channel to use to open the support ticket
+    attr_accessor :open_support_ticket_channel
+
+    # Email to send support ticket to
+    attr_accessor :open_support_ticket_channel_email
+
     attr_accessor :pause_subscription
 
     attr_accessor :resume_subscription
@@ -32,6 +38,28 @@ module UltracartClient
 
     attr_accessor :update_subscription_credit_card
 
+    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
       {
@@ -40,6 +68,8 @@ module UltracartClient
         :'lookup_order_information' => :'lookup_order_information',
         :'lookup_subscription_information' => :'lookup_subscription_information',
         :'open_support_ticket' => :'open_support_ticket',
+        :'open_support_ticket_channel' => :'open_support_ticket_channel',
+        :'open_support_ticket_channel_email' => :'open_support_ticket_channel_email',
         :'pause_subscription' => :'pause_subscription',
         :'resume_subscription' => :'resume_subscription',
         :'transfer_chat_to_live_agent' => :'transfer_chat_to_live_agent',
@@ -55,6 +85,8 @@ module UltracartClient
         :'lookup_order_information' => :'BOOLEAN',
         :'lookup_subscription_information' => :'BOOLEAN',
         :'open_support_ticket' => :'BOOLEAN',
+        :'open_support_ticket_channel' => :'String',
+        :'open_support_ticket_channel_email' => :'String',
         :'pause_subscription' => :'BOOLEAN',
         :'resume_subscription' => :'BOOLEAN',
         :'transfer_chat_to_live_agent' => :'BOOLEAN',
@@ -90,6 +122,14 @@ module UltracartClient
         self.open_support_ticket = attributes[:'open_support_ticket']
       end
 
+      if attributes.has_key?(:'open_support_ticket_channel')
+        self.open_support_ticket_channel = attributes[:'open_support_ticket_channel']
+      end
+
+      if attributes.has_key?(:'open_support_ticket_channel_email')
+        self.open_support_ticket_channel_email = attributes[:'open_support_ticket_channel_email']
+      end
+
       if attributes.has_key?(:'pause_subscription')
         self.pause_subscription = attributes[:'pause_subscription']
       end
@@ -117,9 +157,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?
+      open_support_ticket_channel_validator = EnumAttributeValidator.new('String', ['none', 'email', 'UltraCart Task', 'Zoho Desk Ticket'])
+      return false unless open_support_ticket_channel_validator.valid?(@open_support_ticket_channel)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] open_support_ticket_channel Object to be assigned
+    def open_support_ticket_channel=(open_support_ticket_channel)
+      validator = EnumAttributeValidator.new('String', ['none', 'email', 'UltraCart Task', 'Zoho Desk Ticket'])
+      unless validator.valid?(open_support_ticket_channel)
+        fail ArgumentError, 'invalid value for "open_support_ticket_channel", must be one of #{validator.allowable_values}.'
+      end
+      @open_support_ticket_channel = open_support_ticket_channel
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -130,6 +182,8 @@ module UltracartClient
           lookup_order_information == o.lookup_order_information &&
           lookup_subscription_information == o.lookup_subscription_information &&
           open_support_ticket == o.open_support_ticket &&
+          open_support_ticket_channel == o.open_support_ticket_channel &&
+          open_support_ticket_channel_email == o.open_support_ticket_channel_email &&
           pause_subscription == o.pause_subscription &&
           resume_subscription == o.resume_subscription &&
           transfer_chat_to_live_agent == o.transfer_chat_to_live_agent &&
@@ -145,7 +199,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card].hash
+      [cancel_subscription, delay_subscription, lookup_order_information, lookup_subscription_information, open_support_ticket, open_support_ticket_channel, open_support_ticket_channel_email, pause_subscription, resume_subscription, transfer_chat_to_live_agent, update_subscription_credit_card].hash
     end
 
     # Builds the object from hash

data/lib/ultracart_api/models/custom_report.rb

@@ -0,0 +1,271 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class CustomReport
+    attr_accessor :chart_javascript
+
+    attr_accessor :chart_javascript_url
+
+    attr_accessor :data_warehouse_report_config_oid
+
+    attr_accessor :dataset_security_level
+
+    attr_accessor :group_name
+
+    attr_accessor :merchant_id
+
+    attr_accessor :name
+
+    attr_accessor :parameters
+
+    attr_accessor :queries
+
+    attr_accessor :tooltips
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'chart_javascript' => :'chart_javascript',
+        :'chart_javascript_url' => :'chart_javascript_url',
+        :'data_warehouse_report_config_oid' => :'data_warehouse_report_config_oid',
+        :'dataset_security_level' => :'dataset_security_level',
+        :'group_name' => :'group_name',
+        :'merchant_id' => :'merchant_id',
+        :'name' => :'name',
+        :'parameters' => :'parameters',
+        :'queries' => :'queries',
+        :'tooltips' => :'tooltips'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'chart_javascript' => :'String',
+        :'chart_javascript_url' => :'String',
+        :'data_warehouse_report_config_oid' => :'Integer',
+        :'dataset_security_level' => :'String',
+        :'group_name' => :'String',
+        :'merchant_id' => :'String',
+        :'name' => :'String',
+        :'parameters' => :'Array<CustomReportParameter>',
+        :'queries' => :'Array<CustomReportQuery>',
+        :'tooltips' => :'Array<CustomReportTooltip>'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'chart_javascript')
+        self.chart_javascript = attributes[:'chart_javascript']
+      end
+
+      if attributes.has_key?(:'chart_javascript_url')
+        self.chart_javascript_url = attributes[:'chart_javascript_url']
+      end
+
+      if attributes.has_key?(:'data_warehouse_report_config_oid')
+        self.data_warehouse_report_config_oid = attributes[:'data_warehouse_report_config_oid']
+      end
+
+      if attributes.has_key?(:'dataset_security_level')
+        self.dataset_security_level = attributes[:'dataset_security_level']
+      end
+
+      if attributes.has_key?(:'group_name')
+        self.group_name = attributes[:'group_name']
+      end
+
+      if attributes.has_key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'parameters')
+        if (value = attributes[:'parameters']).is_a?(Array)
+          self.parameters = value
+        end
+      end
+
+      if attributes.has_key?(:'queries')
+        if (value = attributes[:'queries']).is_a?(Array)
+          self.queries = value
+        end
+      end
+
+      if attributes.has_key?(:'tooltips')
+        if (value = attributes[:'tooltips']).is_a?(Array)
+          self.tooltips = value
+        end
+      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 &&
+          chart_javascript == o.chart_javascript &&
+          chart_javascript_url == o.chart_javascript_url &&
+          data_warehouse_report_config_oid == o.data_warehouse_report_config_oid &&
+          dataset_security_level == o.dataset_security_level &&
+          group_name == o.group_name &&
+          merchant_id == o.merchant_id &&
+          name == o.name &&
+          parameters == o.parameters &&
+          queries == o.queries &&
+          tooltips == o.tooltips
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [chart_javascript, chart_javascript_url, data_warehouse_report_config_oid, dataset_security_level, group_name, merchant_id, name, parameters, queries, tooltips].hash
+    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)
+      self.class.swagger_types.each_pair do |key, type|
+        if 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 # or else data not found in attributes(hash), not an issue as the data can be optional
+      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 :DateTime
+        DateTime.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
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.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)
+        next if value.nil?
+        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