ynab 1.31.0 → 2.0.0.rc1

data/lib/ynab/models/category.rb

@@ -3,14 +3,15 @@
 
 #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 Category
@@ -18,12 +19,14 @@ module YNAB
 
     attr_accessor :category_group_id
 
+    attr_accessor :category_group_name
+
     attr_accessor :name
 
     # Whether or not the category is hidden
     attr_accessor :hidden
 
-    # If category is hidden this is the id of the category group it originally belonged to before it was hidden.
+    # DEPRECATED: No longer used.  Value will always be null.
     attr_accessor :original_category_group_id
 
     attr_accessor :note
@@ -40,13 +43,13 @@ module YNAB
     # 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
 
-    # The day of the goal
+    # 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
+    # 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
+    # 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
@@ -64,7 +67,7 @@ module YNAB
     # 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.
+    # 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.
@@ -103,6 +106,7 @@ module YNAB
       {
         :'id' => :'id',
         :'category_group_id' => :'category_group_id',
+        :'category_group_name' => :'category_group_name',
         :'name' => :'name',
         :'hidden' => :'hidden',
         :'original_category_group_id' => :'original_category_group_id',
@@ -126,13 +130,19 @@ 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',
         :'category_group_id' => :'String',
+        :'category_group_name' => :'String',
         :'name' => :'String',
-        :'hidden' => :'BOOLEAN',
+        :'hidden' => :'Boolean',
         :'original_category_group_id' => :'String',
         :'note' => :'String',
         :'budgeted' => :'Integer',
@@ -150,103 +160,134 @@ module YNAB
         :'goal_under_funded' => :'Integer',
         :'goal_overall_funded' => :'Integer',
         :'goal_overall_left' => :'Integer',
-        :'deleted' => :'BOOLEAN'
+        :'deleted' => :'Boolean'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'original_category_group_id',
+        :'note',
+        :'goal_type',
+        :'goal_day',
+        :'goal_cadence',
+        :'goal_cadence_frequency',
+        :'goal_creation_month',
+        :'goal_target',
+        :'goal_target_month',
+        :'goal_percentage_complete',
+        :'goal_months_to_budget',
+        :'goal_under_funded',
+        :'goal_overall_funded',
+        :'goal_overall_left',
+      ])
+    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::Category` 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::Category`. 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?(:'category_group_id')
+      if attributes.key?(:'category_group_id')
         self.category_group_id = attributes[:'category_group_id']
       end
 
-      if attributes.has_key?(:'name')
+      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.has_key?(:'hidden')
+      if attributes.key?(:'hidden')
         self.hidden = attributes[:'hidden']
       end
 
-      if attributes.has_key?(:'original_category_group_id')
+      if attributes.key?(:'original_category_group_id')
         self.original_category_group_id = attributes[:'original_category_group_id']
       end
 
-      if attributes.has_key?(:'note')
+      if attributes.key?(:'note')
         self.note = attributes[:'note']
       end
 
-      if attributes.has_key?(:'budgeted')
+      if attributes.key?(:'budgeted')
         self.budgeted = attributes[:'budgeted']
       end
 
-      if attributes.has_key?(:'activity')
+      if attributes.key?(:'activity')
         self.activity = attributes[:'activity']
       end
 
-      if attributes.has_key?(:'balance')
+      if attributes.key?(:'balance')
         self.balance = attributes[:'balance']
       end
 
-      if attributes.has_key?(:'goal_type')
+      if attributes.key?(:'goal_type')
         self.goal_type = attributes[:'goal_type']
       end
 
-      if attributes.has_key?(:'goal_day')
+      if attributes.key?(:'goal_day')
         self.goal_day = attributes[:'goal_day']
       end
 
-      if attributes.has_key?(:'goal_cadence')
+      if attributes.key?(:'goal_cadence')
         self.goal_cadence = attributes[:'goal_cadence']
       end
 
-      if attributes.has_key?(:'goal_cadence_frequency')
+      if attributes.key?(:'goal_cadence_frequency')
         self.goal_cadence_frequency = attributes[:'goal_cadence_frequency']
       end
 
