increase 1.307.0 → 1.309.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 366856992f2d29a07ae7bf8a2865c542ce478a313a6f9289d68e363b55528098
-  data.tar.gz: dd738c4b3f4d92def3a77daf60990d089cf3d018654db3569b4aa2b549dcf208
+  metadata.gz: 5c0101f8c177f28381665f2dda29f4a10d5628db123807a5da25f80b9e7ee961
+  data.tar.gz: 3c0171648e3432f2ad428abab432aaac879538594ac63ecec1de5d715b1f18e7
 SHA512:
-  metadata.gz: 2d5fbe7d28633d0b71e91e991f9646e4ee0a8dd2ea1bfd27aad06039579351ffb18b6bd94aeab812e5572289419310e17bbdd2249e681fe2f384d2384c7aa96f
-  data.tar.gz: f452ee4077cb63e144dffd555c50319f6b8406e55540b9b28662b45136160faf9ce4167ca905d145f2c75472724e83e57a5c5c0c4e945cd380fc879d507ca8d8
+  metadata.gz: 7324fdfd5c3023e4d7c9b620cb17c76a00a8c1f6ccc6e08369935962d60bf2e5b58d7bead918ca022e66321ac65726fdf8911afbcdc38979650751102dd5624c
+  data.tar.gz: 55fef30ae1c6566606cedf6fa9c779a07f526afb1e3c91208bfe47272f2974fefcadc5178df23b15f09510252ddb47b2410331a8aea39a4c6e61cc26172daf51

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.309.0 (2026-04-28)
+
+Full Changelog: [v1.308.0...v1.309.0](https://github.com/Increase/increase-ruby/compare/v1.308.0...v1.309.0)
+
+### Features
+
+* **api:** api update ([7ed5b8e](https://github.com/Increase/increase-ruby/commit/7ed5b8ed41c30aa9b10df342b6d4e543d5312a4b))
+
+## 1.308.0 (2026-04-28)
+
+Full Changelog: [v1.307.0...v1.308.0](https://github.com/Increase/increase-ruby/compare/v1.307.0...v1.308.0)
+
+### Features
+
+* **api:** api update ([6fa981d](https://github.com/Increase/increase-ruby/commit/6fa981d1d86efa613341bc8a6b085df29e0c8658))
+
 ## 1.307.0 (2026-04-28)
 
 Full Changelog: [v1.306.0...v1.307.0](https://github.com/Increase/increase-ruby/compare/v1.306.0...v1.307.0)

data/README.md

@@ -15,7 +15,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "increase", "~> 1.307.0"
+gem "increase", "~> 1.309.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/inbound_mail_item.rb

@@ -32,8 +32,8 @@ module Increase
       # @!attribute lockbox_address_id
       #   The identifier for the Lockbox Address that received this mail item.
       #
-      #   @return [String, nil]
-      required :lockbox_address_id, String, nil?: true
+      #   @return [String]
+      required :lockbox_address_id, String
 
       # @!attribute lockbox_recipient_id
       #   The identifier for the Lockbox Recipient that received this mail item. For mail
@@ -82,7 +82,7 @@ module Increase
       #
       #   @param file_id [String] The identifier for the File containing the scanned contents of the mail item.
       #
-      #   @param lockbox_address_id [String, nil] The identifier for the Lockbox Address that received this mail item.
+      #   @param lockbox_address_id [String] The identifier for the Lockbox Address that received this mail item.
       #
       #   @param lockbox_recipient_id [String, nil] The identifier for the Lockbox Recipient that received this mail item. For mail
       #

data/lib/increase/models/simulations/account_revenue_payment_create_params.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    module Simulations
+      # @see Increase::Resources::Simulations::AccountRevenuePayments#create
+      class AccountRevenuePaymentCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        # @!attribute account_id
+        #   The identifier of the Account the Account Revenue Payment should be paid to.
+        #
+        #   @return [String]
+        required :account_id, String
+
+        # @!attribute amount
+        #   The account revenue amount in cents. Must be positive.
+        #
+        #   @return [Integer]
+        required :amount, Integer
+
+        # @!attribute accrued_on_account_id
+        #   The identifier of the Account the account revenue accrued on. Defaults to
+        #   `account_id`.
+        #
+        #   @return [String, nil]
+        optional :accrued_on_account_id, String
+
+        # @!attribute period_end
+        #   The end of the account revenue period. If not provided, defaults to the current
+        #   time.
+        #
+        #   @return [Time, nil]
+        optional :period_end, Time
+
+        # @!attribute period_start
+        #   The start of the account revenue period. If not provided, defaults to the
+        #   current time.
+        #
+        #   @return [Time, nil]
+        optional :period_start, Time
+
+        # @!method initialize(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::Simulations::AccountRevenuePaymentCreateParams} for more
+        #   details.
+        #
+        #   @param account_id [String] The identifier of the Account the Account Revenue Payment should be paid to.
+        #
+        #   @param amount [Integer] The account revenue amount in cents. Must be positive.
+        #
+        #   @param accrued_on_account_id [String] The identifier of the Account the account revenue accrued on. Defaults to `accou
+        #
+        #   @param period_end [Time] The end of the account revenue period. If not provided, defaults to the current
+        #
+        #   @param period_start [Time] The start of the account revenue period. If not provided, defaults to the curren
+        #
+        #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations/account_revenue_payments.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class AccountRevenuePayments
+        # Some parameter documentations has been truncated, see
+        # {Increase::Models::Simulations::AccountRevenuePaymentCreateParams} for more
+        # details.
+        #
+        # Simulates an account revenue payment to your account. In production, this
+        # happens automatically on the first of each month.
+        #
+        # @overload create(account_id:, amount:, accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {})
+        #
+        # @param account_id [String] The identifier of the Account the Account Revenue Payment should be paid to.
+        #
+        # @param amount [Integer] The account revenue amount in cents. Must be positive.
+        #
+        # @param accrued_on_account_id [String] The identifier of the Account the account revenue accrued on. Defaults to `accou
+        #
+        # @param period_end [Time] The end of the account revenue period. If not provided, defaults to the current
+        #
+        # @param period_start [Time] The start of the account revenue period. If not provided, defaults to the curren
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Transaction]
+        #
+        # @see Increase::Models::Simulations::AccountRevenuePaymentCreateParams
+        def create(params)
+          parsed, options = Increase::Simulations::AccountRevenuePaymentCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "simulations/account_revenue_payments",
+            body: parsed,
+            model: Increase::Transaction,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations.rb

@@ -6,6 +6,9 @@ module Increase
       # @return [Increase::Resources::Simulations::InterestPayments]
       attr_reader :interest_payments
 
+      # @return [Increase::Resources::Simulations::AccountRevenuePayments]
+      attr_reader :account_revenue_payments
+
       # @return [Increase::Resources::Simulations::CardAuthorizations]
       attr_reader :card_authorizations
 
@@ -108,6 +111,7 @@ module Increase
       def initialize(client:)
         @client = client
         @interest_payments = Increase::Resources::Simulations::InterestPayments.new(client: client)
+        @account_revenue_payments = Increase::Resources::Simulations::AccountRevenuePayments.new(client: client)
         @card_authorizations = Increase::Resources::Simulations::CardAuthorizations.new(client: client)
         @card_balance_inquiries = Increase::Resources::Simulations::CardBalanceInquiries.new(client: client)
         @card_authorization_expirations =

data/lib/increase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Increase
-  VERSION = "1.307.0"
+  VERSION = "1.309.0"
 end

data/lib/increase.rb

@@ -284,6 +284,7 @@ require_relative "increase/models/real_time_payments_transfer_list_params"
 require_relative "increase/models/real_time_payments_transfer_retrieve_params"
 require_relative "increase/models/routing_number_list_params"
 require_relative "increase/models/routing_number_list_response"
+require_relative "increase/models/simulations/account_revenue_payment_create_params"
 require_relative "increase/models/simulations/account_statement_create_params"
 require_relative "increase/models/simulations/ach_transfer_acknowledge_params"
 require_relative "increase/models/simulations/ach_transfer_create_notification_of_change_params"
@@ -407,6 +408,7 @@ require_relative "increase/resources/real_time_decisions"
 require_relative "increase/resources/real_time_payments_transfers"
 require_relative "increase/resources/routing_numbers"
 require_relative "increase/resources/simulations"
+require_relative "increase/resources/simulations/account_revenue_payments"
 require_relative "increase/resources/simulations/account_statements"
 require_relative "increase/resources/simulations/ach_transfers"
 require_relative "increase/resources/simulations/card_authentications"

data/rbi/increase/models/inbound_mail_item.rbi

@@ -26,7 +26,7 @@ module Increase
       attr_accessor :file_id
 
       # The identifier for the Lockbox Address that received this mail item.
-      sig { returns(T.nilable(String)) }
+      sig { returns(String) }
       attr_accessor :lockbox_address_id
 
       # The identifier for the Lockbox Recipient that received this mail item. For mail
@@ -63,7 +63,7 @@ module Increase
           checks: T::Array[Increase::InboundMailItem::Check::OrHash],
           created_at: Time,
           file_id: String,
-          lockbox_address_id: T.nilable(String),
+          lockbox_address_id: String,
           lockbox_recipient_id: T.nilable(String),
           recipient_name: T.nilable(String),
           rejection_reason:
@@ -106,7 +106,7 @@ module Increase
             checks: T::Array[Increase::InboundMailItem::Check],
             created_at: Time,
             file_id: String,
-            lockbox_address_id: T.nilable(String),
+            lockbox_address_id: String,
             lockbox_recipient_id: T.nilable(String),
             recipient_name: T.nilable(String),
             rejection_reason:

data/rbi/increase/models/simulations/account_revenue_payment_create_params.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Increase
+  module Models
+    module Simulations
+      class AccountRevenuePaymentCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::Simulations::AccountRevenuePaymentCreateParams,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The identifier of the Account the Account Revenue Payment should be paid to.
+        sig { returns(String) }
+        attr_accessor :account_id
+
+        # The account revenue amount in cents. Must be positive.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The identifier of the Account the account revenue accrued on. Defaults to
+        # `account_id`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :accrued_on_account_id
+
+        sig { params(accrued_on_account_id: String).void }
+        attr_writer :accrued_on_account_id
+
+        # The end of the account revenue period. If not provided, defaults to the current
+        # time.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :period_end
+
+        sig { params(period_end: Time).void }
+        attr_writer :period_end
+
+        # The start of the account revenue period. If not provided, defaults to the
+        # current time.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :period_start
+
+        sig { params(period_start: Time).void }
+        attr_writer :period_start
+
+        sig do
+          params(
+            account_id: String,
+            amount: Integer,
+            accrued_on_account_id: String,
+            period_end: Time,
+            period_start: Time,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The identifier of the Account the Account Revenue Payment should be paid to.
+          account_id:,
+          # The account revenue amount in cents. Must be positive.
+          amount:,
+          # The identifier of the Account the account revenue accrued on. Defaults to
+          # `account_id`.
+          accrued_on_account_id: nil,
+          # The end of the account revenue period. If not provided, defaults to the current
+          # time.
+          period_end: nil,
+          # The start of the account revenue period. If not provided, defaults to the
+          # current time.
+          period_start: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              account_id: String,
+              amount: Integer,
+              accrued_on_account_id: String,
+              period_end: Time,
+              period_start: Time,
+              request_options: Increase::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations/account_revenue_payments.rbi

@@ -0,0 +1,44 @@
+# typed: strong
+
+module Increase
+  module Resources
+    class Simulations
+      class AccountRevenuePayments
+        # Simulates an account revenue payment to your account. In production, this
+        # happens automatically on the first of each month.
+        sig do
+          params(
+            account_id: String,
+            amount: Integer,
+            accrued_on_account_id: String,
+            period_end: Time,
+            period_start: Time,
+            request_options: Increase::RequestOptions::OrHash
+          ).returns(Increase::Transaction)
+        end
+        def create(
+          # The identifier of the Account the Account Revenue Payment should be paid to.
+          account_id:,
+          # The account revenue amount in cents. Must be positive.
+          amount:,
+          # The identifier of the Account the account revenue accrued on. Defaults to
+          # `account_id`.
+          accrued_on_account_id: nil,
+          # The end of the account revenue period. If not provided, defaults to the current
+          # time.
+          period_end: nil,
+          # The start of the account revenue period. If not provided, defaults to the
+          # current time.
+          period_start: nil,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Increase::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/increase/resources/simulations.rbi

@@ -6,6 +6,9 @@ module Increase
       sig { returns(Increase::Resources::Simulations::InterestPayments) }
       attr_reader :interest_payments
 
+      sig { returns(Increase::Resources::Simulations::AccountRevenuePayments) }
+      attr_reader :account_revenue_payments
+
       sig { returns(Increase::Resources::Simulations::CardAuthorizations) }
       attr_reader :card_authorizations
 

data/sig/increase/models/inbound_mail_item.rbs

@@ -6,7 +6,7 @@ module Increase
         checks: ::Array[Increase::InboundMailItem::Check],
         created_at: Time,
         file_id: String,
-        lockbox_address_id: String?,
+        lockbox_address_id: String,
         lockbox_recipient_id: String?,
         recipient_name: String?,
         rejection_reason: Increase::Models::InboundMailItem::rejection_reason?,
@@ -23,7 +23,7 @@ module Increase
 
       attr_accessor file_id: String
 
-      attr_accessor lockbox_address_id: String?
+      attr_accessor lockbox_address_id: String
 
       attr_accessor lockbox_recipient_id: String?
 
@@ -40,7 +40,7 @@ module Increase
         checks: ::Array[Increase::InboundMailItem::Check],
         created_at: Time,
         file_id: String,
-        lockbox_address_id: String?,
+        lockbox_address_id: String,
         lockbox_recipient_id: String?,
         recipient_name: String?,
         rejection_reason: Increase::Models::InboundMailItem::rejection_reason?,
@@ -53,7 +53,7 @@ module Increase
         checks: ::Array[Increase::InboundMailItem::Check],
         created_at: Time,
         file_id: String,
-        lockbox_address_id: String?,
+        lockbox_address_id: String,
         lockbox_recipient_id: String?,
         recipient_name: String?,
         rejection_reason: Increase::Models::InboundMailItem::rejection_reason?,

data/sig/increase/models/simulations/account_revenue_payment_create_params.rbs

@@ -0,0 +1,54 @@
+module Increase
+  module Models
+    module Simulations
+      type account_revenue_payment_create_params =
+        {
+          account_id: String,
+          amount: Integer,
+          accrued_on_account_id: String,
+          period_end: Time,
+          period_start: Time
+        }
+        & Increase::Internal::Type::request_parameters
+
+      class AccountRevenuePaymentCreateParams < Increase::Internal::Type::BaseModel
+        extend Increase::Internal::Type::RequestParameters::Converter
+        include Increase::Internal::Type::RequestParameters
+
+        attr_accessor account_id: String
+
+        attr_accessor amount: Integer
+
+        attr_reader accrued_on_account_id: String?
+
+        def accrued_on_account_id=: (String) -> String
+
+        attr_reader period_end: Time?
+
+        def period_end=: (Time) -> Time
+
+        attr_reader period_start: Time?
+
+        def period_start=: (Time) -> Time
+
+        def initialize: (
+          account_id: String,
+          amount: Integer,
+          ?accrued_on_account_id: String,
+          ?period_end: Time,
+          ?period_start: Time,
+          ?request_options: Increase::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          account_id: String,
+          amount: Integer,
+          accrued_on_account_id: String,
+          period_end: Time,
+          period_start: Time,
+          request_options: Increase::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/increase/resources/simulations/account_revenue_payments.rbs

@@ -0,0 +1,18 @@
+module Increase
+  module Resources
+    class Simulations
+      class AccountRevenuePayments
+        def create: (
+          account_id: String,
+          amount: Integer,
+          ?accrued_on_account_id: String,
+          ?period_end: Time,
+          ?period_start: Time,
+          ?request_options: Increase::request_opts
+        ) -> Increase::Transaction
+
+        def initialize: (client: Increase::Client) -> void
+      end
+    end
+  end
+end

data/sig/increase/resources/simulations.rbs

@@ -3,6 +3,8 @@ module Increase
     class Simulations
       attr_reader interest_payments: Increase::Resources::Simulations::InterestPayments
 
+      attr_reader account_revenue_payments: Increase::Resources::Simulations::AccountRevenuePayments
+
       attr_reader card_authorizations: Increase::Resources::Simulations::CardAuthorizations
 
       attr_reader card_balance_inquiries: Increase::Resources::Simulations::CardBalanceInquiries

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: increase
 version: !ruby/object:Gem::Version
-  version: 1.307.0
+  version: 1.309.0
 platform: ruby
 authors:
 - Increase
@@ -314,6 +314,7 @@ files:
 - lib/increase/models/real_time_payments_transfer_retrieve_params.rb
 - lib/increase/models/routing_number_list_params.rb
 - lib/increase/models/routing_number_list_response.rb
+- lib/increase/models/simulations/account_revenue_payment_create_params.rb
 - lib/increase/models/simulations/account_statement_create_params.rb
 - lib/increase/models/simulations/ach_transfer_acknowledge_params.rb
 - lib/increase/models/simulations/ach_transfer_create_notification_of_change_params.rb
@@ -437,6 +438,7 @@ files:
 - lib/increase/resources/real_time_payments_transfers.rb
 - lib/increase/resources/routing_numbers.rb
 - lib/increase/resources/simulations.rb
+- lib/increase/resources/simulations/account_revenue_payments.rb
 - lib/increase/resources/simulations/account_statements.rb
 - lib/increase/resources/simulations/ach_transfers.rb
 - lib/increase/resources/simulations/card_authentications.rb
@@ -727,6 +729,7 @@ files:
 - rbi/increase/models/real_time_payments_transfer_retrieve_params.rbi
 - rbi/increase/models/routing_number_list_params.rbi
 - rbi/increase/models/routing_number_list_response.rbi
+- rbi/increase/models/simulations/account_revenue_payment_create_params.rbi
 - rbi/increase/models/simulations/account_statement_create_params.rbi
 - rbi/increase/models/simulations/ach_transfer_acknowledge_params.rbi
 - rbi/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbi
@@ -850,6 +853,7 @@ files:
 - rbi/increase/resources/real_time_payments_transfers.rbi
 - rbi/increase/resources/routing_numbers.rbi
 - rbi/increase/resources/simulations.rbi
+- rbi/increase/resources/simulations/account_revenue_payments.rbi
 - rbi/increase/resources/simulations/account_statements.rbi
 - rbi/increase/resources/simulations/ach_transfers.rbi
 - rbi/increase/resources/simulations/card_authentications.rbi
@@ -1139,6 +1143,7 @@ files:
 - sig/increase/models/real_time_payments_transfer_retrieve_params.rbs
 - sig/increase/models/routing_number_list_params.rbs
 - sig/increase/models/routing_number_list_response.rbs
+- sig/increase/models/simulations/account_revenue_payment_create_params.rbs
 - sig/increase/models/simulations/account_statement_create_params.rbs
 - sig/increase/models/simulations/ach_transfer_acknowledge_params.rbs
 - sig/increase/models/simulations/ach_transfer_create_notification_of_change_params.rbs
@@ -1262,6 +1267,7 @@ files:
 - sig/increase/resources/real_time_payments_transfers.rbs
 - sig/increase/resources/routing_numbers.rbs
 - sig/increase/resources/simulations.rbs
+- sig/increase/resources/simulations/account_revenue_payments.rbs
 - sig/increase/resources/simulations/account_statements.rbs
 - sig/increase/resources/simulations/ach_transfers.rbs
 - sig/increase/resources/simulations/card_authentications.rbs