ynab 5.0.0 → 5.1.0

data/lib/ynab/models/scheduled_sub_transaction_base.rb

@@ -0,0 +1,229 @@
+=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 ScheduledSubTransactionBase < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :scheduled_transaction_id
+
+    # The scheduled subtransaction amount in milliunits format
+    attr_accessor :amount
+
+    attr_accessor :memo
+
+    attr_accessor :payee_id
+
+    attr_accessor :payee_name
+
+    attr_accessor :category_id
+
+    attr_accessor :category_name
+
+    # If a transfer, the account_id which the scheduled subtransaction transfers to
+    attr_accessor :transfer_account_id
+
+    # Whether or not the scheduled subtransaction has been deleted. Deleted scheduled subtransactions will only be included in delta requests.
+    attr_accessor :deleted
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'scheduled_transaction_id' => :'scheduled_transaction_id',
+        :'amount' => :'amount',
+        :'memo' => :'memo',
+        :'payee_id' => :'payee_id',
+        :'payee_name' => :'payee_name',
+        :'category_id' => :'category_id',
+        :'category_name' => :'category_name',
+        :'transfer_account_id' => :'transfer_account_id',
+        :'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',
+        :'scheduled_transaction_id' => :'String',
+        :'amount' => :'Integer',
+        :'memo' => :'String',
+        :'payee_id' => :'String',
+        :'payee_name' => :'String',
+        :'category_id' => :'String',
+        :'category_name' => :'String',
+        :'transfer_account_id' => :'String',
+        :'deleted' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'memo',
+        :'payee_id',
+        :'payee_name',
+        :'category_id',
+        :'category_name',
+        :'transfer_account_id',
+      ])
+    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::ScheduledSubTransactionBase` 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::ScheduledSubTransactionBase`. 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?(:'scheduled_transaction_id')
+        self.scheduled_transaction_id = attributes[:'scheduled_transaction_id']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'memo')
+        self.memo = attributes[:'memo']
+      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?(:'category_name')
+        self.category_name = attributes[:'category_name']
+      end
+
+      if attributes.key?(:'transfer_account_id')
+        self.transfer_account_id = attributes[:'transfer_account_id']
+      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 @scheduled_transaction_id.nil?
+      return false if @amount.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 &&
+          scheduled_transaction_id == o.scheduled_transaction_id &&
+          amount == o.amount &&
+          memo == o.memo &&
+          payee_id == o.payee_id &&
+          payee_name == o.payee_name &&
+          category_id == o.category_id &&
+          category_name == o.category_name &&
+          transfer_account_id == o.transfer_account_id &&
+          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, scheduled_transaction_id, amount, memo, payee_id, payee_name, category_id, category_name, transfer_account_id, 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/scheduled_transaction_detail.rb

@@ -44,6 +44,12 @@ module YNAB
     # Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests.
     attr_accessor :deleted
 
+    # The scheduled transaction amount formatted in the plan's currency format
+    attr_accessor :amount_formatted
+
+    # The scheduled transaction amount as a decimal currency amount
+    attr_accessor :amount_currency
+
     attr_accessor :account_name
 
     attr_accessor :payee_name
@@ -92,6 +98,8 @@ module YNAB
         :'category_id' => :'category_id',
         :'transfer_account_id' => :'transfer_account_id',
         :'deleted' => :'deleted',
+        :'amount_formatted' => :'amount_formatted',
+        :'amount_currency' => :'amount_currency',
         :'account_name' => :'account_name',
         :'payee_name' => :'payee_name',
         :'category_name' => :'category_name',
@@ -120,6 +128,8 @@ module YNAB
         :'category_id' => :'String',
         :'transfer_account_id' => :'String',
         :'deleted' => :'Boolean',
+        :'amount_formatted' => :'String',
+        :'amount_currency' => :'Float',
         :'account_name' => :'String',
         :'payee_name' => :'String',
         :'category_name' => :'String',
@@ -210,6 +220,14 @@ module YNAB
         self.deleted = attributes[:'deleted']
       end
 
