ynab 5.0.0 → 5.1.0

data/lib/ynab/models/transaction_summary_base.rb

@@ -0,0 +1,358 @@
+=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 TransactionSummaryBase < ApiModelBase
+    attr_accessor :id
+
+    # The transaction date in ISO format (e.g. 2016-12-01)
+    attr_accessor :date
+
+    # The transaction amount in milliunits format
+    attr_accessor :amount
+
+    attr_accessor :memo
+
+    attr_accessor :cleared
+
+    # Whether or not the transaction is approved
+    attr_accessor :approved
+
+    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 transaction, the account to which it transfers
+    attr_accessor :transfer_account_id
+
+    # If a transfer transaction, the id of transaction on the other side of the transfer
+    attr_accessor :transfer_transaction_id
+
+    # If transaction is matched, the id of the matched transaction
+    attr_accessor :matched_transaction_id
+
+    # If the transaction was imported, this field is a unique (by account) import identifier.  If this transaction was imported through File Based Import or Direct Import and not through the API, the import_id will have the format: 'YNAB:[milliunit_amount]:[iso_date]:[occurrence]'.  For example, a transaction dated 2015-12-30 in the amount of -$294.23 USD would have an import_id of 'YNAB:-294230:2015-12-30:1'.  If a second transaction on the same account was imported and had the same date and same amount, its import_id would be 'YNAB:-294230:2015-12-30:2'.
+    attr_accessor :import_id
+
+    # If the transaction was imported, the payee name that was used when importing and before applying any payee rename rules
+    attr_accessor :import_payee_name
+
+    # If the transaction was imported, the original payee name as it appeared on the statement
+    attr_accessor :import_payee_name_original
+
+    # If the transaction is a debt/loan account transaction, the type of transaction
+    attr_accessor :debt_transaction_type
+
+    # Whether or not the transaction has been deleted.  Deleted 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' => :'date',
+        :'amount' => :'amount',
+        :'memo' => :'memo',
+        :'cleared' => :'cleared',
+        :'approved' => :'approved',
+        :'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',
+        :'transfer_transaction_id' => :'transfer_transaction_id',
+        :'matched_transaction_id' => :'matched_transaction_id',
+        :'import_id' => :'import_id',
+        :'import_payee_name' => :'import_payee_name',
+        :'import_payee_name_original' => :'import_payee_name_original',
+        :'debt_transaction_type' => :'debt_transaction_type',
+        :'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' => :'Date',
+        :'amount' => :'Integer',
+        :'memo' => :'String',
+        :'cleared' => :'TransactionClearedStatus',
+        :'approved' => :'Boolean',
+        :'flag_color' => :'TransactionFlagColor',
+        :'flag_name' => :'String',
+        :'account_id' => :'String',
+        :'payee_id' => :'String',
+        :'category_id' => :'String',
+        :'transfer_account_id' => :'String',
+        :'transfer_transaction_id' => :'String',
+        :'matched_transaction_id' => :'String',
+        :'import_id' => :'String',
+        :'import_payee_name' => :'String',
+        :'import_payee_name_original' => :'String',
+        :'debt_transaction_type' => :'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',
+        :'transfer_transaction_id',
+        :'matched_transaction_id',
+        :'import_id',
+        :'import_payee_name',
+        :'import_payee_name_original',
+        :'debt_transaction_type',
+      ])
+    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::TransactionSummaryBase` 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::TransactionSummaryBase`. 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')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      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?(:'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?(:'transfer_transaction_id')
+        self.transfer_transaction_id = attributes[:'transfer_transaction_id']
+      end
+
+      if attributes.key?(:'matched_transaction_id')
+        self.matched_transaction_id = attributes[:'matched_transaction_id']
+      end
+
+      if attributes.key?(:'import_id')
+        self.import_id = attributes[:'import_id']
+      end
+
+      if attributes.key?(:'import_payee_name')
+        self.import_payee_name = attributes[:'import_payee_name']
+      end
+
+      if attributes.key?(:'import_payee_name_original')
+        self.import_payee_name_original = attributes[:'import_payee_name_original']
+      end
+
+      if attributes.key?(:'debt_transaction_type')
+        self.debt_transaction_type = attributes[:'debt_transaction_type']
+      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.nil?
+      return false if @amount.nil?
+      return false if @cleared.nil?
+      return false if @approved.nil?
+      return false if @account_id.nil?
+      debt_transaction_type_validator = EnumAttributeValidator.new('String', ["payment", "refund", "fee", "interest", "escrow", "balanceAdjustment", "credit", "charge"])
+      return false unless debt_transaction_type_validator.valid?(@debt_transaction_type)
+      return false if @deleted.nil?
+      true
+    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)
+      @debt_transaction_type = debt_transaction_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 &&
+          date == o.date &&
+          amount == o.amount &&
+          memo == o.memo &&
+          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 &&
+          transfer_account_id == o.transfer_account_id &&
+          transfer_transaction_id == o.transfer_transaction_id &&
+          matched_transaction_id == o.matched_transaction_id &&
+          import_id == o.import_id &&
+          import_payee_name == o.import_payee_name &&
+          import_payee_name_original == o.import_payee_name_original &&
+          debt_transaction_type == o.debt_transaction_type &&
+          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, 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].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/version.rb

