ynab 5.0.0 → 5.2.0

data/lib/ynab/models/account_base.rb

@@ -0,0 +1,340 @@
+=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
+
+Generated by: OpenAPI Generator (https://openapi-generator.tech)
+
+=end
+
+require 'date'
+require 'time'
+
+module YNAB
+  class AccountBase < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :type
+
+    # Whether this account is \"on budget\" or not
+    attr_accessor :on_budget
+
+    # Whether this account is closed or not
+    attr_accessor :closed
+
+    attr_accessor :note
+
+    # The current available balance of the account in milliunits format
+    attr_accessor :balance
+
+    # The current cleared balance of the account in milliunits format
+    attr_accessor :cleared_balance
+
+    # The current uncleared balance of the account in milliunits format
+    attr_accessor :uncleared_balance
+
+    # The payee id which should be used when transferring to this account
+    attr_accessor :transfer_payee_id
+
+    # Whether or not the account is linked to a financial institution for automatic transaction import.
+    attr_accessor :direct_import_linked
+
+    # If an account linked to a financial institution (direct_import_linked=true) and the linked connection is not in a healthy state, this will be true.
+    attr_accessor :direct_import_in_error
+
+    # A date/time specifying when the account was last reconciled.
+    attr_accessor :last_reconciled_at
+
+    # This field is deprecated and will always be null.
+    attr_accessor :debt_original_balance
+
+    attr_accessor :debt_interest_rates
+
+    attr_accessor :debt_minimum_payments
+
+    attr_accessor :debt_escrow_amounts
+
+    # Whether or not the account has been deleted.  Deleted accounts will only be included in delta requests.
+    attr_accessor :deleted
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'type' => :'type',
+        :'on_budget' => :'on_budget',
+        :'closed' => :'closed',
+        :'note' => :'note',
+        :'balance' => :'balance',
+        :'cleared_balance' => :'cleared_balance',
+        :'uncleared_balance' => :'uncleared_balance',
+        :'transfer_payee_id' => :'transfer_payee_id',
+        :'direct_import_linked' => :'direct_import_linked',
+        :'direct_import_in_error' => :'direct_import_in_error',
+        :'last_reconciled_at' => :'last_reconciled_at',
+        :'debt_original_balance' => :'debt_original_balance',
+        :'debt_interest_rates' => :'debt_interest_rates',
+        :'debt_minimum_payments' => :'debt_minimum_payments',
+        :'debt_escrow_amounts' => :'debt_escrow_amounts',
+        :'deleted' => :'deleted'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'type' => :'AccountType',
+        :'on_budget' => :'Boolean',
+        :'closed' => :'Boolean',
+        :'note' => :'String',
+        :'balance' => :'Integer',
+        :'cleared_balance' => :'Integer',
+        :'uncleared_balance' => :'Integer',
+        :'transfer_payee_id' => :'String',
+        :'direct_import_linked' => :'Boolean',
+        :'direct_import_in_error' => :'Boolean',
+        :'last_reconciled_at' => :'Time',
+        :'debt_original_balance' => :'Integer',
+        :'debt_interest_rates' => :'Hash<String, Integer>',
+        :'debt_minimum_payments' => :'Hash<String, Integer>',
+        :'debt_escrow_amounts' => :'Hash<String, Integer>',
+        :'deleted' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'note',
+        :'transfer_payee_id',
+        :'last_reconciled_at',
+        :'debt_original_balance',
+      ])
+    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::AccountBase` 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::AccountBase`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'on_budget')
+        self.on_budget = attributes[:'on_budget']
+      end
+
+      if attributes.key?(:'closed')
+        self.closed = attributes[:'closed']
+      end
+
+      if attributes.key?(:'note')
+        self.note = attributes[:'note']
+      end
+
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
+      end
+
+      if attributes.key?(:'cleared_balance')
+        self.cleared_balance = attributes[:'cleared_balance']
+      end
+
+      if attributes.key?(:'uncleared_balance')
+        self.uncleared_balance = attributes[:'uncleared_balance']
+      end
+
+      if attributes.key?(:'transfer_payee_id')
+        self.transfer_payee_id = attributes[:'transfer_payee_id']
+      end
+
+      if attributes.key?(:'direct_import_linked')
+        self.direct_import_linked = attributes[:'direct_import_linked']
+      end
+
+      if attributes.key?(:'direct_import_in_error')
+        self.direct_import_in_error = attributes[:'direct_import_in_error']
+      end
+
+      if attributes.key?(:'last_reconciled_at')
+        self.last_reconciled_at = attributes[:'last_reconciled_at']
+      end
+
+      if attributes.key?(:'debt_original_balance')
+        self.debt_original_balance = attributes[:'debt_original_balance']
+      end
+
+      if attributes.key?(:'debt_interest_rates')
+        if (value = attributes[:'debt_interest_rates']).is_a?(Hash)
+          self.debt_interest_rates = value
+        end
+      end
+
+      if attributes.key?(:'debt_minimum_payments')
+        if (value = attributes[:'debt_minimum_payments']).is_a?(Hash)
+          self.debt_minimum_payments = value
+        end
+      end
+
+      if attributes.key?(:'debt_escrow_amounts')
+        if (value = attributes[:'debt_escrow_amounts']).is_a?(Hash)
+          self.debt_escrow_amounts = value
+        end
+      end
+
+      if attributes.key?(:'deleted')
+        self.deleted = attributes[:'deleted']
+      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 @id.nil?
+      return false if @name.nil?
+      return false if @type.nil?
+      return false if @on_budget.nil?
+      return false if @closed.nil?
+      return false if @balance.nil?
+      return false if @cleared_balance.nil?
+      return false if @uncleared_balance.nil?
+      return false if @deleted.nil?
+      true
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          type == o.type &&
+          on_budget == o.on_budget &&
+          closed == o.closed &&
+          note == o.note &&
+          balance == o.balance &&
+          cleared_balance == o.cleared_balance &&
+          uncleared_balance == o.uncleared_balance &&
+          transfer_payee_id == o.transfer_payee_id &&
+          direct_import_linked == o.direct_import_linked &&
+          direct_import_in_error == o.direct_import_in_error &&
+          last_reconciled_at == o.last_reconciled_at &&
+          debt_original_balance == o.debt_original_balance &&
+          debt_interest_rates == o.debt_interest_rates &&
+          debt_minimum_payments == o.debt_minimum_payments &&
+          debt_escrow_amounts == o.debt_escrow_amounts &&
+          deleted == o.deleted
+    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
+      [id, name, type, on_budget, closed, note, balance, cleared_balance, uncleared_balance, transfer_payee_id, direct_import_linked, direct_import_in_error, last_reconciled_at, debt_original_balance, debt_interest_rates, debt_minimum_payments, debt_escrow_amounts, deleted].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
+
+    # 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
+  end
+
+end

