lunchmoney 0.10.0 → 1.1.0

data/lib/lunchmoney/objects/transaction.rb

@@ -0,0 +1,160 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "transaction_base"
+
+module LunchMoney
+  module Objects
+    # https://lunchmoney.dev/#transaction-object
+    class Transaction < TransactionBase
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :category_id,
+        :category_group_id,
+        :recurring_id,
+        :parent_id,
+        :group_id,
+        :external_id
+
+      sig { returns(String) }
+      attr_accessor :created_at,
+        :updated_at,
+        :status,
+        :source,
+        :display_name,
+        :account_display_name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :category_name,
+        :category_group_name,
+        :original_name,
+        :recurring_payee,
+        :recurring_description,
+        :recurring_cadence,
+        :recurring_type,
+        :recurring_amount,
+        :recurring_currency,
+        :asset_institution_name,
+        :asset_name,
+        :asset_display_name,
+        :asset_status,
+        :plaid_account_name,
+        :plaid_account_mask,
+        :institution_name,
+        :plaid_account_display_name,
+        :plaid_metadata,
+        :display_notes
+
+      sig { returns(T::Boolean) }
+      attr_accessor :is_income, :exclude_from_budget, :exclude_from_totals, :is_pending, :has_children, :is_group
+
+      sig { returns(T::Array[LunchMoney::Objects::TagBase]) }
+      attr_accessor :tags
+
+      sig { returns(T.nilable(T::Array[LunchMoney::Objects::ChildTransaction])) }
+      attr_accessor :children
+
+      sig do
+        params(
+          id: Integer,
+          date: String,
+          amount: String,
+          currency: String,
+          to_base: Number,
+          payee: String,
+          is_income: T::Boolean,
+          exclude_from_budget: T::Boolean,
+          exclude_from_totals: T::Boolean,
+          created_at: String,
+          updated_at: String,
+          status: String,
+          is_pending: T::Boolean,
+          has_children: T::Boolean,
+          is_group: T::Boolean,
+          source: String,
+          display_name: String,
+          account_display_name: String,
+          tags: T::Array[LunchMoney::Objects::TagBase],
+          category_id: T.nilable(Integer),
+          category_name: T.nilable(String),
+          category_group_id: T.nilable(Integer),
+          category_group_name: T.nilable(String),
+          notes: T.nilable(String),
+          original_name: T.nilable(String),
+          recurring_id: T.nilable(Integer),
+          recurring_payee: T.nilable(String),
+          recurring_description: T.nilable(String),
+          recurring_cadence: T.nilable(String),
+          recurring_type: T.nilable(String),
+          recurring_amount: T.nilable(String),
+          recurring_currency: T.nilable(String),
+          parent_id: T.nilable(Integer),
+          group_id: T.nilable(Integer),
+          asset_id: T.nilable(Integer),
+          asset_institution_name: T.nilable(String),
+          asset_name: T.nilable(String),
+          asset_display_name: T.nilable(String),
+          asset_status: T.nilable(String),
+          plaid_account_id: T.nilable(Integer),
+          plaid_account_name: T.nilable(String),
+          plaid_account_mask: T.nilable(String),
+          institution_name: T.nilable(String),
+          plaid_account_display_name: T.nilable(String),
+          plaid_metadata: T.nilable(String),
+          display_notes: T.nilable(String),
+          external_id: T.nilable(Integer),
+          children: T.nilable(T::Array[LunchMoney::Objects::ChildTransaction]),
+        ).void
+      end
+      def initialize(id:, date:, amount:, currency:, to_base:, payee:, is_income:, exclude_from_budget:,
+        exclude_from_totals:, created_at:, updated_at:, status:, is_pending:, has_children:, is_group:, source:,
+        display_name:, account_display_name:, tags:, category_id: nil, category_name: nil, category_group_id: nil,
+        category_group_name: nil, notes: nil, original_name: nil, recurring_id: nil, recurring_payee: nil,
+        recurring_description: nil, recurring_cadence: nil, recurring_type: nil, recurring_amount: nil,
+        recurring_currency: nil, parent_id: nil, group_id: nil, asset_id: nil, asset_institution_name: nil,
+        asset_name: nil, asset_display_name: nil, asset_status: nil, plaid_account_id: nil, plaid_account_name: nil,
+        plaid_account_mask: nil, institution_name: nil, plaid_account_display_name: nil, plaid_metadata: nil,
+        display_notes: nil, external_id: nil, children: nil)
+        super(id:, date:, amount:, currency:, to_base:, payee:, notes:, asset_id:, plaid_account_id:)
+        @is_income = is_income
+        @exclude_from_budget = exclude_from_budget
+        @exclude_from_totals = exclude_from_totals
+        @created_at = created_at
+        @updated_at = updated_at
+        @status = status
+        @is_pending = is_pending
+        @has_children = has_children
+        @is_group = is_group
+        @source = source
+        @display_name = display_name
+        @account_display_name = account_display_name
+        @tags = tags
+        @category_id = category_id
+        @category_name = category_name
+        @category_group_id = category_group_id
+        @category_group_name = category_group_name
+        @original_name = original_name
+        @recurring_id = recurring_id
+        @recurring_payee = recurring_payee
+        @recurring_description = recurring_description
+        @recurring_cadence = recurring_cadence
+        @recurring_type = recurring_type
+        @recurring_amount = recurring_amount
+        @recurring_currency = recurring_currency
+        @parent_id = parent_id
+        @group_id = group_id
+        @asset_institution_name = asset_institution_name
+        @asset_name = asset_name
+        @asset_display_name = asset_display_name
+        @asset_status = asset_status
+        @plaid_account_name = plaid_account_name
+        @plaid_account_mask = plaid_account_mask
+        @institution_name = institution_name
+        @plaid_account_display_name = plaid_account_display_name
+        @plaid_metadata = plaid_metadata
+        @display_notes = display_notes
+        @children = children
+        @external_id = external_id
+      end
+    end
+  end
+end

