ynab 2.0.0 → 3.0.0

data/lib/ynab/models/existing_transaction.rb

@@ -0,0 +1,359 @@
+=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.69.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.6.0
+
+=end
+
+require 'date'
+require 'time'
+
+module YNAB
+  class ExistingTransaction
+    attr_accessor :account_id
+
+    # The transaction date in ISO format (e.g. 2016-12-01).  Future dates (scheduled transactions) are not permitted.  Split transaction dates cannot be changed and if a different date is supplied it will be ignored.
+    attr_accessor :date
+
+    # The transaction amount in milliunits format.  Split transaction amounts cannot be changed and if a different amount is supplied it will be ignored.
+    attr_accessor :amount
+
+    # The payee for the transaction.  To create a transfer between two accounts, use the account transfer payee pointing to the target account.  Account transfer payees are specified as `tranfer_payee_id` on the account resource.
+    attr_accessor :payee_id
+
+    # The payee name.  If a `payee_name` value is provided and `payee_id` has a null value, the `payee_name` value will be used to resolve the payee by either (1) a matching payee rename rule (only if `import_id` is also specified) or (2) a payee with the same name or (3) creation of a new payee.
+    attr_accessor :payee_name
+
+    # The category for the transaction.  To configure a split transaction, you can specify null for `category_id` and provide a `subtransactions` array as part of the transaction object.  If an existing transaction is a split, the `category_id` cannot be changed.  Credit Card Payment categories are not permitted and will be ignored if supplied.
+    attr_accessor :category_id
+
+    attr_accessor :memo
+
+    attr_accessor :cleared
+
+    # Whether or not the transaction is approved.  If not supplied, transaction will be unapproved by default.
+    attr_accessor :approved
+
+    attr_accessor :flag_color
+
+    # An array of subtransactions to configure a transaction as a split. Updating `subtransactions` on an existing split transaction is not supported.
+    attr_accessor :subtransactions
+
+    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
+      {
+        :'account_id' => :'account_id',
+        :'date' => :'date',
+        :'amount' => :'amount',
+        :'payee_id' => :'payee_id',
+        :'payee_name' => :'payee_name',
+        :'category_id' => :'category_id',
+        :'memo' => :'memo',
+        :'cleared' => :'cleared',
+        :'approved' => :'approved',
+        :'flag_color' => :'flag_color',
+        :'subtransactions' => :'subtransactions'
+      }
+    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
+      {
+        :'account_id' => :'String',
+        :'date' => :'Date',
+        :'amount' => :'Integer',
+        :'payee_id' => :'String',
+        :'payee_name' => :'String',
+        :'category_id' => :'String',
+        :'memo' => :'String',
+        :'cleared' => :'TransactionClearedStatus',
+        :'approved' => :'Boolean',
+        :'flag_color' => :'TransactionFlagColor',
+        :'subtransactions' => :'Array<SaveSubTransaction>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'payee_id',
+        :'payee_name',
+        :'category_id',
+        :'memo',
+        :'flag_color',
+      ])
+    end
+
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'SaveTransactionWithOptionalFields'
+      ]
+    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::ExistingTransaction` 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::ExistingTransaction`. 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?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'payee_id')
+        self.payee_id = attributes[:'payee_id']
+      end
+
+      if attributes.key?(:'payee_name')
+        self.payee_name = attributes[:'payee_name']
+      end
+
+      if attributes.key?(:'category_id')
+        self.category_id = attributes[:'category_id']
+      end
+
+      if attributes.key?(:'memo')
+        self.memo = attributes[:'memo']
+      end
+
+      if attributes.key?(:'cleared')
+        self.cleared = attributes[:'cleared']
+      end
+
+      if attributes.key?(:'approved')
+        self.approved = attributes[:'approved']
+      end
+
+      if attributes.key?(:'flag_color')
+        self.flag_color = attributes[:'flag_color']
+      end
+
+      if attributes.key?(:'subtransactions')
+        if (value = attributes[:'subtransactions']).is_a?(Array)
+          self.subtransactions = 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
+      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?
+      return false if !@payee_name.nil? && @payee_name.to_s.length > 50
+      return false if !@memo.nil? && @memo.to_s.length > 200
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] payee_name Value to be assigned
+    def payee_name=(payee_name)
+      @payee_name = payee_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] memo Value to be assigned
+    def memo=(memo)
+      @memo = memo
+    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_id == o.account_id &&
+          date == o.date &&
+          amount == o.amount &&
+          payee_id == o.payee_id &&
+          payee_name == o.payee_name &&
+          category_id == o.category_id &&
+          memo == o.memo &&
+          cleared == o.cleared &&
+          approved == o.approved &&
+          flag_color == o.flag_color &&
+          subtransactions == o.subtransactions
+    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_id, date, amount, payee_id, payee_name, category_id, memo, cleared, approved, flag_color, subtransactions].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 = YNAB.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

