zip_money 1.2.1

data/lib/zip_money/models/checkout_order.rb

@@ -0,0 +1,299 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'date'
+
+module ZipMoney
+
+  class CheckoutOrder
+    # The order id in the eCommerce system
+    attr_accessor :reference
+
+    # The total amount of the order
+    attr_accessor :amount
+
+    # The ISO-4217 currency code. See https://en.wikipedia.org/wiki/ISO_4217
+    attr_accessor :currency
+
+    attr_accessor :shipping
+
+    # The order item breakdown
+    attr_accessor :items
+
+    # The shopping cart reference id
+    attr_accessor :cart_reference
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reference' => :'reference',
+        :'amount' => :'amount',
+        :'currency' => :'currency',
+        :'shipping' => :'shipping',
+        :'items' => :'items',
+        :'cart_reference' => :'cart_reference'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.zip_types
+      {
+        :'reference' => :'String',
+        :'amount' => :'Float',
+        :'currency' => :'String',
+        :'shipping' => :'OrderShipping',
+        :'items' => :'Array<OrderItem>',
+        :'cart_reference' => :'String'
+      }
+    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?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.has_key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'shipping')
+        self.shipping = attributes[:'shipping']
+      end
+
+      if attributes.has_key?(:'items')
+        if (value = attributes[:'items']).is_a?(Array)
+          self.items = value
+        end
+      end
+
+      if attributes.has_key?(:'cart_reference')
+        self.cart_reference = attributes[:'cart_reference']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@reference.nil? && @reference.to_s.length > 200
+        invalid_properties.push("invalid value for 'reference', the character length must be smaller than or equal to 200.")
+      end
+
+      if @amount.nil?
+        invalid_properties.push("invalid value for 'amount', amount cannot be nil.")
+      end
+
+      if @amount < 0
+        invalid_properties.push("invalid value for 'amount', must be greater than or equal to 0.")
+      end
+
+      if @currency.nil?
+        invalid_properties.push("invalid value for 'currency', currency cannot be nil.")
+      end
+
+      if @shipping.nil?
+        invalid_properties.push("invalid value for 'shipping', shipping cannot be nil.")
+      end
+
+      if !@cart_reference.nil? && @cart_reference.to_s.length > 200
+        invalid_properties.push("invalid value for 'cart_reference', the character length must be smaller than or equal to 200.")
+      end
+
+      return 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 !@reference.nil? && @reference.to_s.length > 200
+      return false if @amount.nil?
+      return false if @amount < 0
+      return false if @currency.nil?
+      return false if @shipping.nil?
+      return false if !@cart_reference.nil? && @cart_reference.to_s.length > 200
+      return true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reference Value to be assigned
+    def reference=(reference)
+
+      if !reference.nil? && reference.to_s.length > 200
+        fail ArgumentError, "invalid value for 'reference', the character length must be smaller than or equal to 200."
+      end
+
+      @reference = reference
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        fail ArgumentError, "amount cannot be nil"
+      end
+
+      if amount < 0
+        fail ArgumentError, "invalid value for 'amount', must be greater than or equal to 0."
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] cart_reference Value to be assigned
+    def cart_reference=(cart_reference)
+
+      if !cart_reference.nil? && cart_reference.to_s.length > 200
+        fail ArgumentError, "invalid value for 'cart_reference', the character length must be smaller than or equal to 200."
+      end
+
+      @cart_reference = cart_reference
+    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 &&
+          reference == o.reference &&
+          amount == o.amount &&
+          currency == o.currency &&
+          shipping == o.shipping &&
+          items == o.items &&
+          cart_reference == o.cart_reference
+    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
+      [reference, amount, currency, shipping, items, cart_reference].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.zip_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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 = ZipMoney.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

data/lib/zip_money/models/create_charge_request.rb

@@ -0,0 +1,289 @@
+#Merchant API 
+#ZipMoney Merchant API Initial build
+#zipMoney Merchant API version: 2017-03-01
+
+
+require 'date'
+
+module ZipMoney
+
+  class CreateChargeRequest
+    attr_accessor :authority
+
+    # The reference for this charge (unique payment reference in your store)
+    attr_accessor :reference
+
+    # The amount of the charge
+    attr_accessor :amount
+
+    # The currency
+    attr_accessor :currency
+
+    # If true this will be a direct capture, pass false to perform an authorisation only
+    attr_accessor :capture
+
+    attr_accessor :order
+
+    attr_accessor :metadata
+
+    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
+      {
+        :'authority' => :'authority',
+        :'reference' => :'reference',
+        :'amount' => :'amount',
+        :'currency' => :'currency',
+        :'capture' => :'capture',
+        :'order' => :'order',
+        :'metadata' => :'metadata'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.zip_types
+      {
+        :'authority' => :'Authority',
+        :'reference' => :'String',
+        :'amount' => :'Float',
+        :'currency' => :'String',
+        :'capture' => :'BOOLEAN',
+        :'order' => :'ChargeOrder',
+        :'metadata' => :'Object'
+      }
+    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?(:'authority')
+        self.authority = attributes[:'authority']
+      end
+
+      if attributes.has_key?(:'reference')
+        self.reference = attributes[:'reference']
+      end
+
+      if attributes.has_key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'capture')
+        self.capture = attributes[:'capture']
+      else
+        self.capture = true
+      end
+
+      if attributes.has_key?(:'order')
+        self.order = attributes[:'order']
+      end
+
+      if attributes.has_key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @authority.nil?
+        invalid_properties.push("invalid value for 'authority', authority cannot be nil.")
+      end
+
+      if @amount.nil?
+        invalid_properties.push("invalid value for 'amount', amount cannot be nil.")
+      end
+
+      if @currency.nil?
+        invalid_properties.push("invalid value for 'currency', currency cannot be nil.")
+      end
+
+      return 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 @authority.nil?
+      return false if @amount.nil?
+      return false if @currency.nil?
+      currency_validator = EnumAttributeValidator.new('String', ["AUD", "NZD"])
+      return false unless currency_validator.valid?(@currency)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] currency Object to be assigned
+    def currency=(currency)
+      validator = EnumAttributeValidator.new('String', ["AUD", "NZD"])
+      unless validator.valid?(currency)
+        fail ArgumentError, "invalid value for 'currency', must be one of #{validator.allowable_values}."
+      end
+      @currency = currency
+    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 &&
+          authority == o.authority &&
+          reference == o.reference &&
+          amount == o.amount &&
+          currency == o.currency &&
+          capture == o.capture &&
+          order == o.order &&
+          metadata == o.metadata
+    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
+      [authority, reference, amount, currency, capture, order, metadata].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.zip_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the 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 = ZipMoney.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