data/lib/lunchmoney/objects/transaction_base.rb

@@ -0,0 +1,54 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LunchMoney
+  module Objects
+    # Slimmed down version of https://lunchmoney.dev/#transaction-object used as a base for other transaction objects
+    class TransactionBase < LunchMoney::Objects::Object
+      sig { returns(Integer) }
+      attr_accessor :id
+
+      sig { returns(Number) }
+      attr_accessor :to_base
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :asset_id, :plaid_account_id
+
+      sig { returns(String) }
+      attr_accessor :date,
+        :amount,
+        :currency,
+        :payee
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :notes
+
+      sig do
+        params(
+          id: Integer,
+          date: String,
+          amount: String,
+          currency: String,
+          to_base: Number,
+          payee: String,
+          notes: T.nilable(String),
+          asset_id: T.nilable(Integer),
+          plaid_account_id: T.nilable(Integer),
+        ).void
+      end
+      def initialize(id:, date:, amount:, currency:, to_base:, payee:, notes: nil, asset_id: nil,
+        plaid_account_id: nil)
+        super()
+        @id = id
+        @date = date
+        @amount = amount
+        @currency = currency
+        @to_base = to_base
+        @payee = payee
+        @notes = notes
+        @asset_id = asset_id
+        @plaid_account_id = plaid_account_id
+      end
+    end
+  end
+end

data/lib/lunchmoney/objects/transaction_modification_base.rb

@@ -0,0 +1,32 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LunchMoney
+  module Objects
+    # Base object used for transaction objects that are used to update
+    # transactions https://lunchmoney.dev/#update-transaction
+    class TransactionModificationBase < LunchMoney::Objects::Object
+      sig { returns(T.nilable(String)) }
+      attr_accessor :payee, :date, :notes
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :category_id
+
+      sig do
+        params(
+          payee: T.nilable(String),
+          date: T.nilable(String),
+          category_id: T.nilable(Integer),
+          notes: T.nilable(String),
+        ).void
+      end
+      def initialize(payee: nil, date: nil, category_id: nil, notes: nil)
+        super()
+        @payee = payee
+        @date = date
+        @category_id = category_id
+        @notes = notes
+      end
+    end
+  end
+end