data/lib/ynab/models/category.rb

@@ -23,6 +23,9 @@ module YNAB
     # Whether or not the category is hidden
     attr_accessor :hidden
 
+    # Whether or not the category is internal
+    attr_accessor :internal
+
     # DEPRECATED: No longer used.  Value will always be null.
     attr_accessor :original_category_group_id
 
@@ -85,6 +88,48 @@ module YNAB
     # Whether or not the category has been deleted.  Deleted categories will only be included in delta requests.
     attr_accessor :deleted
 
+    # Available balance of the category formatted in the plan's currency format
+    attr_accessor :balance_formatted
+
+    # Available balance of the category as a decimal currency amount
+    attr_accessor :balance_currency
+
+    # Activity of the category formatted in the plan's currency format
+    attr_accessor :activity_formatted
+
+    # Activity of the category as a decimal currency amount
+    attr_accessor :activity_currency
+
+    # Assigned (budgeted) amount of the category formatted in the plan's currency format
+    attr_accessor :budgeted_formatted
+
+    # Assigned (budgeted) amount of the category as a decimal currency amount
+    attr_accessor :budgeted_currency
+
+    # The goal target amount formatted in the plan's currency format
+    attr_accessor :goal_target_formatted
+
+    # The goal target amount as a decimal currency amount
+    attr_accessor :goal_target_currency
+
+    # The goal underfunded amount formatted in the plan's currency format
+    attr_accessor :goal_under_funded_formatted
+
+    # The goal underfunded amount as a decimal currency amount
+    attr_accessor :goal_under_funded_currency
+
+    # The total amount funded towards the goal formatted in the plan's currency format
+    attr_accessor :goal_overall_funded_formatted
+
+    # The total amount funded towards the goal as a decimal currency amount
+    attr_accessor :goal_overall_funded_currency
+
+    # The amount of funding still needed to complete the goal formatted in the plan's currency format
+    attr_accessor :goal_overall_left_formatted
+
+    # The amount of funding still needed to complete the goal as a decimal currency amount
+    attr_accessor :goal_overall_left_currency
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -115,6 +160,7 @@ module YNAB
         :'category_group_name' => :'category_group_name',
         :'name' => :'name',
         :'hidden' => :'hidden',
