ultracart_api 4.1.121 → 4.1.124

data/lib/ultracart_api/api/auto_order_api.rb

@@ -32,6 +32,73 @@ module UltracartClient
       UltracartClient::AutoOrderApi.new(api_client)
     end
 
+    # Attempt a failed rebill on an auto order
+    # Attempts to rebill an auto order using the payment information already on the original order.  The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging.  Runs synchronously and may take some time while the gateway is contacted.  A declined card is reported in the response body rather than as an API error. 
+    # @param auto_order_oid [Integer] The auto order oid to rebill.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [AutoOrderRebillResponse]
+    def attempt_auto_order_rebill(auto_order_oid, opts = {})
+      data, _status_code, _headers = attempt_auto_order_rebill_with_http_info(auto_order_oid, opts)
+      data
+    end
+
+    # Attempt a failed rebill on an auto order
+    # Attempts to rebill an auto order using the payment information already on the original order.  The attempt is refused if the auto order is scheduled to charge within the next five minutes, or if it was already billed within the last 24 hours, both of which guard against double charging.  Runs synchronously and may take some time while the gateway is contacted.  A declined card is reported in the response body rather than as an API error. 
+    # @param auto_order_oid [Integer] The auto order oid to rebill.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(AutoOrderRebillResponse, Integer, Hash)>] AutoOrderRebillResponse data, response status code and response headers
+    def attempt_auto_order_rebill_with_http_info(auto_order_oid, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutoOrderApi.attempt_auto_order_rebill ...'
+      end
+      # verify the required parameter 'auto_order_oid' is set
+      if @api_client.config.client_side_validation && auto_order_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.attempt_auto_order_rebill"
+      end
+      # resource path
+      local_var_path = '/auto_order/auto_orders/{auto_order_oid}/rebill'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].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] || 'AutoOrderRebillResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AutoOrderApi.attempt_auto_order_rebill",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AutoOrderApi#attempt_auto_order_rebill\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Cancel a single item on an auto order
     # Cancels a single item on an auto order identified by the original order id and the item's original_item_id.  The request body may specify mode=_end (soft cancel by setting no_order_after_dts to the current time, preserving the row for reporting; this is the default when the body is omitted) or mode=remove (hard delete).  Returns the updated auto order based upon expansion. 
     # @param reference_order_id [String] The reference order id (original_order_id) of the auto order.
