ynab 5.0.0 → 5.2.0

data/lib/ynab/models/category_base.rb

@@ -0,0 +1,447 @@
+=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 CategoryBase < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :category_group_id
+
+    attr_accessor :category_group_name
+
+    attr_accessor :name
+
+    # 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
+
+    attr_accessor :note
+
+    # Assigned (budgeted) amount in milliunits format
+    attr_accessor :budgeted
+
+    # Activity amount in milliunits format
+    attr_accessor :activity
+
+    # Available balance in milliunits format
+    attr_accessor :balance
+
+    # The type of goal, if the category has a goal (TB='Target Category Balance', TBD='Target Category Balance by Date', MF='Monthly Funding', NEED='Plan Your Spending')
+    attr_accessor :goal_type
+
+    # Indicates the monthly rollover behavior for \"NEED\"-type goals. When \"true\", the goal will always ask for the target amount in the new month (\"Set Aside\"). When \"false\", previous month category funding is used (\"Refill\"). For other goal types, this field will be null.
+    attr_accessor :goal_needs_whole_amount
+
+    # A day offset modifier for the goal's due date. When goal_cadence is 2 (Weekly), this value specifies which day of the week the goal is due (0 = Sunday, 6 = Saturday). Otherwise, this value specifies which day of the month the goal is due (1 = 1st, 31 = 31st, null = Last day of Month).
+    attr_accessor :goal_day
+
+    # The goal cadence. Value in range 0-14. There are two subsets of these values which behave differently. For values 0, 1, 2, and 13, the goal's due date repeats every goal_cadence * goal_cadence_frequency, where 0 = None, 1 = Monthly, 2 = Weekly, and 13 = Yearly. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month. For values 3-12 and 14, goal_cadence_frequency is ignored and the goal's due date repeats every goal_cadence, where 3 = Every 2 Months, 4 = Every 3 Months, ..., 12 = Every 11 Months, and 14 = Every 2 Years.
+    attr_accessor :goal_cadence
+
+    # The goal cadence frequency. When goal_cadence is 0, 1, 2, or 13, a goal's due date repeats every goal_cadence * goal_cadence_frequency. For example, goal_cadence 1 with goal_cadence_frequency 2 means the goal is due every other month.  When goal_cadence is 3-12 or 14, goal_cadence_frequency is ignored.
+    attr_accessor :goal_cadence_frequency
+
+    # The month a goal was created
+    attr_accessor :goal_creation_month
+
+    # The goal target amount in milliunits
+    attr_accessor :goal_target
+
+    # DEPRECATED: No longer used.  Use `goal_target_date` instead.
+    attr_accessor :goal_target_month
+
+    # The target date for the goal to be completed.  Only some goal types specify this date.
+    attr_accessor :goal_target_date
+
+    # The percentage completion of the goal
+    attr_accessor :goal_percentage_complete
+
+    # The number of months, including the current month, left in the current goal period.
+    attr_accessor :goal_months_to_budget
+
+    # The amount of funding still needed in the current month to stay on track towards completing the goal within the current goal period. This amount will generally correspond to the 'Underfunded' amount in the web and mobile clients except when viewing a category with a Needed for Spending Goal in a future month.  The web and mobile clients will ignore any funding from a prior goal period when viewing category with a Needed for Spending Goal in a future month.
+    attr_accessor :goal_under_funded
+
+    # The total amount funded towards the goal within the current goal period.
+    attr_accessor :goal_overall_funded
+
+    # The amount of funding still needed to complete the goal within the current goal period.
+    attr_accessor :goal_overall_left
+
+    # The date/time the goal was snoozed.  If the goal is not snoozed, this will be null.
+    attr_accessor :goal_snoozed_at
+
+    # Whether or not the category has been deleted.  Deleted categories 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',
+        :'category_group_id' => :'category_group_id',
+        :'category_group_name' => :'category_group_name',
+        :'name' => :'name',
+        :'hidden' => :'hidden',
+        :'internal' => :'internal',
+        :'original_category_group_id' => :'original_category_group_id',
+        :'note' => :'note',
+        :'budgeted' => :'budgeted',
+        :'activity' => :'activity',
+        :'balance' => :'balance',
+        :'goal_type' => :'goal_type',
+        :'goal_needs_whole_amount' => :'goal_needs_whole_amount',
+        :'goal_day' => :'goal_day',
+        :'goal_cadence' => :'goal_cadence',
+        :'goal_cadence_frequency' => :'goal_cadence_frequency',
+        :'goal_creation_month' => :'goal_creation_month',
+        :'goal_target' => :'goal_target',
+        :'goal_target_month' => :'goal_target_month',
+        :'goal_target_date' => :'goal_target_date',
+        :'goal_percentage_complete' => :'goal_percentage_complete',
+        :'goal_months_to_budget' => :'goal_months_to_budget',
+        :'goal_under_funded' => :'goal_under_funded',
+        :'goal_overall_funded' => :'goal_overall_funded',
+        :'goal_overall_left' => :'goal_overall_left',
+        :'goal_snoozed_at' => :'goal_snoozed_at',
+        :'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',
+        :'category_group_id' => :'String',
+        :'category_group_name' => :'String',
+        :'name' => :'String',
+        :'hidden' => :'Boolean',
+        :'internal' => :'Boolean',
+        :'original_category_group_id' => :'String',
+        :'note' => :'String',
+        :'budgeted' => :'Integer',
+        :'activity' => :'Integer',
+        :'balance' => :'Integer',
+        :'goal_type' => :'String',
+        :'goal_needs_whole_amount' => :'Boolean',
+        :'goal_day' => :'Integer',
+        :'goal_cadence' => :'Integer',
+        :'goal_cadence_frequency' => :'Integer',
+        :'goal_creation_month' => :'Date',
+        :'goal_target' => :'Integer',
+        :'goal_target_month' => :'Date',
+        :'goal_target_date' => :'Date',
+        :'goal_percentage_complete' => :'Integer',
+        :'goal_months_to_budget' => :'Integer',
+        :'goal_under_funded' => :'Integer',
+        :'goal_overall_funded' => :'Integer',
+        :'goal_overall_left' => :'Integer',
+        :'goal_snoozed_at' => :'Time',
+        :'deleted' => :'Boolean'
+      }
+    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',
+      ])
+    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::CategoryBase` 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::CategoryBase`. 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?(:'category_group_id')
+        self.category_group_id = attributes[:'category_group_id']
+      end
+
+      if attributes.key?(:'category_group_name')
+        self.category_group_name = attributes[:'category_group_name']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'hidden')
+        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
+
+      if attributes.key?(:'note')
+        self.note = attributes[:'note']
+      end
+
+      if attributes.key?(:'budgeted')
+        self.budgeted = attributes[:'budgeted']
+      end
+
+      if attributes.key?(:'activity')
+        self.activity = attributes[:'activity']
+      end
+
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
+      end
+
+      if attributes.key?(:'goal_type')
+        self.goal_type = attributes[:'goal_type']
+      end
+
+      if attributes.key?(:'goal_needs_whole_amount')
+        self.goal_needs_whole_amount = attributes[:'goal_needs_whole_amount']
+      end
+
+      if attributes.key?(:'goal_day')
+        self.goal_day = attributes[:'goal_day']
+      end
+
+      if attributes.key?(:'goal_cadence')
+        self.goal_cadence = attributes[:'goal_cadence']
+      end
+
+      if attributes.key?(:'goal_cadence_frequency')
+        self.goal_cadence_frequency = attributes[:'goal_cadence_frequency']
+      end
+
+      if attributes.key?(:'goal_creation_month')
+        self.goal_creation_month = attributes[:'goal_creation_month']
+      end
+
+      if attributes.key?(:'goal_target')
+        self.goal_target = attributes[:'goal_target']
+      end
+
+      if attributes.key?(:'goal_target_month')
+        self.goal_target_month = attributes[:'goal_target_month']
+      end
+
+      if attributes.key?(:'goal_target_date')
+        self.goal_target_date = attributes[:'goal_target_date']
+      end
+
+      if attributes.key?(:'goal_percentage_complete')
+        self.goal_percentage_complete = attributes[:'goal_percentage_complete']
+      end
+
+      if attributes.key?(:'goal_months_to_budget')
+        self.goal_months_to_budget = attributes[:'goal_months_to_budget']
+      end
+
+      if attributes.key?(:'goal_under_funded')
+        self.goal_under_funded = attributes[:'goal_under_funded']
+      end
+
+      if attributes.key?(:'goal_overall_funded')
+        self.goal_overall_funded = attributes[:'goal_overall_funded']
+      end
+
+      if attributes.key?(:'goal_overall_left')
+        self.goal_overall_left = attributes[:'goal_overall_left']
+      end
+
+      if attributes.key?(:'goal_snoozed_at')
+        self.goal_snoozed_at = attributes[:'goal_snoozed_at']
+      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 @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?
+      goal_type_validator = EnumAttributeValidator.new('String', ["TB", "TBD", "MF", "NEED", "DEBT"])
+      return false unless goal_type_validator.valid?(@goal_type)
+      return false if @deleted.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] goal_type Object to be assigned
+    def goal_type=(goal_type)
+      @goal_type = goal_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 &&
+          id == o.id &&
+          category_group_id == o.category_group_id &&
+          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 &&
+          activity == o.activity &&
+          balance == o.balance &&
+          goal_type == o.goal_type &&
+          goal_needs_whole_amount == o.goal_needs_whole_amount &&
+          goal_day == o.goal_day &&
+          goal_cadence == o.goal_cadence &&
+          goal_cadence_frequency == o.goal_cadence_frequency &&
+          goal_creation_month == o.goal_creation_month &&
+          goal_target == o.goal_target &&
+          goal_target_month == o.goal_target_month &&
+          goal_target_date == o.goal_target_date &&
+          goal_percentage_complete == o.goal_percentage_complete &&
+          goal_months_to_budget == o.goal_months_to_budget &&
+          goal_under_funded == o.goal_under_funded &&
+          goal_overall_funded == o.goal_overall_funded &&
+          goal_overall_left == o.goal_overall_left &&
+          goal_snoozed_at == o.goal_snoozed_at &&
+          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, 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].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_group.rb

