togai_client 1.0.1 → 1.0.2

data/lib/togai_client/models/create_payment_request.rb

@@ -0,0 +1,394 @@
+=begin
+#Togai Apis
+
+#APIs for Togai App
+
+The version of the OpenAPI document: 1.0
+Contact: engg@togai.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TogaiClient
+  # payload to create payment
+  class CreatePaymentRequest
+    # A brief description of the payment
+    attr_accessor :description
+
+    # A detailed note about the payment
+    attr_accessor :notes
+
+    attr_accessor :account_id
+
+    attr_accessor :external_payment_reference
+
+    attr_accessor :line_item_records
+
+    attr_accessor :currency
+
+    attr_accessor :total_amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'description' => :'description',
+        :'notes' => :'notes',
+        :'account_id' => :'accountId',
+        :'external_payment_reference' => :'externalPaymentReference',
+        :'line_item_records' => :'lineItemRecords',
+        :'currency' => :'currency',
+        :'total_amount' => :'totalAmount'
+      }
+    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
+      {
+        :'description' => :'String',
+        :'notes' => :'String',
+        :'account_id' => :'String',
+        :'external_payment_reference' => :'ExternalPaymentReference',
+        :'line_item_records' => :'Array<PaymentLineItemRecord>',
+        :'currency' => :'String',
+        :'total_amount' => :'Float'
+      }
+    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 `TogaiClient::CreatePaymentRequest` 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 `TogaiClient::CreatePaymentRequest`. 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?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'notes')
+        self.notes = attributes[:'notes']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      else
+        self.account_id = nil
+      end
+
+      if attributes.key?(:'external_payment_reference')
+        self.external_payment_reference = attributes[:'external_payment_reference']
+      else
+        self.external_payment_reference = nil
+      end
+
+      if attributes.key?(:'line_item_records')
+        if (value = attributes[:'line_item_records']).is_a?(Array)
+          self.line_item_records = value
+        end
+      else
+        self.line_item_records = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = nil
+      end
+
+      if attributes.key?(:'total_amount')
+        self.total_amount = attributes[:'total_amount']
+      else
+        self.total_amount = nil
+      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 !@description.nil? && @description.to_s.length > 512
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 512.')
+      end
+
+      if !@notes.nil? && @notes.to_s.length > 512
+        invalid_properties.push('invalid value for "notes", the character length must be smaller than or equal to 512.')
+      end
+
+      if @account_id.nil?
+        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
+      end
+
+      if @account_id.to_s.length > 512
+        invalid_properties.push('invalid value for "account_id", the character length must be smaller than or equal to 512.')
+      end
+
+      if @external_payment_reference.nil?
+        invalid_properties.push('invalid value for "external_payment_reference", external_payment_reference cannot be nil.')
+      end
+
+      if @line_item_records.nil?
+        invalid_properties.push('invalid value for "line_item_records", line_item_records cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency cannot be nil.')
+      end
+
+      if @currency.to_s.length > 512
+        invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 512.')
+      end
+
+      if @total_amount.nil?
+        invalid_properties.push('invalid value for "total_amount", total_amount cannot be nil.')
+      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 !@description.nil? && @description.to_s.length > 512
+      return false if !@notes.nil? && @notes.to_s.length > 512
+      return false if @account_id.nil?
+      return false if @account_id.to_s.length > 512
+      return false if @external_payment_reference.nil?
+      return false if @line_item_records.nil?
+      return false if @currency.nil?
+      return false if @currency.to_s.length > 512
+      return false if @total_amount.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 512
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 512.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] notes Value to be assigned
+    def notes=(notes)
+      if notes.nil?
+        fail ArgumentError, 'notes cannot be nil'
+      end
+
+      if notes.to_s.length > 512
+        fail ArgumentError, 'invalid value for "notes", the character length must be smaller than or equal to 512.'
+      end
+
+      @notes = notes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] account_id Value to be assigned
+    def account_id=(account_id)
+      if account_id.nil?
+        fail ArgumentError, 'account_id cannot be nil'
+      end
+
+      if account_id.to_s.length > 512
+        fail ArgumentError, 'invalid value for "account_id", the character length must be smaller than or equal to 512.'
+      end
+
+      @account_id = account_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] line_item_records Value to be assigned
+    def line_item_records=(line_item_records)
+      if line_item_records.nil?
+        fail ArgumentError, 'line_item_records cannot be nil'
+      end
+
+      @line_item_records = line_item_records
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if currency.nil?
+        fail ArgumentError, 'currency cannot be nil'
+      end
+
+      if currency.to_s.length > 512
+        fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 512.'
+      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 &&
+          description == o.description &&
+          notes == o.notes &&
+          account_id == o.account_id &&
+          external_payment_reference == o.external_payment_reference &&
+          line_item_records == o.line_item_records &&
+          currency == o.currency &&
+          total_amount == o.total_amount
+    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
+      [description, notes, account_id, external_payment_reference, line_item_records, currency, total_amount].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 = TogaiClient.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