ynab 1.29.0 → 2.0.0.rc1

data/lib/ynab/models/hybrid_transaction.rb

@@ -1,16 +1,17 @@
 =begin
 #YNAB API Endpoints
 
-#Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.youneedabudget.com
+#Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
 
-OpenAPI spec version: 1.0.0
+The version of the OpenAPI document: 1.0.0
 
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-Swagger Codegen version: 2.4.14
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
 
 =end
 
 require 'date'
+require 'time'
 
 module YNAB
   class HybridTransaction
@@ -73,6 +74,7 @@ module YNAB
 
     attr_accessor :payee_name
 
+    # The name of the category.  If a split transaction, this will be 'Split'.
     attr_accessor :category_name
 
     class EnumAttributeValidator
@@ -126,15 +128,20 @@ module YNAB
       }
     end
 
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
     # Attribute type mapping.
-    def self.swagger_types
+    def self.openapi_types
       {
         :'id' => :'String',
         :'date' => :'Date',
         :'amount' => :'Integer',
         :'memo' => :'String',
         :'cleared' => :'String',
-        :'approved' => :'BOOLEAN',
+        :'approved' => :'Boolean',
         :'flag_color' => :'String',
         :'account_id' => :'String',
         :'payee_id' => :'String',
@@ -146,7 +153,7 @@ module YNAB
         :'import_payee_name' => :'String',
         :'import_payee_name_original' => :'String',
         :'debt_transaction_type' => :'String',
-        :'deleted' => :'BOOLEAN',
+        :'deleted' => :'Boolean',
         :'type' => :'String',
         :'parent_transaction_id' => :'String',
         :'account_name' => :'String',
@@ -155,103 +162,137 @@ module YNAB
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'memo',
+        :'flag_color',
+        :'payee_id',
+        :'category_id',
+        :'transfer_account_id',
+        :'transfer_transaction_id',
+        :'matched_transaction_id',
+        :'import_id',
+        :'import_payee_name',
+        :'import_payee_name_original',
+        :'debt_transaction_type',
+        :'parent_transaction_id',
+        :'payee_name',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'HybridTransactionAllOf',
+      :'TransactionSummary'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `YNAB::HybridTransaction` initialize method"
+      end
 
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+      # 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 `YNAB::HybridTransaction`. 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.has_key?(:'id')
+      if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
 
-      if attributes.has_key?(:'date')
+      if attributes.key?(:'date')
         self.date = attributes[:'date']
       end
 
-      if attributes.has_key?(:'amount')
+      if attributes.key?(:'amount')
         self.amount = attributes[:'amount']
       end
 
-      if attributes.has_key?(:'memo')
+      if attributes.key?(:'memo')
         self.memo = attributes[:'memo']
       end
 
-      if attributes.has_key?(:'cleared')
+      if attributes.key?(:'cleared')
         self.cleared = attributes[:'cleared']
       end
 
-      if attributes.has_key?(:'approved')
+      if attributes.key?(:'approved')
         self.approved = attributes[:'approved']
       end
 
-      if attributes.has_key?(:'flag_color')
+      if attributes.key?(:'flag_color')
         self.flag_color = attributes[:'flag_color']
       end
 
-      if attributes.has_key?(:'account_id')
+      if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
 
-      if attributes.has_key?(:'payee_id')
+      if attributes.key?(:'payee_id')
         self.payee_id = attributes[:'payee_id']
       end
 
-      if attributes.has_key?(:'category_id')
+      if attributes.key?(:'category_id')
         self.category_id = attributes[:'category_id']
       end
 
-      if attributes.has_key?(:'transfer_account_id')
+      if attributes.key?(:'transfer_account_id')
         self.transfer_account_id = attributes[:'transfer_account_id']
       end
 
-      if attributes.has_key?(:'transfer_transaction_id')
+      if attributes.key?(:'transfer_transaction_id')
         self.transfer_transaction_id = attributes[:'transfer_transaction_id']
       end
 
-      if attributes.has_key?(:'matched_transaction_id')
+      if attributes.key?(:'matched_transaction_id')
         self.matched_transaction_id = attributes[:'matched_transaction_id']
       end
 
-      if attributes.has_key?(:'import_id')
+      if attributes.key?(:'import_id')
         self.import_id = attributes[:'import_id']
       end
 
-      if attributes.has_key?(:'import_payee_name')
+      if attributes.key?(:'import_payee_name')
         self.import_payee_name = attributes[:'import_payee_name']
       end
 
-      if attributes.has_key?(:'import_payee_name_original')
+      if attributes.key?(:'import_payee_name_original')
         self.import_payee_name_original = attributes[:'import_payee_name_original']
       end
 
-      if attributes.has_key?(:'debt_transaction_type')
+      if attributes.key?(:'debt_transaction_type')
         self.debt_transaction_type = attributes[:'debt_transaction_type']
       end
 
-      if attributes.has_key?(:'deleted')
+      if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
 
-      if attributes.has_key?(:'type')
+      if attributes.key?(:'type')
         self.type = attributes[:'type']
       end
 
-      if attributes.has_key?(:'parent_transaction_id')
+      if attributes.key?(:'parent_transaction_id')
         self.parent_transaction_id = attributes[:'parent_transaction_id']
       end
 
-      if attributes.has_key?(:'account_name')
+      if attributes.key?(:'account_name')
         self.account_name = attributes[:'account_name']
       end
 
-      if attributes.has_key?(:'payee_name')
+      if attributes.key?(:'payee_name')
         self.payee_name = attributes[:'payee_name']
       end
 
-      if attributes.has_key?(:'category_name')
+      if attributes.key?(:'category_name')
         self.category_name = attributes[:'category_name']
       end
     end
@@ -306,17 +347,17 @@ module YNAB
       return false if @date.nil?
       return false if @amount.nil?
       return false if @cleared.nil?
-      cleared_validator = EnumAttributeValidator.new('String', ['cleared', 'uncleared', 'reconciled'])
+      cleared_validator = EnumAttributeValidator.new('String', ["cleared", "uncleared", "reconciled"])
       return false unless cleared_validator.valid?(@cleared)
       return false if @approved.nil?
-      flag_color_validator = EnumAttributeValidator.new('String', ['red', 'orange', 'yellow', 'green', 'blue', 'purple'])
+      flag_color_validator = EnumAttributeValidator.new('String', ["red", "orange", "yellow", "green", "blue", "purple", "null"])
       return false unless flag_color_validator.valid?(@flag_color)
       return false if @account_id.nil?
-      debt_transaction_type_validator = EnumAttributeValidator.new('String', ['payment', 'refund', 'fee', 'interest', 'escrow', 'balancedAdjustment', 'credit', 'charge'])
+      debt_transaction_type_validator = EnumAttributeValidator.new('String', ["payment", "refund", "fee", "interest", "escrow", "balancedAdjustment", "credit", "charge", "null"])
       return false unless debt_transaction_type_validator.valid?(@debt_transaction_type)
       return false if @deleted.nil?
       return false if @type.nil?
-      type_validator = EnumAttributeValidator.new('String', ['transaction', 'subtransaction'])
+      type_validator = EnumAttributeValidator.new('String', ["transaction", "subtransaction"])
       return false unless type_validator.valid?(@type)
       return false if @account_name.nil?
       true
@@ -325,24 +366,40 @@ module YNAB
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] cleared Object to be assigned
     def cleared=(cleared)