data/lib/lunchmoney/objects/update_transaction.rb

@@ -0,0 +1,47 @@
+# typed: strict
+# frozen_string_literal: true
+
+require_relative "transaction_modification_base"
+
+module LunchMoney
+  module Objects
+    # object used when updating a transaction https://lunchmoney.dev/#update-transaction
+    class UpdateTransaction < TransactionModificationBase
+      sig { returns(T.nilable(String)) }
+      attr_accessor :amount, :currency, :status, :external_id
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :asset_id, :recurring_id
+
+      sig { returns(T.nilable(T::Array[T.any(String, Integer)])) }
+      attr_accessor :tags
+
+      sig do
+        params(
+          tags: T.nilable(T::Array[T.any(String, Integer)]),
+          category_id: T.nilable(Integer),
+          payee: T.nilable(String),
+          amount: T.nilable(String),
+          currency: T.nilable(String),
+          asset_id: T.nilable(Integer),
+          recurring_id: T.nilable(Integer),
+          notes: T.nilable(String),
+          status: T.nilable(String),
+          external_id: T.nilable(String),
+          date: T.nilable(String),
+        ).void
+      end
+      def initialize(tags: nil, category_id: nil, payee: nil, amount: nil, currency: nil, asset_id: nil,
+        recurring_id: nil, notes: nil, status: nil, external_id: nil, date: nil)
+        super(payee:, date:, category_id:, notes:)
+        @amount = amount
+        @tags = tags
+        @currency = currency
+        @asset_id = asset_id
+        @recurring_id = recurring_id
+        @status = status
+        @external_id = external_id
+      end
+    end
+  end
+end

data/lib/lunchmoney/objects/user.rb

@@ -0,0 +1,38 @@
+# typed: strict
+# frozen_string_literal: true
+
+module LunchMoney
+  module Objects
+    # https://lunchmoney.dev/#user-object
+    class User < LunchMoney::Objects::Object
+      sig { returns(Integer) }
+      attr_accessor :user_id, :account_id
+
+      sig { returns(String) }
+      attr_accessor :user_name, :user_email, :budget_name
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :api_key_label
+
+      sig do
+        params(
+          user_id: Integer,
+          user_name: String,
+          user_email: String,
+          account_id: Integer,
+          budget_name: String,
+          api_key_label: T.nilable(String),
+        ).void
+      end
+      def initialize(user_id:, user_name:, user_email:, account_id:, budget_name:, api_key_label: nil)
+        super()
+        @user_id = user_id
+        @user_name = user_name
+        @user_email = user_email
+        @account_id = account_id
+        @budget_name = budget_name
+        @api_key_label = api_key_label
+      end
+    end
+  end
+end

data/lib/lunchmoney/version.rb

@@ -3,5 +3,5 @@
 
 module LunchMoney
   # Current version of the gem
-  VERSION = "0.10.0"
+  VERSION = "1.1.0"
 end

data/lunchmoney.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.metadata["allowed_push_host"]  = "https://rubygems.org"
   spec.metadata["homepage_uri"]       = spec.homepage
   spec.metadata["source_code_uri"]    = spec.homepage
+  spec.metadata["documentation_uri"]  = "https://halorrr.github.io/lunchmoney/"
   spec.metadata["changelog_uri"]      = "#{spec.homepage}/releases"
 
   # Specify which files should be added to the gem when it is released.

data/sorbet/rbi/gems/activesupport@7.1.3.rbi