@@ -1,3 +1,3 @@
 module YNAB
-  VERSION = '5.0.0'
+  VERSION = '5.1.0'
 end

data/lib/ynab.rb

@@ -15,6 +15,7 @@ require 'ynab/configuration'
 # Models
 require 'ynab/api_model_base'
 require 'ynab/models/account'
+require 'ynab/models/account_base'
 require 'ynab/models/account_response'
 require 'ynab/models/account_response_data'
 require 'ynab/models/account_type'
@@ -27,6 +28,7 @@ require 'ynab/models/bulk_transactions'
 require 'ynab/models/categories_response'
 require 'ynab/models/categories_response_data'
 require 'ynab/models/category'
+require 'ynab/models/category_base'
 require 'ynab/models/category_group'
 require 'ynab/models/category_group_with_categories'
 require 'ynab/models/category_response'
@@ -41,17 +43,20 @@ require 'ynab/models/hybrid_transaction'
 require 'ynab/models/hybrid_transactions_response'
 require 'ynab/models/hybrid_transactions_response_data'
 require 'ynab/models/money_movement'
+require 'ynab/models/money_movement_base'
 require 'ynab/models/money_movement_group'
 require 'ynab/models/money_movement_groups_response'
 require 'ynab/models/money_movement_groups_response_data'
 require 'ynab/models/money_movements_response'
 require 'ynab/models/money_movements_response_data'
 require 'ynab/models/month_detail'
+require 'ynab/models/month_detail_base'
 require 'ynab/models/month_detail_response'
 require 'ynab/models/month_detail_response_data'
 require 'ynab/models/month_summaries_response'
 require 'ynab/models/month_summaries_response_data'
 require 'ynab/models/month_summary'
+require 'ynab/models/month_summary_base'
 require 'ynab/models/new_category'
 require 'ynab/models/new_transaction'
 require 'ynab/models/patch_category_group_wrapper'
@@ -81,11 +86,14 @@ require 'ynab/models/plan_summary_response_data'
 require 'ynab/models/post_account_wrapper'
 require 'ynab/models/post_category_group_wrapper'
 require 'ynab/models/post_category_wrapper'
+require 'ynab/models/post_payee'
+require 'ynab/models/post_payee_wrapper'
 require 'ynab/models/post_scheduled_transaction_wrapper'
 require 'ynab/models/post_transactions_wrapper'
 require 'ynab/models/put_scheduled_transaction_wrapper'
 require 'ynab/models/put_transaction_wrapper'
 require 'ynab/models/save_account'
+require 'ynab/models/save_account_type'
 require 'ynab/models/save_category'
 require 'ynab/models/save_category_group'
 require 'ynab/models/save_category_group_response'
@@ -103,20 +111,24 @@ require 'ynab/models/save_transaction_with_optional_fields'
 require 'ynab/models/save_transactions_response'
 require 'ynab/models/save_transactions_response_data'
 require 'ynab/models/scheduled_sub_transaction'
+require 'ynab/models/scheduled_sub_transaction_base'
 require 'ynab/models/scheduled_transaction_detail'
 require 'ynab/models/scheduled_transaction_frequency'
 require 'ynab/models/scheduled_transaction_response'
 require 'ynab/models/scheduled_transaction_response_data'
 require 'ynab/models/scheduled_transaction_summary'
+require 'ynab/models/scheduled_transaction_summary_base'
 require 'ynab/models/scheduled_transactions_response'
 require 'ynab/models/scheduled_transactions_response_data'
 require 'ynab/models/sub_transaction'
+require 'ynab/models/sub_transaction_base'
 require 'ynab/models/transaction_cleared_status'
 require 'ynab/models/transaction_detail'
 require 'ynab/models/transaction_flag_color'
 require 'ynab/models/transaction_response'
 require 'ynab/models/transaction_response_data'
 require 'ynab/models/transaction_summary'
+require 'ynab/models/transaction_summary_base'
 require 'ynab/models/transactions_import_response'
 require 'ynab/models/transactions_import_response_data'
 require 'ynab/models/transactions_response'