ultracart_api 4.1.14 → 4.1.16

data/lib/ultracart_api/api/order_api.rb

@@ -102,6 +102,73 @@ module UltracartClient
       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 [String] 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 [String] 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, Integer, 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' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'block_reason'] = opts[:'block_reason'] if !opts[:'block_reason'].nil?
+
+      # 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.block_refund_on_order",
+        :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: 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 [String] The order id to cancel.
@@ -1579,97 +1646,6 @@ module UltracartClient
       return data, status_code, headers
     end
 
-    # Refund an order completely
-    # Perform a refund operation on an order and then update the order if successful. 
-    # @param order_id [String] The order id to refund.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
-    # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
-    # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
-    # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
-    # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
-    # @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
-    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
-    # @option opts [String] :refund_reason Reason for refund
-    # @option opts [String] :reject_reason Reason for reject
-    # @return [OrderResponse]
-    def refund_order_completely(order_id, opts = {})
-      data, _status_code, _headers = refund_order_completely_with_http_info(order_id, opts)
-      data
-    end
-
-    # Refund an order completely
-    # Perform a refund operation on an order and then update the order if successful. 
-    # @param order_id [String] The order id to refund.
-    # @param [Hash] opts the optional parameters
-    # @option opts [Boolean] :reject_after_refund Reject order after refund (default to false)
-    # @option opts [Boolean] :skip_customer_notification Skip customer email notification (default to false)
-    # @option opts [Boolean] :auto_order_cancel Cancel associated auto orders (default to false)
-    # @option opts [Boolean] :manual_refund Consider a manual refund done externally (default to false)
-    # @option opts [Boolean] :reverse_affiliate_transactions Reverse affiliate transactions (default to true)
-    # @option opts [Boolean] :issue_store_credit Issue a store credit instead of refunding the original payment method, loyalty must be configured on merchant account (default to false)
-    # @option opts [String] :auto_order_cancel_reason Reason for auto orders cancellation
-    # @option opts [String] :refund_reason Reason for refund
-    # @option opts [String] :reject_reason Reason for reject
-    # @return [Array<(OrderResponse, Integer, Hash)>] OrderResponse data, response status code and response headers
-    def refund_order_completely_with_http_info(order_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: OrderApi.refund_order_completely ...'
-      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.refund_order_completely"
-      end
-      # resource path
-      local_var_path = '/order/orders/{order_id}/refund_completely'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
-
-      # query parameters
-      query_params = opts[:query_params] || {}
-      query_params[:'reject_after_refund'] = opts[:'reject_after_refund'] if !opts[:'reject_after_refund'].nil?
-      query_params[:'skip_customer_notification'] = opts[:'skip_customer_notification'] if !opts[:'skip_customer_notification'].nil?
-      query_params[:'auto_order_cancel'] = opts[:'auto_order_cancel'] if !opts[:'auto_order_cancel'].nil?
-      query_params[:'manual_refund'] = opts[:'manual_refund'] if !opts[:'manual_refund'].nil?
-      query_params[:'reverse_affiliate_transactions'] = opts[:'reverse_affiliate_transactions'] if !opts[:'reverse_affiliate_transactions'].nil?
-      query_params[:'issue_store_credit'] = opts[:'issue_store_credit'] if !opts[:'issue_store_credit'].nil?
-      query_params[:'auto_order_cancel_reason'] = opts[:'auto_order_cancel_reason'] if !opts[:'auto_order_cancel_reason'].nil?
-      query_params[:'refund_reason'] = opts[:'refund_reason'] if !opts[:'refund_reason'].nil?
-      query_params[:'reject_reason'] = opts[:'reject_reason'] if !opts[:'reject_reason'].nil?
-
-      # 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] || 'OrderResponse'
-
-      # auth_names
-      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
-
-      new_options = opts.merge(
-        :operation => :"OrderApi.refund_order_completely",
-        :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(:PUT, local_var_path, new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: OrderApi#refund_order_completely\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Replacement order
     # Create a replacement order based upon a previous order 
     # @param order_id [String] The order id to generate a replacement for.
@@ -1873,6 +1849,70 @@ module UltracartClient
       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 [String] 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 [String] The order id to unblock a refund on.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, 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' + '}', CGI.escape(order_id.to_s))
+
+      # 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]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.unblock_refund_on_order",
+        :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: 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] AccountsReceivableRetryConfig object

data/lib/ultracart_api/api/webhook_api.rb

@@ -239,14 +239,6 @@ module UltracartClient
     # Retrieves the log summary information for a given webhook.  This is useful for displaying all the various logs that can be viewed. 
     # @param webhook_oid [Integer] The webhook oid to retrieve log summaries for.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :request_id 
-    # @option opts [String] :begin_date 
-    # @option opts [String] :end_date 
-    # @option opts [String] :status 
-    # @option opts [String] :event 
-    # @option opts [String] :order_id 
-    # @option opts [String] :request 
-    # @option opts [Integer] :duration 
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (default to 100)
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
     # @option opts [String] :_since Fetch log summaries that have been delivered since this date/time.
@@ -260,14 +252,6 @@ module UltracartClient
     # Retrieves the log summary information for a given webhook.  This is useful for displaying all the various logs that can be viewed. 
     # @param webhook_oid [Integer] The webhook oid to retrieve log summaries for.
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :request_id 
-    # @option opts [String] :begin_date 
-    # @option opts [String] :end_date 
-    # @option opts [String] :status 
-    # @option opts [String] :event 
-    # @option opts [String] :order_id 
-    # @option opts [String] :request 
-    # @option opts [Integer] :duration 
     # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (default to 100)
     # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
     # @option opts [String] :_since Fetch log summaries that have been delivered since this date/time.
@@ -285,14 +269,6 @@ module UltracartClient
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'requestId'] = opts[:'request_id'] if !opts[:'request_id'].nil?
-      query_params[:'beginDate'] = opts[:'begin_date'] if !opts[:'begin_date'].nil?
-      query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil?
-      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
-      query_params[:'event'] = opts[:'event'] if !opts[:'event'].nil?
-      query_params[:'orderId'] = opts[:'order_id'] if !opts[:'order_id'].nil?
-      query_params[:'request'] = opts[:'request'] if !opts[:'request'].nil?
-      query_params[:'duration'] = opts[:'duration'] if !opts[:'duration'].nil?
       query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
       query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
       query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?