+      validator = EnumAttributeValidator.new('String', ["cleared", "uncleared", "reconciled"])
+      unless validator.valid?(cleared)
+        fail ArgumentError, "invalid value for \"cleared\", must be one of #{validator.allowable_values}."
+      end
       @cleared = cleared
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] flag_color Object to be assigned
     def flag_color=(flag_color)
+      validator = EnumAttributeValidator.new('String', ["red", "orange", "yellow", "green", "blue", "purple", "null"])
+      unless validator.valid?(flag_color)
+        fail ArgumentError, "invalid value for \"flag_color\", must be one of #{validator.allowable_values}."
+      end
       @flag_color = flag_color
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] debt_transaction_type Object to be assigned
     def debt_transaction_type=(debt_transaction_type)
+      validator = EnumAttributeValidator.new('String', ["payment", "refund", "fee", "interest", "escrow", "balancedAdjustment", "credit", "charge", "null"])
+      unless validator.valid?(debt_transaction_type)
+        fail ArgumentError, "invalid value for \"debt_transaction_type\", must be one of #{validator.allowable_values}."
+      end
       @debt_transaction_type = debt_transaction_type
     end
 
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] type Object to be assigned
     def type=(type)
+      validator = EnumAttributeValidator.new('String', ["transaction", "subtransaction"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
       @type = type
     end
 
@@ -383,17 +440,28 @@ module YNAB
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [id, date, amount, memo, cleared, approved, flag_color, account_id, payee_id, category_id, transfer_account_id, transfer_transaction_id, matched_transaction_id, import_id, import_payee_name, import_payee_name_original, debt_transaction_type, deleted, type, parent_transaction_id, account_name, payee_name, category_name].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)
-      self.class.swagger_types.each_pair do |key, type|
-        if type =~ /\AArray<(.*)>/i
+      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)
@@ -401,7 +469,7 @@ module YNAB
           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
       end
 
       self
