checkbook 1.0.1

data/lib/checkbook/models/create_instant_check_request.rb

@@ -0,0 +1,487 @@
+=begin
+#Checkbook API
+
+#The Checkbook API enables businesses to programmatically send and receive payments using digital checks and other payment methods. With Checkbook, you can automate payment workflows, disburse funds instantly, and manage transactions securely—all without the delays and costs of traditional paper checks.
+
+The version of the OpenAPI document: 3.0.0
+Contact: support@checkbook.io
+Generated by: https://openapi-generator.tech
+Generator version: 7.16.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Checkbook
+  class CreateInstantCheckRequest
+    # Debit account id for funds (if sender has multiple bank accounts)
+    attr_accessor :account
+
+    # Payment amount
+    attr_accessor :amount
+
+    attr_accessor :attachment
+
+    # Card number
+    attr_accessor :card_number
+
+    # Comment field for payment
+    attr_accessor :comment
+
+    # Optional description/memo for payment
+    attr_accessor :description
+
+    # Card expiration date
+    attr_accessor :expiration_date
+
+    # Name of recipient
+    attr_accessor :name
+
+    attr_accessor :number
+
+    # Email or text enabled phone number/id of recipient
+    attr_accessor :recipient
+
+    # List of the remittance records
+    attr_accessor :remittance_advice
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'account' => :'account',
+        :'amount' => :'amount',
+        :'attachment' => :'attachment',
+        :'card_number' => :'card_number',
+        :'comment' => :'comment',
+        :'description' => :'description',
+        :'expiration_date' => :'expiration_date',
+        :'name' => :'name',
+        :'number' => :'number',
+        :'recipient' => :'recipient',
+        :'remittance_advice' => :'remittance_advice'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'account' => :'String',
+        :'amount' => :'Float',
+        :'attachment' => :'CreateDigitalCheckRequestAttachment',
+        :'card_number' => :'String',
+        :'comment' => :'String',
+        :'description' => :'String',
+        :'expiration_date' => :'String',
+        :'name' => :'String',
+        :'number' => :'CreateDirectCheckRequestNumber',
+        :'recipient' => :'String',
+        :'remittance_advice' => :'Array<RemittanceAdvice>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'comment',
+        :'description',
+      ])
+    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 `Checkbook::CreateInstantCheckRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Checkbook::CreateInstantCheckRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'account')
+        self.account = attributes[:'account']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'attachment')
+        self.attachment = attributes[:'attachment']
+      end
+
+      if attributes.key?(:'card_number')
+        self.card_number = attributes[:'card_number']
+      else
+        self.card_number = nil
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'expiration_date')
+        self.expiration_date = attributes[:'expiration_date']
+      else
+        self.expiration_date = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.key?(:'recipient')
+        self.recipient = attributes[:'recipient']
+      else
+        self.recipient = nil
+      end
+
+      if attributes.key?(:'remittance_advice')
+        if (value = attributes[:'remittance_advice']).is_a?(Array)
+          self.remittance_advice = 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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
+      end
+
+      if @amount < 0.01
+        invalid_properties.push('invalid value for "amount", must be greater than or equal to 0.01.')
+      end
+
+      if @card_number.nil?
+        invalid_properties.push('invalid value for "card_number", card_number cannot be nil.')
+      end
+
+      if !@comment.nil? && @comment.to_s.length > 1024
+        invalid_properties.push('invalid value for "comment", the character length must be smaller than or equal to 1024.')
+      end
+
+      if @expiration_date.nil?
+        invalid_properties.push('invalid value for "expiration_date", expiration_date cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 180
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 180.')
+      end
+
+      if @name.to_s.length < 2
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 2.')
+      end
+
+      if @recipient.nil?
+        invalid_properties.push('invalid value for "recipient", recipient cannot be nil.')
+      end
+
+      if @recipient.to_s.length > 80
+        invalid_properties.push('invalid value for "recipient", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@remittance_advice.nil? && @remittance_advice.length > 50
+        invalid_properties.push('invalid value for "remittance_advice", number of items must be less than or equal to 50.')
+      end
+
+      if !@remittance_advice.nil? && @remittance_advice.length < 1
+        invalid_properties.push('invalid value for "remittance_advice", number of items must be greater than or equal to 1.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @amount.nil?
+      return false if @amount < 0.01
+      return false if @card_number.nil?
+      return false if !@comment.nil? && @comment.to_s.length > 1024
+      return false if @expiration_date.nil?
+      return false if @name.nil?
+      return false if @name.to_s.length > 180
+      return false if @name.to_s.length < 2
+      return false if @recipient.nil?
+      return false if @recipient.to_s.length > 80
+      return false if !@remittance_advice.nil? && @remittance_advice.length > 50
+      return false if !@remittance_advice.nil? && @remittance_advice.length < 1
+      true
+    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.01
+        fail ArgumentError, 'invalid value for "amount", must be greater than or equal to 0.01.'
+      end
+
+      @amount = amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_number Value to be assigned
+    def card_number=(card_number)
+      if card_number.nil?
+        fail ArgumentError, 'card_number cannot be nil'
+      end
+
+      @card_number = card_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comment Value to be assigned
+    def comment=(comment)
+      if !comment.nil? && comment.to_s.length > 1024
+        fail ArgumentError, 'invalid value for "comment", the character length must be smaller than or equal to 1024.'
+      end
+
+      @comment = comment
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expiration_date Value to be assigned
+    def expiration_date=(expiration_date)
+      if expiration_date.nil?
+        fail ArgumentError, 'expiration_date cannot be nil'
+      end
+
+      @expiration_date = expiration_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 180
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 180.'
+      end
+
+      if name.to_s.length < 2
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 2.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] recipient Value to be assigned
+    def recipient=(recipient)
+      if recipient.nil?
+        fail ArgumentError, 'recipient cannot be nil'
+      end
+
+      if recipient.to_s.length > 80
+        fail ArgumentError, 'invalid value for "recipient", the character length must be smaller than or equal to 80.'
+      end
+
+      @recipient = recipient
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] remittance_advice Value to be assigned
+    def remittance_advice=(remittance_advice)
+      if remittance_advice.nil?
+        fail ArgumentError, 'remittance_advice cannot be nil'
+      end
+
+      if remittance_advice.length > 50
+        fail ArgumentError, 'invalid value for "remittance_advice", number of items must be less than or equal to 50.'
+      end
+
+      if remittance_advice.length < 1
+        fail ArgumentError, 'invalid value for "remittance_advice", number of items must be greater than or equal to 1.'
+      end
+
+      @remittance_advice = remittance_advice
+    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 &&
+          account == o.account &&
+          amount == o.amount &&
+          attachment == o.attachment &&
+          card_number == o.card_number &&
+          comment == o.comment &&
+          description == o.description &&
+          expiration_date == o.expiration_date &&
+          name == o.name &&
+          number == o.number &&
+          recipient == o.recipient &&
+          remittance_advice == o.remittance_advice
+    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
+      [account, amount, attachment, card_number, comment, description, expiration_date, name, number, recipient, remittance_advice].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = ::Checkbook.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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