-      if attributes.has_key?(:'goal_creation_month')
+      if attributes.key?(:'goal_creation_month')
         self.goal_creation_month = attributes[:'goal_creation_month']
       end
 
-      if attributes.has_key?(:'goal_target')
+      if attributes.key?(:'goal_target')
         self.goal_target = attributes[:'goal_target']
       end
 
-      if attributes.has_key?(:'goal_target_month')
+      if attributes.key?(:'goal_target_month')
         self.goal_target_month = attributes[:'goal_target_month']
       end
 
-      if attributes.has_key?(:'goal_percentage_complete')
+      if attributes.key?(:'goal_percentage_complete')
         self.goal_percentage_complete = attributes[:'goal_percentage_complete']
       end
 
-      if attributes.has_key?(:'goal_months_to_budget')
+      if attributes.key?(:'goal_months_to_budget')
         self.goal_months_to_budget = attributes[:'goal_months_to_budget']
       end
 
-      if attributes.has_key?(:'goal_under_funded')
+      if attributes.key?(:'goal_under_funded')
         self.goal_under_funded = attributes[:'goal_under_funded']
       end
 
-      if attributes.has_key?(:'goal_overall_funded')
+      if attributes.key?(:'goal_overall_funded')
         self.goal_overall_funded = attributes[:'goal_overall_funded']
       end
 
-      if attributes.has_key?(:'goal_overall_left')
+      if attributes.key?(:'goal_overall_left')
         self.goal_overall_left = attributes[:'goal_overall_left']
       end
 
-      if attributes.has_key?(:'deleted')
+      if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
     end
@@ -300,7 +341,7 @@ module YNAB
       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'])
+      goal_type_validator = EnumAttributeValidator.new('String', ["TB", "TBD", "MF", "NEED", "DEBT", "null"])
       return false unless goal_type_validator.valid?(@goal_type)
       return false if @deleted.nil?
       true
@@ -309,6 +350,10 @@ module YNAB
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] goal_type Object to be assigned
     def goal_type=(goal_type)
+      validator = EnumAttributeValidator.new('String', ["TB", "TBD", "MF", "NEED", "DEBT", "null"])
+      unless validator.valid?(goal_type)
+        fail ArgumentError, "invalid value for \"goal_type\", must be one of #{validator.allowable_values}."
+      end
       @goal_type = goal_type
     end
 
@@ -319,6 +364,7 @@ module YNAB
       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 &&
           original_category_group_id == o.original_category_group_id &&
@@ -348,17 +394,28 @@ module YNAB
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
-      [id, category_group_id, name, hidden, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, deleted].hash
+      [id, category_group_id, category_group_name, name, hidden, original_category_group_id, note, budgeted, activity, balance, goal_type, goal_day, goal_cadence, goal_cadence_frequency, goal_creation_month, goal_target, goal_target_month, goal_percentage_complete, goal_months_to_budget, goal_under_funded, goal_overall_funded, goal_overall_left, 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)
+      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)
@@ -366,7 +423,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
@@ -378,8 +435,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
@@ -388,7 +445,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
@@ -409,8 +466,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
 
@@ -432,7 +490,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/category_group.rb

@@ -3,14 +3,15 @@
 
 #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 CategoryGroup
@@ -34,37 +35,55 @@ 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',
         :'name' => :'String',
-        :'hidden' => :'BOOLEAN',
-        :'deleted' => :'BOOLEAN'
+        :'hidden' => :'Boolean',
+        :'deleted' => :'Boolean'
       }
     end
 
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `YNAB::CategoryGroup` 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::CategoryGroup`. 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?(:'name')
+      if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
 
-      if attributes.has_key?(:'hidden')
+      if attributes.key?(:'hidden')
         self.hidden = attributes[:'hidden']
       end
 
-      if attributes.has_key?(:'deleted')
+      if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
     end
@@ -120,17 +139,28 @@ module YNAB
     end
 
     # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
+    # @return [Integer] Hash code
     def hash
       [id, name, hidden, 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)
+      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)
@@ -138,7 +168,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
@@ -150,8 +180,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
@@ -160,7 +190,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
@@ -181,8 +211,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
 
@@ -204,7 +235,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