data/lib/ultracart_api/models/cart_upsell_after.rb

@@ -21,15 +21,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
 
@@ -43,7 +51,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
 
@@ -79,6 +89,14 @@ module UltracartClient
       if attributes.key?(:'upsell_path_code')
         self.upsell_path_code = attributes[:'upsell_path_code']
       end
+
+      if attributes.key?(:'upsell_path_name')
+        self.upsell_path_name = attributes[:'upsell_path_name']
+      end
+
+      if attributes.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?
@@ -116,7 +134,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
@@ -128,7 +148,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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

@@ -25,6 +25,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
@@ -33,6 +39,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
       {
@@ -41,6 +69,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',
@@ -61,6 +91,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',
@@ -109,6 +141,14 @@ module UltracartClient
         self.open_support_ticket = attributes[:'open_support_ticket']
       end
 
+      if attributes.key?(:'open_support_ticket_channel')
+        self.open_support_ticket_channel = attributes[:'open_support_ticket_channel']
+      end
+
+      if attributes.key?(:'open_support_ticket_channel_email')
+        self.open_support_ticket_channel_email = attributes[:'open_support_ticket_channel_email']
+      end
+
       if attributes.key?(:'pause_subscription')
         self.pause_subscription = attributes[:'pause_subscription']
       end
@@ -136,9 +176,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)
@@ -149,6 +201,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 &&
@@ -164,7 +218,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] 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