@@ -413,8 +481,8 @@ module YNAB
     # @return [Object] Deserialized data
     def _deserialize(type, value)
       case type.to_sym
-      when :DateTime
-        DateTime.parse(value)
+      when :Time
+        Time.parse(value)
       when :Date
         Date.parse(value)
       when :String
@@ -423,7 +491,7 @@ module YNAB
         value.to_i
       when :Float
         value.to_f
-      when :BOOLEAN
+      when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
         else
@@ -444,8 +512,9 @@ module YNAB
           end
         end
       else # model
-        temp_model = YNAB.const_get(type).new
-        temp_model.build_from_hash(value)
+        # models (e.g. Pet) or oneOf
+        klass = YNAB.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 
@@ -467,7 +536,11 @@ module YNAB
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
-        next if value.nil?
+        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

data/lib/ynab/models/hybrid_transaction_all_of.rb

@@ -0,0 +1,304 @@
+=begin
+#YNAB API Endpoints
+
+#Our API uses a REST based design, leverages the JSON data format, and relies upon HTTPS for transport. We respond with meaningful HTTP response codes and if an error occurs, we include error details in the response body.  API Documentation is at https://api.ynab.com
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module YNAB
+  class HybridTransactionAllOf
+    # Whether the hybrid transaction represents a regular transaction or a subtransaction
+    attr_accessor :type
+
+    # For subtransaction types, this is the id of the parent transaction.  For transaction types, this id will be always be null.
+    attr_accessor :parent_transaction_id
+
+    attr_accessor :account_name
+
+    attr_accessor :payee_name
+
+    # The name of the category.  If a split transaction, this will be 'Split'.
+    attr_accessor :category_name
+
+    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
+      {
+        :'type' => :'type',
+        :'parent_transaction_id' => :'parent_transaction_id',
+        :'account_name' => :'account_name',
+        :'payee_name' => :'payee_name',
+        :'category_name' => :'category_name'
+      }
+    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
+      {
+        :'type' => :'String',
+        :'parent_transaction_id' => :'String',
+        :'account_name' => :'String',
+        :'payee_name' => :'String',
+        :'category_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'parent_transaction_id',
+        :'payee_name',
+      ])
+    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 `YNAB::HybridTransactionAllOf` 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 `YNAB::HybridTransactionAllOf`. 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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'parent_transaction_id')
+        self.parent_transaction_id = attributes[:'parent_transaction_id']
+      end
+
+      if attributes.key?(:'account_name')
+        self.account_name = attributes[:'account_name']
+      end
+
+      if attributes.key?(:'payee_name')
+        self.payee_name = attributes[:'payee_name']
+      end
+
+      if attributes.key?(:'category_name')
+        self.category_name = attributes[:'category_name']
+      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
+      if @type.nil?
+        invalid_properties.push('invalid value for "type", type cannot be nil.')
+      end
+
+      if @account_name.nil?
+        invalid_properties.push('invalid value for "account_name", account_name 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?
+      return false if @type.nil?
+      type_validator = EnumAttributeValidator.new('String', ["transaction", "subtransaction"])
+      return false unless type_validator.valid?(@type)
+      return false if @account_name.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["transaction", "subtransaction"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = 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 &&
+          type == o.type &&
+          parent_transaction_id == o.parent_transaction_id &&
+          account_name == o.account_name &&
+          payee_name == o.payee_name &&
+          category_name == o.category_name
+    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
+      [type, parent_transaction_id, account_name, payee_name, category_name].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 = YNAB.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