@@ -19,6 +19,9 @@ module YNAB
     # Whether or not the category group is hidden
     attr_accessor :hidden
 
+    # Whether or not the category group is internal
+    attr_accessor :internal
+
     # Whether or not the category group has been deleted.  Deleted category groups will only be included in delta requests.
     attr_accessor :deleted
 
@@ -28,6 +31,7 @@ module YNAB
         :'id' => :'id',
         :'name' => :'name',
         :'hidden' => :'hidden',
+        :'internal' => :'internal',
         :'deleted' => :'deleted'
       }
     end
@@ -43,6 +47,7 @@ module YNAB
         :'id' => :'String',
         :'name' => :'String',
         :'hidden' => :'Boolean',
+        :'internal' => :'Boolean',
         :'deleted' => :'Boolean'
       }
     end
@@ -80,6 +85,10 @@ module YNAB
         self.hidden = attributes[:'hidden']
       end
 
+      if attributes.key?(:'internal')
+        self.internal = attributes[:'internal']
+      end
+
       if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
@@ -98,6 +107,7 @@ module YNAB
       return false if @id.nil?
       return false if @name.nil?
       return false if @hidden.nil?
+      return false if @internal.nil?
       return false if @deleted.nil?
       true
     end
@@ -110,6 +120,7 @@ module YNAB
           id == o.id &&
           name == o.name &&
           hidden == o.hidden &&