+        :'internal' => :'internal',
         :'original_category_group_id' => :'original_category_group_id',
         :'note' => :'note',
         :'budgeted' => :'budgeted',
@@ -135,7 +181,21 @@ module YNAB
         :'goal_overall_funded' => :'goal_overall_funded',
         :'goal_overall_left' => :'goal_overall_left',
         :'goal_snoozed_at' => :'goal_snoozed_at',
-        :'deleted' => :'deleted'
+        :'deleted' => :'deleted',
+        :'balance_formatted' => :'balance_formatted',
+        :'balance_currency' => :'balance_currency',
+        :'activity_formatted' => :'activity_formatted',
+        :'activity_currency' => :'activity_currency',
+        :'budgeted_formatted' => :'budgeted_formatted',
+        :'budgeted_currency' => :'budgeted_currency',
+        :'goal_target_formatted' => :'goal_target_formatted',
+        :'goal_target_currency' => :'goal_target_currency',
+        :'goal_under_funded_formatted' => :'goal_under_funded_formatted',
+        :'goal_under_funded_currency' => :'goal_under_funded_currency',
+        :'goal_overall_funded_formatted' => :'goal_overall_funded_formatted',
+        :'goal_overall_funded_currency' => :'goal_overall_funded_currency',
+        :'goal_overall_left_formatted' => :'goal_overall_left_formatted',
+        :'goal_overall_left_currency' => :'goal_overall_left_currency'
       }
     end
 
@@ -152,6 +212,7 @@ module YNAB
         :'category_group_name' => :'String',
         :'name' => :'String',
         :'hidden' => :'Boolean',
+        :'internal' => :'Boolean',
         :'original_category_group_id' => :'String',
         :'note' => :'String',
         :'budgeted' => :'Integer',
@@ -172,33 +233,46 @@ module YNAB
         :'goal_overall_funded' => :'Integer',
         :'goal_overall_left' => :'Integer',
         :'goal_snoozed_at' => :'Time',
-        :'deleted' => :'Boolean'
+        :'deleted' => :'Boolean',
+        :'balance_formatted' => :'String',
+        :'balance_currency' => :'Float',
+        :'activity_formatted' => :'String',
+        :'activity_currency' => :'Float',
+        :'budgeted_formatted' => :'String',
+        :'budgeted_currency' => :'Float',
+        :'goal_target_formatted' => :'String',
+        :'goal_target_currency' => :'Float',
+        :'goal_under_funded_formatted' => :'String',
+        :'goal_under_funded_currency' => :'Float',
+        :'goal_overall_funded_formatted' => :'String',
+        :'goal_overall_funded_currency' => :'Float',
+        :'goal_overall_left_formatted' => :'String',
+        :'goal_overall_left_currency' => :'Float'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'original_category_group_id',
-        :'note',
         :'goal_type',
-        :'goal_needs_whole_amount',
-        :'goal_day',
-        :'goal_cadence',
-        :'goal_cadence_frequency',
-        :'goal_creation_month',
-        :'goal_target',
-        :'goal_target_month',
-        :'goal_target_date',
-        :'goal_percentage_complete',
-        :'goal_months_to_budget',
-        :'goal_under_funded',
-        :'goal_overall_funded',
-        :'goal_overall_left',
-        :'goal_snoozed_at',
+        :'goal_target_formatted',
+        :'goal_target_currency',
+        :'goal_under_funded_formatted',
+        :'goal_under_funded_currency',
+        :'goal_overall_funded_formatted',
+        :'goal_overall_funded_currency',
+        :'goal_overall_left_formatted',
+        :'goal_overall_left_currency'
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'CategoryBase'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -234,6 +308,10 @@ module YNAB
         self.hidden = attributes[:'hidden']
       end
 
+      if attributes.key?(:'internal')
+        self.internal = attributes[:'internal']
+      end
+
       if attributes.key?(:'original_category_group_id')
         self.original_category_group_id = attributes[:'original_category_group_id']
       end
@@ -317,6 +395,62 @@ module YNAB
       if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