data/lib/ynab/models/hybrid_transaction.rb

@@ -3,10 +3,10 @@
 
 #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
+The version of the OpenAPI document: 1.69.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 6.6.0
+Generator version: 7.6.0
 
 =end
 
@@ -25,15 +25,16 @@ module YNAB
 
     attr_accessor :memo
 
-    # The cleared status of the transaction
     attr_accessor :cleared
 
     # Whether or not the transaction is approved
     attr_accessor :approved
 
-    # The transaction flag
     attr_accessor :flag_color
 
+    # The customized name of a transaction flag
+    attr_accessor :flag_name
+
     attr_accessor :account_id
 
     attr_accessor :payee_id
@@ -109,6 +110,7 @@ module YNAB
         :'cleared' => :'cleared',
         :'approved' => :'approved',
         :'flag_color' => :'flag_color',
+        :'flag_name' => :'flag_name',
         :'account_id' => :'account_id',
         :'payee_id' => :'payee_id',
         :'category_id' => :'category_id',
@@ -140,9 +142,10 @@ module YNAB
         :'date' => :'Date',
         :'amount' => :'Integer',
         :'memo' => :'String',
-        :'cleared' => :'String',
+        :'cleared' => :'TransactionClearedStatus',
         :'approved' => :'Boolean',
-        :'flag_color' => :'String',
+        :'flag_color' => :'TransactionFlagColor',
+        :'flag_name' => :'String',
         :'account_id' => :'String',
         :'payee_id' => :'String',
         :'category_id' => :'String',
@@ -167,6 +170,7 @@ module YNAB
       Set.new([
         :'memo',
         :'flag_color',
+        :'flag_name',
         :'payee_id',
         :'category_id',
         :'transfer_account_id',
@@ -184,7 +188,6 @@ module YNAB
     # List of class defined in allOf (OpenAPI v3)
     def self.openapi_all_of
       [
-      :'HybridTransactionAllOf',
       :'TransactionSummary'
       ]
     end
@@ -232,6 +235,10 @@ module YNAB
         self.flag_color = attributes[:'flag_color']
       end
 
+      if attributes.key?(:'flag_name')
+        self.flag_name = attributes[:'flag_name']
+      end
+
       if attributes.key?(:'account_id')
         self.account_id = attributes[:'account_id']
       end
@@ -301,42 +308,6 @@ module YNAB
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
-      if @date.nil?
-        invalid_properties.push('invalid value for "date", date cannot be nil.')
-      end
-
-      if @amount.nil?
-        invalid_properties.push('invalid value for "amount", amount cannot be nil.')
-      end
-
-      if @cleared.nil?
-        invalid_properties.push('invalid value for "cleared", cleared cannot be nil.')
-      end
-
-      if @approved.nil?
-        invalid_properties.push('invalid value for "approved", approved cannot be nil.')
-      end
-
-      if @account_id.nil?
-        invalid_properties.push('invalid value for "account_id", account_id cannot be nil.')
-      end
-
-      if @deleted.nil?
-        invalid_properties.push('invalid value for "deleted", deleted cannot be nil.')
-      end
-
-      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
 
@@ -347,13 +318,9 @@ 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"])
-      return false unless cleared_validator.valid?(@cleared)
       return false if @approved.nil?
-      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", "null"])
+      debt_transaction_type_validator = EnumAttributeValidator.new('String', ["payment", "refund", "fee", "interest", "escrow", "balanceAdjustment", "credit", "charge", "null"])
       return false unless debt_transaction_type_validator.valid?(@debt_transaction_type)
       return false if @deleted.nil?
       return false if @type.nil?
@@ -363,43 +330,15 @@ module YNAB
       true
     end
 
-    # 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
 
@@ -415,6 +354,7 @@ module YNAB
           cleared == o.cleared &&
           approved == o.approved &&
           flag_color == o.flag_color &&
+          flag_name == o.flag_name &&
           account_id == o.account_id &&
           payee_id == o.payee_id &&
           category_id == o.category_id &&
@@ -442,44 +382,37 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @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
+      [id, date, amount, memo, cleared, approved, flag_color, flag_name, 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)
       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)
+      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[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[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]]))
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
         end
       end
-
-      self
+      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 _deserialize(type, value)
+    def self._deserialize(type, value)
       case type.to_sym
       when :Time
         Time.parse(value)
@@ -514,7 +447,7 @@ module YNAB
       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)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
       end
     end
 

data/lib/ynab/models/hybrid_transaction_all_of.rb

@@ -125,14 +125,6 @@ module YNAB
     # @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
 
@@ -149,10 +141,6 @@ module YNAB
     # 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