+          internal == o.internal &&
           deleted == o.deleted
     end
 
@@ -122,7 +133,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, hidden, deleted].hash
+      [id, name, hidden, internal, deleted].hash
     end
 
     # Builds the object from hash

data/lib/ynab/models/category_group_with_categories.rb

@@ -19,6 +19,9 @@ module YNAB
     # Whether or not the category group is hidden
     attr_accessor :hidden
 
+    # Whether or not the category group is internal
+    attr_accessor :internal
+
     # Whether or not the category group has been deleted.  Deleted category groups will only be included in delta requests.
     attr_accessor :deleted
 
@@ -31,6 +34,7 @@ module YNAB
         :'id' => :'id',
         :'name' => :'name',
         :'hidden' => :'hidden',
+        :'internal' => :'internal',
         :'deleted' => :'deleted',
         :'categories' => :'categories'
       }
@@ -47,6 +51,7 @@ module YNAB
         :'id' => :'String',
         :'name' => :'String',
         :'hidden' => :'Boolean',
+        :'internal' => :'Boolean',
         :'deleted' => :'Boolean',
         :'categories' => :'Array<Category>'
       }
@@ -92,6 +97,10 @@ module YNAB
         self.hidden = attributes[:'hidden']
       end
 
+      if attributes.key?(:'internal')
+        self.internal = attributes[:'internal']
+      end
+
       if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