+
+      if attributes.key?(:'balance_formatted')
+        self.balance_formatted = attributes[:'balance_formatted']
+      end
+
+      if attributes.key?(:'balance_currency')
+        self.balance_currency = attributes[:'balance_currency']
+      end
+
+      if attributes.key?(:'activity_formatted')
+        self.activity_formatted = attributes[:'activity_formatted']
+      end
+
+      if attributes.key?(:'activity_currency')
+        self.activity_currency = attributes[:'activity_currency']
+      end
+
+      if attributes.key?(:'budgeted_formatted')
+        self.budgeted_formatted = attributes[:'budgeted_formatted']
+      end
+
+      if attributes.key?(:'budgeted_currency')
+        self.budgeted_currency = attributes[:'budgeted_currency']
+      end
+
+      if attributes.key?(:'goal_target_formatted')
+        self.goal_target_formatted = attributes[:'goal_target_formatted']
+      end
+
+      if attributes.key?(:'goal_target_currency')
+        self.goal_target_currency = attributes[:'goal_target_currency']
+      end
+
+      if attributes.key?(:'goal_under_funded_formatted')
+        self.goal_under_funded_formatted = attributes[:'goal_under_funded_formatted']
+      end
+
+      if attributes.key?(:'goal_under_funded_currency')
+        self.goal_under_funded_currency = attributes[:'goal_under_funded_currency']
+      end
+
+      if attributes.key?(:'goal_overall_funded_formatted')
+        self.goal_overall_funded_formatted = attributes[:'goal_overall_funded_formatted']
+      end
+
+      if attributes.key?(:'goal_overall_funded_currency')
+        self.goal_overall_funded_currency = attributes[:'goal_overall_funded_currency']
+      end
+
+      if attributes.key?(:'goal_overall_left_formatted')
+        self.goal_overall_left_formatted = attributes[:'goal_overall_left_formatted']
+      end
+
+      if attributes.key?(:'goal_overall_left_currency')
+        self.goal_overall_left_currency = attributes[:'goal_overall_left_currency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -333,6 +467,7 @@ module YNAB
       return false if @category_group_id.nil?
       return false if @name.nil?
       return false if @hidden.nil?
+      return false if @internal.nil?
       return false if @budgeted.nil?
       return false if @activity.nil?
       return false if @balance.nil?
@@ -358,6 +493,7 @@ module YNAB
           category_group_name == o.category_group_name &&
           name == o.name &&
           hidden == o.hidden &&
+          internal == o.internal &&
           original_category_group_id == o.original_category_group_id &&
           note == o.note &&
           budgeted == o.budgeted &&
@@ -378,7 +514,21 @@ module YNAB
           goal_overall_funded == o.goal_overall_funded &&
           goal_overall_left == o.goal_overall_left &&
           goal_snoozed_at == o.goal_snoozed_at &&
-          deleted == o.deleted
+          deleted == o.deleted &&
+          balance_formatted == o.balance_formatted &&
+          balance_currency == o.balance_currency &&
+          activity_formatted == o.activity_formatted &&
+          activity_currency == o.activity_currency &&
+          budgeted_formatted == o.budgeted_formatted &&
+          budgeted_currency == o.budgeted_currency &&
+          goal_target_formatted == o.goal_target_formatted &&
+          goal_target_currency == o.goal_target_currency &&
+          goal_under_funded_formatted == o.goal_under_funded_formatted &&
+          goal_under_funded_currency == o.goal_under_funded_currency &&
+          goal_overall_funded_formatted == o.goal_overall_funded_formatted &&
+          goal_overall_funded_currency == o.goal_overall_funded_currency &&
+          goal_overall_left_formatted == o.goal_overall_left_formatted &&
+          goal_overall_left_currency == o.goal_overall_left_currency
     end
 
     # @see the `==` method
@@ -390,7 +540,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, category_group_id, category_group_name, name, hidden, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_target_date, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, goal_snoozed_at, deleted].hash
+      [id, category_group_id, category_group_name, name, hidden, internal, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_needs_whole_amount, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_target_date, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, goal_snoozed_at, deleted, balance_formatted, balance_currency, activity_formatted, activity_currency, budgeted_formatted, budgeted_currency, goal_target_formatted, goal_target_currency, goal_under_funded_formatted, goal_under_funded_currency, goal_overall_funded_formatted, goal_overall_funded_currency, goal_overall_left_formatted, goal_overall_left_currency].hash
     end
 
     # Builds the object from hash