@@ -1187,6 +1254,84 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Update the payment information on an auto order
+    # Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order.  Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected.  Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted.  A declined card is reported in the response body rather than as an API error. 
+    # @param auto_order_oid [Integer] The auto order oid to update payment information on.
+    # @param auto_order_payment_update_request [AutoOrderPaymentUpdateRequest] Payment information to place on the auto order
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [AutoOrderRebillResponse]
+    def update_auto_order_payment(auto_order_oid, auto_order_payment_update_request, opts = {})
+      data, _status_code, _headers = update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts)
+      data
+    end
+
+    # Update the payment information on an auto order
+    # Updates the credit card on the original order behind an auto order, along with any rebills sitting in accounts receivable, and reactivates the auto order.  Card data is accepted as hosted field tokens only. raw card numbers and card verification numbers are rejected.  Set attempt_rebill to true to also attempt the rebill immediately, which runs synchronously and may take some time while the gateway is contacted.  A declined card is reported in the response body rather than as an API error. 
+    # @param auto_order_oid [Integer] The auto order oid to update payment information on.
+    # @param auto_order_payment_update_request [AutoOrderPaymentUpdateRequest] Payment information to place on the auto order
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @return [Array<(AutoOrderRebillResponse, Integer, Hash)>] AutoOrderRebillResponse data, response status code and response headers
+    def update_auto_order_payment_with_http_info(auto_order_oid, auto_order_payment_update_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AutoOrderApi.update_auto_order_payment ...'
+      end
+      # verify the required parameter 'auto_order_oid' is set
+      if @api_client.config.client_side_validation && auto_order_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'auto_order_oid' when calling AutoOrderApi.update_auto_order_payment"
+      end
+      # verify the required parameter 'auto_order_payment_update_request' is set
+      if @api_client.config.client_side_validation && auto_order_payment_update_request.nil?
+        fail ArgumentError, "Missing the required parameter 'auto_order_payment_update_request' when calling AutoOrderApi.update_auto_order_payment"
+      end
+      # resource path
+      local_var_path = '/auto_order/auto_orders/{auto_order_oid}/payment'.sub('{' + 'auto_order_oid' + '}', CGI.escape(auto_order_oid.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(auto_order_payment_update_request)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'AutoOrderRebillResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"AutoOrderApi.update_auto_order_payment",
+        :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: AutoOrderApi#update_auto_order_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update an auto order properties
     # Update an auto order properties.  Returns the auto order based upon expansion 
     # @param auto_order_oid [Integer] The auto order oid to update.

data/lib/ultracart_api/api/customer_api.rb

@@ -1790,6 +1790,81 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Clear email suppression for a customer
+    # Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer's original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case. 
+    # @param customer_profile_oid [Integer] The customer profile oid
+    # @param suppression_changes [CustomerEmailSuppressionRequest] Suppression changes
+    # @param [Hash] opts the optional parameters
+    # @return [CustomerEmailSuppressionResponse]
+    def update_customer_email_suppression(customer_profile_oid, suppression_changes, opts = {})
+      data, _status_code, _headers = update_customer_email_suppression_with_http_info(customer_profile_oid, suppression_changes, opts)
+      data
+    end
+
+    # Clear email suppression for a customer
+    # Clears global unsubscribe, spam complaint and/or bounce suppression for a customer.  This method is clear-only and cannot set a suppression flag.  Clearing a suppression removes the send gate but does not subscribe the customer to any email list -- list membership survives a global unsubscribe untouched, so the customer's original lists become deliverable again with no further action.  Returns 200 with a warning if the flags were cleared but an upstream ESP suppression removal failed; the profile was still modified in that case. 
+    # @param customer_profile_oid [Integer] The customer profile oid
+    # @param suppression_changes [CustomerEmailSuppressionRequest] Suppression changes
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CustomerEmailSuppressionResponse, Integer, Hash)>] CustomerEmailSuppressionResponse data, response status code and response headers
+    def update_customer_email_suppression_with_http_info(customer_profile_oid, suppression_changes, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CustomerApi.update_customer_email_suppression ...'
+      end
+      # verify the required parameter 'customer_profile_oid' is set
+      if @api_client.config.client_side_validation && customer_profile_oid.nil?
+        fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.update_customer_email_suppression"
+      end
+      # verify the required parameter 'suppression_changes' is set
+      if @api_client.config.client_side_validation && suppression_changes.nil?
+        fail ArgumentError, "Missing the required parameter 'suppression_changes' when calling CustomerApi.update_customer_email_suppression"
+      end
+      # resource path
+      local_var_path = '/customer/customers/{customer_profile_oid}/email_suppression'.sub('{' + 'customer_profile_oid' + '}', CGI.escape(customer_profile_oid.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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(suppression_changes)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'CustomerEmailSuppressionResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"CustomerApi.update_customer_email_suppression",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomerApi#update_customer_email_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Update a customer wishlist item
     # Update a customer wishlist item 
     # @param customer_profile_oid [Integer] The customer oid for this wishlist.

data/lib/ultracart_api/models/auto_order_payment_update_request.rb

@@ -0,0 +1,304 @@
+=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 AutoOrderPaymentUpdateRequest
+    # Attempt to rebill the auto order immediately after the payment information is updated.  Defaults to false.
+    attr_accessor :attempt_rebill
+
+    # Card expiration month (1-12)
+    attr_accessor :card_expiration_month
+
+    # Card expiration year (four digit)
+    attr_accessor :card_expiration_year
+
+    # Hosted field token for the credit card number.  Tokens are valid for two hours.
+    attr_accessor :card_number_token
+
+    # Credit card type.  Optional.  When the hosted field token carries the card type, the token wins.
+    attr_accessor :card_type
+
+    # Hosted field token for the card verification number (CVV).  Required when the order has a vaulted card that must be re-vaulted.
+    attr_accessor :card_verification_number_token
+
+    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
+      {
+        :'attempt_rebill' => :'attempt_rebill',
+        :'card_expiration_month' => :'card_expiration_month',
+        :'card_expiration_year' => :'card_expiration_year',
+        :'card_number_token' => :'card_number_token',
+        :'card_type' => :'card_type',
+        :'card_verification_number_token' => :'card_verification_number_token'
+      }
+    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
+      {
+        :'attempt_rebill' => :'Boolean',
+        :'card_expiration_month' => :'Integer',
+        :'card_expiration_year' => :'Integer',
+        :'card_number_token' => :'String',
+        :'card_type' => :'String',
+        :'card_verification_number_token' => :'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::AutoOrderPaymentUpdateRequest` 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::AutoOrderPaymentUpdateRequest`. 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?(:'attempt_rebill')
+        self.attempt_rebill = attributes[:'attempt_rebill']
+      end
+
+      if attributes.key?(:'card_expiration_month')
+        self.card_expiration_month = attributes[:'card_expiration_month']
+      end
+
+      if attributes.key?(:'card_expiration_year')
+        self.card_expiration_year = attributes[:'card_expiration_year']
+      end
+
+      if attributes.key?(:'card_number_token')
+        self.card_number_token = attributes[:'card_number_token']
+      end
+
+      if attributes.key?(:'card_type')
+        self.card_type = attributes[:'card_type']
+      end
+
+      if attributes.key?(:'card_verification_number_token')
+        self.card_verification_number_token = attributes[:'card_verification_number_token']
+      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?
+      card_type_validator = EnumAttributeValidator.new('String', ["AMEX", "Diners Club", "Discover", "JCB", "MasterCard", "VISA"])
+      return false unless card_type_validator.valid?(@card_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] card_type Object to be assigned
+    def card_type=(card_type)
+      validator = EnumAttributeValidator.new('String', ["AMEX", "Diners Club", "Discover", "JCB", "MasterCard", "VISA"])
+      unless validator.valid?(card_type)
+        fail ArgumentError, "invalid value for \"card_type\", must be one of #{validator.allowable_values}."
+      end
+      @card_type = card_type
+    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 &&
+          attempt_rebill == o.attempt_rebill &&
+          card_expiration_month == o.card_expiration_month &&
+          card_expiration_year == o.card_expiration_year &&
+          card_number_token == o.card_number_token &&
+          card_type == o.card_type &&
+          card_verification_number_token == o.card_verification_number_token
+    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
+      [attempt_rebill, card_expiration_month, card_expiration_year, card_number_token, card_type, card_verification_number_token].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