@@ -116,6 +125,7 @@ module YNAB
       return false if @id.nil?
       return false if @name.nil?
       return false if @hidden.nil?
+      return false if @internal.nil?
       return false if @deleted.nil?
       return false if @categories.nil?
       true
@@ -129,6 +139,7 @@ module YNAB
           id == o.id &&
           name == o.name &&
           hidden == o.hidden &&
+          internal == o.internal &&
           deleted == o.deleted &&
           categories == o.categories
     end
@@ -142,7 +153,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, name, hidden, deleted, categories].hash
+      [id, name, hidden, internal, deleted, categories].hash
     end
 
     # Builds the object from hash

data/lib/ynab/models/existing_category.rb

@@ -16,14 +16,18 @@ module YNAB
 
     attr_accessor :note
 
+    # The id of the category group to which this category belongs.  An internal category group may not be specified.
     attr_accessor :category_group_id
 
-    # The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly 'Needed for Spending' goal will be created for the category with this target amount.
+    # The goal target amount in milliunits format.  If value is specified and goal has not already been configured for category, a monthly goal will be created for the category with this target amount.  If goal_type is not specified, it will default to 'NEED' or 'MF' for Credit Card Payment categories.
     attr_accessor :goal_target
 
     # The goal target date in ISO format (e.g. 2016-12-01).
     attr_accessor :goal_target_date
 
+    # Whether the goal requires the full target amount each period. Only supported for 'NEED' goals. When true, the goal is configured as 'Set aside another...'. When false, the goal is configured as 'Refill up to...'.
+    attr_accessor :goal_needs_whole_amount
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -31,7 +35,8 @@ module YNAB
         :'note' => :'note',
         :'category_group_id' => :'category_group_id',
         :'goal_target' => :'goal_target',
-        :'goal_target_date' => :'goal_target_date'
+        :'goal_target_date' => :'goal_target_date',
+        :'goal_needs_whole_amount' => :'goal_needs_whole_amount'
       }
     end
 
@@ -47,7 +52,8 @@ module YNAB
         :'note' => :'String',
         :'category_group_id' => :'String',
         :'goal_target' => :'Integer',
-        :'goal_target_date' => :'Date'
+        :'goal_target_date' => :'Date',
+        :'goal_needs_whole_amount' => :'Boolean'
       }
     end
 
@@ -98,6 +104,10 @@ module YNAB
       if attributes.key?(:'goal_target_date')
         self.goal_target_date = attributes[:'goal_target_date']
       end
+
+      if attributes.key?(:'goal_needs_whole_amount')
+        self.goal_needs_whole_amount = attributes[:'goal_needs_whole_amount']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -122,7 +132,8 @@ module YNAB
           note == o.note &&
           category_group_id == o.category_group_id &&
           goal_target == o.goal_target &&
-          goal_target_date == o.goal_target_date
+          goal_target_date == o.goal_target_date &&
+          goal_needs_whole_amount == o.goal_needs_whole_amount
     end
 
     # @see the `==` method
@@ -134,7 +145,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, note, category_group_id, goal_target, goal_target_date].hash
+      [name, note, category_group_id, goal_target, goal_target_date, goal_needs_whole_amount].hash
     end
 
     # Builds the object from hash