@@ -10908,43 +10908,43 @@ class ActiveSupport::TestCase < ::Minitest::Test
   # source://activesupport//lib/active_support/callbacks.rb#963
   def _teardown_callbacks; end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#736
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#736
   def assert_no_match(matcher, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#665
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#665
   def assert_not_empty(obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#676
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#676
   def assert_not_equal(exp, act, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#688
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#688
   def assert_not_in_delta(exp, act, delta = T.unsafe(nil), msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#700
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#700
   def assert_not_in_epsilon(a, b, epsilon = T.unsafe(nil), msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#707
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#707
   def assert_not_includes(collection, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#718
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#718
   def assert_not_instance_of(cls, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#728
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#728
   def assert_not_kind_of(cls, obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#746
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#746
   def assert_not_nil(obj, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#781
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#781
   def assert_not_operator(o1, op, o2 = T.unsafe(nil), msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#804
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#804
   def assert_not_predicate(o1, op, msg = T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#813
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#813
   def assert_not_respond_to(obj, meth, msg = T.unsafe(nil), include_all: T.unsafe(nil)); end
 
-  # source://minitest/5.21.1/lib/minitest/assertions.rb#822
+  # source://minitest/5.21.2/lib/minitest/assertions.rb#822
   def assert_not_same(exp, act, msg = T.unsafe(nil)); end
 
   # source://activesupport//lib/active_support/testing/file_fixtures.rb#20
@@ -10956,7 +10956,7 @@ class ActiveSupport::TestCase < ::Minitest::Test
   # source://activesupport//lib/active_support/test_case.rb#298
   def inspect; end
 
-  # source://minitest/5.21.1/lib/minitest.rb#311
+  # source://minitest/5.21.2/lib/minitest.rb#311
   def method_name; end
 
   class << self
@@ -13364,7 +13364,7 @@ end
 # source://activesupport//lib/active_support/xml_mini/rexml.rb#11
 ActiveSupport::XmlMini_REXML::CONTENT_KEY = T.let(T.unsafe(nil), String)
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#83
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#39
 class Array
   include ::Enumerable
 
@@ -13699,6 +13699,13 @@ class Date
   # source://activesupport//lib/active_support/core_ext/date/calculations.rb#152
   def <=>(other); end
 
+  # Duck-types as a Date-like class. See Object#acts_like?.
+  #
+  # @return [Boolean]
+  #
+  # source://activesupport//lib/active_support/core_ext/date/acts_like.rb#7
+  def acts_like_date?; end
+
   # Provides precise Date calculations for years, months, and days. The +options+ parameter takes a hash with
   # any of these keys: <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>.
   #
@@ -15253,7 +15260,7 @@ class Exception
   def as_json(options = T.unsafe(nil)); end
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#61
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#32
 class FalseClass
   # source://activesupport//lib/active_support/core_ext/object/json.rb#89
   def as_json(options = T.unsafe(nil)); end
@@ -16397,7 +16404,7 @@ class NameError < ::StandardError
   include ::DidYouMean::Correctable
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#50
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#18
 class NilClass
   # source://activesupport//lib/active_support/core_ext/object/json.rb#95
   def as_json(options = T.unsafe(nil)); end
@@ -16438,7 +16445,7 @@ class NilClass
   def try!(*_arg0); end
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#134
+# source://activesupport//lib/active_support/core_ext/numeric/time.rb#9
 class Numeric
   include ::Comparable
 
@@ -16469,6 +16476,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#15
   def bytes; end
 
+  # Returns a Duration instance matching the number of days provided.
+  #
+  #   2.days # => 2 days
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#37
+  def day; end
+
+  # Returns a Duration instance matching the number of days provided.
+  #
+  #   2.days # => 2 days
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#37
+  def days; end
+
   # Returns the number of bytes equivalent to the exabytes provided.
   #
   #   2.exabytes # => 2_305_843_009_213_693_952
@@ -16483,6 +16504,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#63
   def exabytes; end
 
+  # Returns a Duration instance matching the number of fortnights provided.
+  #
+  #   2.fortnights # => 4 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#53
+  def fortnight; end
+
+  # Returns a Duration instance matching the number of fortnights provided.
+  #
+  #   2.fortnights # => 4 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#53
+  def fortnights; end
+
   # Returns the number of bytes equivalent to the gigabytes provided.
   #
   #   2.gigabytes # => 2_147_483_648
@@ -16497,11 +16532,34 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#39
   def gigabytes; end
 
+  # Returns a Duration instance matching the number of hours provided.
+  #
+  #   2.hours # => 2 hours
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#29
+  def hour; end
+
+  # Returns a Duration instance matching the number of hours provided.
+  #
+  #   2.hours # => 2 hours
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#29
+  def hours; end
+
   # @return [Boolean]
   #
   # source://activesupport//lib/active_support/core_ext/string/output_safety.rb#13
   def html_safe?; end
 
+  # Returns the number of milliseconds equivalent to the seconds provided.
+  # Used with the standard time durations.
+  #
+  #   2.in_milliseconds # => 2000
+  #   1.hour.in_milliseconds # => 3600000
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#63
+  def in_milliseconds; end
+
   # Returns the number of bytes equivalent to the kilobytes provided.
   #
   #   2.kilobytes # => 2048
@@ -16530,6 +16588,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#31
   def megabytes; end
 
+  # Returns a Duration instance matching the number of minutes provided.
+  #
+  #   2.minutes # => 2 minutes
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#21
+  def minute; end
+
+  # Returns a Duration instance matching the number of minutes provided.
+  #
+  #   2.minutes # => 2 minutes
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#21
+  def minutes; end
+
   # Returns the number of bytes equivalent to the petabytes provided.
   #
   #   2.petabytes # => 2_251_799_813_685_248
@@ -16544,6 +16616,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#55
   def petabytes; end
 
+  # Returns a Duration instance matching the number of seconds provided.
+  #
+  #   2.seconds # => 2 seconds
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#13
+  def second; end
+
+  # Returns a Duration instance matching the number of seconds provided.
+  #
+  #   2.seconds # => 2 seconds
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#13
+  def seconds; end
+
   # Returns the number of bytes equivalent to the terabytes provided.
   #
   #   2.terabytes # => 2_199_023_255_552
@@ -16558,6 +16644,20 @@ class Numeric
   # source://activesupport//lib/active_support/core_ext/numeric/bytes.rb#47
   def terabytes; end
 
+  # Returns a Duration instance matching the number of weeks provided.
+  #
+  #   2.weeks # => 2 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#45
+  def week; end
+
+  # Returns a Duration instance matching the number of weeks provided.
+  #
+  #   2.weeks # => 2 weeks
+  #
+  # source://activesupport//lib/active_support/core_ext/numeric/time.rb#45
+  def weeks; end
+
   # Returns the number of bytes equivalent to the zettabytes provided.
   #
   #   2.zettabytes # => 2_361_183_241_434_822_606_848
@@ -16613,7 +16713,7 @@ Numeric::ZETTABYTE = T.let(T.unsafe(nil), Integer)
 # using that rescue idiom.
 # ++
 #
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#5
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#5
 class Object < ::BasicObject
   include ::ActiveSupport::ToJsonWithActiveSupportEncoder
   include ::ActiveSupport::Dependencies::RequireDependency
@@ -16820,7 +16920,7 @@ end
 #
 #   'ScaleScore'.tableize # => "scale_scores"
 #
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#103
+# source://activesupport//lib/active_support/core_ext/string/multibyte.rb#5
 class String
   include ::Comparable
 
@@ -17477,7 +17577,7 @@ class Thread
   def active_support_execution_state=(_arg0); end
 end
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#146
+# source://activesupport//lib/active_support/core_ext/time/conversions.rb#7
 class Time
   include ::Comparable
   include ::DateAndTime::Zones
@@ -17974,7 +18074,7 @@ Time::COMMON_YEAR_DAYS_IN_MONTH = T.let(T.unsafe(nil), Array)
 # source://activesupport//lib/active_support/core_ext/time/conversions.rb#8
 Time::DATE_FORMATS = T.let(T.unsafe(nil), Hash)
 
-# source://activesupport//lib/active_support/core_ext/object/blank.rb#72
+# source://activesupport//lib/active_support/core_ext/object/to_query.rb#25
 class TrueClass
   # source://activesupport//lib/active_support/core_ext/object/json.rb#83
   def as_json(options = T.unsafe(nil)); end