+      if attributes.key?(:'amount_formatted')
+        self.amount_formatted = attributes[:'amount_formatted']
+      end
+
+      if attributes.key?(:'amount_currency')
+        self.amount_currency = attributes[:'amount_currency']
+      end
+
       if attributes.key?(:'account_name')
         self.account_name = attributes[:'account_name']
       end
@@ -277,6 +295,8 @@ module YNAB
           category_id == o.category_id &&
           transfer_account_id == o.transfer_account_id &&
           deleted == o.deleted &&
+          amount_formatted == o.amount_formatted &&
+          amount_currency == o.amount_currency &&
           account_name == o.account_name &&
           payee_name == o.payee_name &&
           category_name == o.category_name &&
@@ -292,7 +312,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, date_first, date_next, frequency, amount, memo, flag_color, flag_name, account_id, payee_id, category_id, transfer_account_id, deleted, account_name, payee_name, category_name, subtransactions].hash
+      [id, date_first, date_next, frequency, amount, memo, flag_color, flag_name, account_id, payee_id, category_id, transfer_account_id, deleted, amount_formatted, amount_currency, account_name, payee_name, category_name, subtransactions].hash
     end
 
     # Builds the object from hash

data/lib/ynab/models/scheduled_transaction_summary.rb

@@ -44,6 +44,12 @@ module YNAB
     # Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions will only be included in delta requests.
     attr_accessor :deleted
 
+    # The scheduled transaction amount formatted in the plan's currency format
+    attr_accessor :amount_formatted
+
+    # The scheduled transaction amount as a decimal currency amount
+    attr_accessor :amount_currency
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -81,7 +87,9 @@ module YNAB
         :'payee_id' => :'payee_id',
         :'category_id' => :'category_id',
         :'transfer_account_id' => :'transfer_account_id',
-        :'deleted' => :'deleted'
+        :'deleted' => :'deleted',
+        :'amount_formatted' => :'amount_formatted',
+        :'amount_currency' => :'amount_currency'
       }
     end
 
@@ -105,22 +113,26 @@ module YNAB
         :'payee_id' => :'String',
         :'category_id' => :'String',
         :'transfer_account_id' => :'String',
-        :'deleted' => :'Boolean'
+        :'deleted' => :'Boolean',
+        :'amount_formatted' => :'String',
+        :'amount_currency' => :'Float'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'memo',
         :'flag_color',
-        :'flag_name',
-        :'payee_id',
-        :'category_id',
-        :'transfer_account_id',
       ])
     end
 
+    # List of class defined in allOf (OpenAPI v3)
+    def self.openapi_all_of
+      [
+      :'ScheduledTransactionSummaryBase'
+      ]
+    end
+
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
@@ -187,6 +199,14 @@ module YNAB
       if attributes.key?(:'deleted')
         self.deleted = attributes[:'deleted']
       end
+
+      if attributes.key?(:'amount_formatted')
+        self.amount_formatted = attributes[:'amount_formatted']
+      end
+
+      if attributes.key?(:'amount_currency')
+        self.amount_currency = attributes[:'amount_currency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -234,7 +254,9 @@ module YNAB
           payee_id == o.payee_id &&
           category_id == o.category_id &&
           transfer_account_id == o.transfer_account_id &&
-          deleted == o.deleted
+          deleted == o.deleted &&
+          amount_formatted == o.amount_formatted &&
+          amount_currency == o.amount_currency
     end
 
     # @see the `==` method
@@ -246,7 +268,7 @@ module YNAB
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, date_first, date_next, frequency, amount, memo, flag_color, flag_name, account_id, payee_id, category_id, transfer_account_id, deleted].hash
+      [id, date_first, date_next, frequency, amount, memo, flag_color, flag_name, account_id, payee_id, category_id, transfer_account_id, deleted, amount_formatted, amount_currency].hash
     end
 
     # Builds the object from hash

data/lib/ynab/models/scheduled_transaction_summary_base.rb

@@ -0,0 +1,292 @@
+=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 ScheduledTransactionSummaryBase < ApiModelBase
+    attr_accessor :id
+
+    # The first date for which the Scheduled Transaction was scheduled.
+    attr_accessor :date_first
+
+    # The next date for which the Scheduled Transaction is scheduled.
+    attr_accessor :date_next
+
+    attr_accessor :frequency
+
+    # The scheduled transaction amount in milliunits format
+    attr_accessor :amount
+
+    attr_accessor :memo
+
+    attr_accessor :flag_color
+
+    # The customized name of a transaction flag
+    attr_accessor :flag_name
+
+    attr_accessor :account_id
+
+    attr_accessor :payee_id
+
+    attr_accessor :category_id
+
+    # If a transfer, the account_id which the scheduled transaction transfers to
+    attr_accessor :transfer_account_id
+
+    # Whether or not the scheduled transaction has been deleted.  Deleted scheduled transactions 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',
+        :'date_first' => :'date_first',
+        :'date_next' => :'date_next',
+        :'frequency' => :'frequency',
+        :'amount' => :'amount',
+        :'memo' => :'memo',
+        :'flag_color' => :'flag_color',
+        :'flag_name' => :'flag_name',
+        :'account_id' => :'account_id',
+        :'payee_id' => :'payee_id',
+        :'category_id' => :'category_id',
+        :'transfer_account_id' => :'transfer_account_id',
+        :'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',
+        :'date_first' => :'Date',
+        :'date_next' => :'Date',
+        :'frequency' => :'String',
+        :'amount' => :'Integer',
+        :'memo' => :'String',
+        :'flag_color' => :'TransactionFlagColor',
+        :'flag_name' => :'String',
+        :'account_id' => :'String',
+        :'payee_id' => :'String',
+        :'category_id' => :'String',
+        :'transfer_account_id' => :'String',
+        :'deleted' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'memo',
+        :'flag_color',
+        :'flag_name',
+        :'payee_id',
+        :'category_id',
+        :'transfer_account_id',
+      ])
+    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::ScheduledTransactionSummaryBase` 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::ScheduledTransactionSummaryBase`. 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?(:'date_first')
+        self.date_first = attributes[:'date_first']
+      end
+
+      if attributes.key?(:'date_next')
+        self.date_next = attributes[:'date_next']
+      end
+
+      if attributes.key?(:'frequency')
+        self.frequency = attributes[:'frequency']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      end
+
+      if attributes.key?(:'memo')
+        self.memo = attributes[:'memo']
+      end
+
+      if attributes.key?(:'flag_color')
+        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
+
+      if attributes.key?(:'payee_id')
+        self.payee_id = attributes[:'payee_id']
+      end
+
+      if attributes.key?(:'category_id')
+        self.category_id = attributes[:'category_id']
+      end
+
+      if attributes.key?(:'transfer_account_id')
+        self.transfer_account_id = attributes[:'transfer_account_id']
+      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 @date_first.nil?
+      return false if @date_next.nil?
+      return false if @frequency.nil?
+      frequency_validator = EnumAttributeValidator.new('String', ["never", "daily", "weekly", "everyOtherWeek", "twiceAMonth", "every4Weeks", "monthly", "everyOtherMonth", "every3Months", "every4Months", "twiceAYear", "yearly", "everyOtherYear"])
+      return false unless frequency_validator.valid?(@frequency)
+      return false if @amount.nil?
+      return false if @account_id.nil?
+      return false if @deleted.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] frequency Object to be assigned
+    def frequency=(frequency)
+      @frequency = frequency
+    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 &&
+          date_first == o.date_first &&
+          date_next == o.date_next &&
+          frequency == o.frequency &&
+          amount == o.amount &&
+          memo == o.memo &&
+          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 &&
+          transfer_account_id == o.transfer_account_id &&
+          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, date_first, date_next, frequency, amount, memo, flag_color, flag_name, account_id, payee_id, category_id, transfer_account_id, 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