increase 1.304.0 → 1.306.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7cca7a937055c57a9fe020b17a1e81f94c93fbace7b7f00aaa64cb4f41c3cbb
-  data.tar.gz: 5f3a2809970ae0177f22535262f74d49f676f93d65be3e01100c431d7aa9467b
+  metadata.gz: 6d234bc5f9f6bd135cceadb10a2cb3a1c2dc44180e102f5c1f4c5b92f4476b4f
+  data.tar.gz: 7bc7d7b36a35b22a6b8a959f1f3ca5da037f3d8248c6168f86f4f205c8fdf69d
 SHA512:
-  metadata.gz: 8a338378999a26027dda36bae1be54bfd3faa3bfa86b361c960ec09290f15885df62755e21c7b80541874dfa4a35f19a4a0d3a0d99ca4d9f4591e30b92e3c70e
-  data.tar.gz: ff44beda40d4b986af12e5eea6ed666629f7e12bab8ebf7bc09e2a5ff6e588f15c120efd0e5f4b043bc0e64e45398d9c52ba91de9b9623efff5723f71bdd6d44
+  metadata.gz: fa162b7c741e7ae004f8ad3981a1f77bb0b3a1a025597d03a3cabcb5ae63815284570204b7461acb451d2003a2fe1b98af37cd3b25198c490226548e2294a71a
+  data.tar.gz: c5024a1bb5884d4d5b1c45c167aa96c6f7af87e8242d12a53df6c8e0ef72dc7164428d7c052e1e83d8f7c361c9515be2975df484109a71f9ab98cae926c9efad

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 1.306.0 (2026-04-27)
+
+Full Changelog: [v1.305.0...v1.306.0](https://github.com/Increase/increase-ruby/compare/v1.305.0...v1.306.0)
+
+### Features
+
+* support setting headers via env ([eddd2c7](https://github.com/Increase/increase-ruby/commit/eddd2c71aea09fa892b0c2e4c2a49c8033bb8871))
+
+## 1.305.0 (2026-04-27)
+
+Full Changelog: [v1.304.0...v1.305.0](https://github.com/Increase/increase-ruby/compare/v1.304.0...v1.305.0)
+
+### Features
+
+* **api:** api update ([5e8547a](https://github.com/Increase/increase-ruby/commit/5e8547a8f860d23a7595c630b5f0e076f9fbd87c))
+* **api:** api update ([a1819e1](https://github.com/Increase/increase-ruby/commit/a1819e1664e37290f8beea3a2949ef713e9d73bb))
+
 ## 1.304.0 (2026-04-22)
 
 Full Changelog: [v1.303.0...v1.304.0](https://github.com/Increase/increase-ruby/compare/v1.303.0...v1.304.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.304.0"
+gem "increase", "~> 1.306.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/client.rb

@@ -113,8 +113,11 @@ module Increase
     # @return [Increase::Resources::CheckDeposits]
     attr_reader :check_deposits
 
-    # @return [Increase::Resources::Lockboxes]
-    attr_reader :lockboxes
+    # @return [Increase::Resources::LockboxAddresses]
+    attr_reader :lockbox_addresses
+
+    # @return [Increase::Resources::LockboxRecipients]
+    attr_reader :lockbox_recipients
 
     # @return [Increase::Resources::InboundMailItems]
     attr_reader :inbound_mail_items
@@ -248,6 +251,19 @@ module Increase
         raise ArgumentError.new("api_key is required, and can be set via environ: \"INCREASE_API_KEY\"")
       end
 
+      headers = {}
+      custom_headers_env = ENV["INCREASE_CUSTOM_HEADERS"]
+      unless custom_headers_env.nil?
+        parsed = {}
+        custom_headers_env.split("\n").each do |line|
+          colon = line.index(":")
+          unless colon.nil?
+            parsed[line[0...colon].strip] = line[(colon + 1)..].strip
+          end
+        end
+        headers = parsed.merge(headers)
+      end
+
       @api_key = api_key.to_s
       @webhook_secret = webhook_secret&.to_s
 
@@ -257,6 +273,7 @@ module Increase
         max_retries: max_retries,
         initial_retry_delay: initial_retry_delay,
         max_retry_delay: max_retry_delay,
+        headers: headers,
         idempotency_header: idempotency_header
       )
 
@@ -290,7 +307,8 @@ module Increase
       @inbound_fednow_transfers = Increase::Resources::InboundFednowTransfers.new(client: self)
       @swift_transfers = Increase::Resources::SwiftTransfers.new(client: self)
       @check_deposits = Increase::Resources::CheckDeposits.new(client: self)
-      @lockboxes = Increase::Resources::Lockboxes.new(client: self)
+      @lockbox_addresses = Increase::Resources::LockboxAddresses.new(client: self)
+      @lockbox_recipients = Increase::Resources::LockboxRecipients.new(client: self)
       @inbound_mail_items = Increase::Resources::InboundMailItems.new(client: self)
       @routing_numbers = Increase::Resources::RoutingNumbers.new(client: self)
       @external_accounts = Increase::Resources::ExternalAccounts.new(client: self)

data/lib/increase/models/card_push_transfer.rb

@@ -1309,6 +1309,9 @@ module Increase
         # Mastercard and Maestro
         MASTERCARD = :mastercard
 
+        # Pulse
+        PULSE = :pulse
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models/card_token_capabilities.rb

@@ -109,6 +109,9 @@ module Increase
           # Mastercard and Maestro
           MASTERCARD = :mastercard
 
+          # Pulse
+          PULSE = :pulse
+
           # @!method self.values
           #   @return [Array<Symbol>]
         end

data/lib/increase/models/card_validation.rb

@@ -771,6 +771,9 @@ module Increase
         # Mastercard and Maestro
         MASTERCARD = :mastercard
 
+        # Pulse
+        PULSE = :pulse
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models/check_deposit.rb

@@ -105,12 +105,13 @@ module Increase
       #   @return [String, nil]
       required :inbound_mail_item_id, String, nil?: true
 
-      # @!attribute lockbox_id
-      #   If the Check Deposit was the result of an Inbound Mail Item, this will contain
-      #   the identifier of the Lockbox that received it.
+      # @!attribute lockbox_recipient_id
+      #   If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox
+      #   Recipient, this will contain the identifier of the Lockbox Recipient that
+      #   received it.
       #
       #   @return [String, nil]
-      required :lockbox_id, String, nil?: true
+      required :lockbox_recipient_id, String, nil?: true
 
       # @!attribute status
       #   The status of the Check Deposit.
@@ -131,7 +132,7 @@ module Increase
       #   @return [Symbol, Increase::Models::CheckDeposit::Type]
       required :type, enum: -> { Increase::CheckDeposit::Type }
 
-      # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_adjustments:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_id:, status:, transaction_id:, type:)
+      # @!method initialize(id:, account_id:, amount:, back_image_file_id:, created_at:, deposit_acceptance:, deposit_adjustments:, deposit_rejection:, deposit_return:, deposit_submission:, description:, front_image_file_id:, idempotency_key:, inbound_funds_hold:, inbound_mail_item_id:, lockbox_recipient_id:, status:, transaction_id:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::CheckDeposit} for more details.
       #
@@ -167,7 +168,7 @@ module Increase
       #
       #   @param inbound_mail_item_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item, this will contain t
       #
-      #   @param lockbox_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item, this will contain t
+      #   @param lockbox_recipient_id [String, nil] If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox
       #
       #   @param status [Symbol, Increase::Models::CheckDeposit::Status] The status of the Check Deposit.
       #

data/lib/increase/models/inbound_mail_item.rb

@@ -29,12 +29,18 @@ module Increase
       #   @return [String]
       required :file_id, String
 
-      # @!attribute lockbox_id
-      #   The identifier for the Lockbox that received this mail item. For mail items that
-      #   could not be processed due to an invalid address, this will be null.
+      # @!attribute lockbox_address_id
+      #   The identifier for the Lockbox Address that received this mail item.
       #
       #   @return [String, nil]
-      required :lockbox_id, String, nil?: true
+      required :lockbox_address_id, String, nil?: true
+
+      # @!attribute lockbox_recipient_id
+      #   The identifier for the Lockbox Recipient that received this mail item. For mail
+      #   items that could not be routed to a Lockbox Recipient, this will be null.
+      #
+      #   @return [String, nil]
+      required :lockbox_recipient_id, String, nil?: true
 
       # @!attribute recipient_name
       #   The recipient name as written on the mail item.
@@ -61,11 +67,12 @@ module Increase
       #   @return [Symbol, Increase::Models::InboundMailItem::Type]
       required :type, enum: -> { Increase::InboundMailItem::Type }
 
-      # @!method initialize(id:, checks:, created_at:, file_id:, lockbox_id:, recipient_name:, rejection_reason:, status:, type:)
+      # @!method initialize(id:, checks:, created_at:, file_id:, lockbox_address_id:, lockbox_recipient_id:, recipient_name:, rejection_reason:, status:, type:)
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::InboundMailItem} for more details.
       #
-      #   Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.
+      #   Inbound Mail Items represent pieces of physical mail delivered to a Lockbox
+      #   Address.
       #
       #   @param id [String] The Inbound Mail Item identifier.
       #
@@ -75,7 +82,9 @@ module Increase
       #
       #   @param file_id [String] The identifier for the File containing the scanned contents of the mail item.
       #
-      #   @param lockbox_id [String, nil] The identifier for the Lockbox that received this mail item. For mail items that
+      #   @param lockbox_address_id [String, nil] 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
       #
       #   @param recipient_name [String, nil] The recipient name as written on the mail item.
       #
@@ -164,6 +173,12 @@ module Increase
         # The Lockbox or its associated Account is not active.
         LOCKBOX_NOT_ACTIVE = :lockbox_not_active
 
+        # The Lockbox Address is not active.
+        LOCKBOX_ADDRESS_NOT_ACTIVE = :lockbox_address_not_active
+
+        # The Lockbox Recipient or its associated Account is not active.
+        LOCKBOX_RECIPIENT_NOT_ACTIVE = :lockbox_recipient_not_active
+
         # @!method self.values
         #   @return [Array<Symbol>]
       end

data/lib/increase/models/inbound_mail_item_list_params.rb

@@ -25,13 +25,19 @@ module Increase
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!attribute lockbox_id
-      #   Filter Inbound Mail Items to ones sent to the provided Lockbox.
+      # @!attribute lockbox_address_id
+      #   Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
       #
       #   @return [String, nil]
-      optional :lockbox_id, String
+      optional :lockbox_address_id, String
 
-      # @!method initialize(created_at: nil, cursor: nil, limit: nil, lockbox_id: nil, request_options: {})
+      # @!attribute lockbox_recipient_id
+      #   Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
+      #
+      #   @return [String, nil]
+      optional :lockbox_recipient_id, String
+
+      # @!method initialize(created_at: nil, cursor: nil, limit: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Increase::Models::InboundMailItemListParams} for more details.
       #
@@ -41,7 +47,9 @@ module Increase
       #
       #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
       #
-      #   @param lockbox_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox.
+      #   @param lockbox_address_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
+      #
+      #   @param lockbox_recipient_id [String] Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
       #
       #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
 

data/lib/increase/models/lockbox_address.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxAddresses#create
+    class LockboxAddress < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Lockbox Address identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute address
+      #   The mailing address for the Lockbox Address. It will be present after Increase
+      #   generates it.
+      #
+      #   @return [Increase::Models::LockboxAddress::Address, nil]
+      required :address, -> { Increase::LockboxAddress::Address }, nil?: true
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      #   Address was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description you choose for the Lockbox Address.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute idempotency_key
+      #   The idempotency key you chose for this object. This value is unique across
+      #   Increase and is used to ensure that a request is only processed once. Learn more
+      #   about [idempotency](https://increase.com/documentation/idempotency-keys).
+      #
+      #   @return [String, nil]
+      required :idempotency_key, String, nil?: true
+
+      # @!attribute status
+      #   The status of the Lockbox Address.
+      #
+      #   @return [Symbol, Increase::Models::LockboxAddress::Status]
+      required :status, enum: -> { Increase::LockboxAddress::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `lockbox_address`.
+      #
+      #   @return [Symbol, Increase::Models::LockboxAddress::Type]
+      required :type, enum: -> { Increase::LockboxAddress::Type }
+
+      # @!method initialize(id:, address:, created_at:, description:, idempotency_key:, status:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::LockboxAddress} for more details.
+      #
+      #   Lockbox Addresses are physical locations that can receive mail containing paper
+      #   checks.
+      #
+      #   @param id [String] The Lockbox Address identifier.
+      #
+      #   @param address [Increase::Models::LockboxAddress::Address, nil] The mailing address for the Lockbox Address. It will be present after Increase g
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      #
+      #   @param description [String, nil] The description you choose for the Lockbox Address.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param status [Symbol, Increase::Models::LockboxAddress::Status] The status of the Lockbox Address.
+      #
+      #   @param type [Symbol, Increase::Models::LockboxAddress::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::LockboxAddress#address
+      class Address < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute line1
+        #   The first line of the address.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of the address.
+        #
+        #   @return [String]
+        required :line2, String
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute state
+        #   The two-letter United States Postal Service (USPS) abbreviation for the state of
+        #   the address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!method initialize(city:, line1:, line2:, postal_code:, state:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::LockboxAddress::Address} for more details.
+        #
+        #   The mailing address for the Lockbox Address. It will be present after Increase
+        #   generates it.
+        #
+        #   @param city [String] The city of the address.
+        #
+        #   @param line1 [String] The first line of the address.
+        #
+        #   @param line2 [String] The second line of the address.
+        #
+        #   @param postal_code [String] The postal code of the address.
+        #
+        #   @param state [String] The two-letter United States Postal Service (USPS) abbreviation for the state of
+      end
+
+      # The status of the Lockbox Address.
+      #
+      # @see Increase::Models::LockboxAddress#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # Increase is generating this Lockbox Address.
+        PENDING = :pending
+
+        # This Lockbox Address is active.
+        ACTIVE = :active
+
+        # This Lockbox Address is disabled.
+        DISABLED = :disabled
+
+        # This Lockbox Address is permanently disabled.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_address`.
+      #
+      # @see Increase::Models::LockboxAddress#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        LOCKBOX_ADDRESS = :lockbox_address
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/lockbox_address_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxAddresses#create
+    class LockboxAddressCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute description
+      #   The description you choose for the Lockbox Address.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!method initialize(description: nil, request_options: {})
+      #   @param description [String] The description you choose for the Lockbox Address.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/{lockbox_list_params.rb → lockbox_address_list_params.rb}

@@ -2,21 +2,15 @@
 
 module Increase
   module Models
-    # @see Increase::Resources::Lockboxes#list
-    class LockboxListParams < Increase::Internal::Type::BaseModel
+    # @see Increase::Resources::LockboxAddresses#list
+    class LockboxAddressListParams < Increase::Internal::Type::BaseModel
       extend Increase::Internal::Type::RequestParameters::Converter
       include Increase::Internal::Type::RequestParameters
 
-      # @!attribute account_id
-      #   Filter Lockboxes to those associated with the provided Account.
-      #
-      #   @return [String, nil]
-      optional :account_id, String
-
       # @!attribute created_at
       #
-      #   @return [Increase::Models::LockboxListParams::CreatedAt, nil]
-      optional :created_at, -> { Increase::LockboxListParams::CreatedAt }
+      #   @return [Increase::Models::LockboxAddressListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::LockboxAddressListParams::CreatedAt }
 
       # @!attribute cursor
       #   Return the page of entries after this one.
@@ -40,13 +34,11 @@ module Increase
       #   @return [Integer, nil]
       optional :limit, Integer
 
-      # @!method initialize(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
+      # @!method initialize(created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
-      #   {Increase::Models::LockboxListParams} for more details.
-      #
-      #   @param account_id [String] Filter Lockboxes to those associated with the provided Account.
+      #   {Increase::Models::LockboxAddressListParams} for more details.
       #
-      #   @param created_at [Increase::Models::LockboxListParams::CreatedAt]
+      #   @param created_at [Increase::Models::LockboxAddressListParams::CreatedAt]
       #
       #   @param cursor [String] Return the page of entries after this one.
       #
@@ -87,7 +79,7 @@ module Increase
 
         # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
         #   Some parameter documentations has been truncated, see
-        #   {Increase::Models::LockboxListParams::CreatedAt} for more details.
+        #   {Increase::Models::LockboxAddressListParams::CreatedAt} for more details.
         #
         #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
         #

data/lib/increase/models/lockbox_address_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxAddresses#retrieve
+    class LockboxAddressRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute lockbox_address_id
+      #   The identifier of the Lockbox Address to retrieve.
+      #
+      #   @return [String]
+      required :lockbox_address_id, String
+
+      # @!method initialize(lockbox_address_id:, request_options: {})
+      #   @param lockbox_address_id [String] The identifier of the Lockbox Address to retrieve.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/lockbox_address_update_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::LockboxAddresses#update
+    class LockboxAddressUpdateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute lockbox_address_id
+      #   The identifier of the Lockbox Address.
+      #
+      #   @return [String]
+      required :lockbox_address_id, String
+
+      # @!attribute description
+      #   The description you choose for the Lockbox Address.
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute status
+      #   The status of the Lockbox Address.
+      #
+      #   @return [Symbol, Increase::Models::LockboxAddressUpdateParams::Status, nil]
+      optional :status, enum: -> { Increase::LockboxAddressUpdateParams::Status }
+
+      # @!method initialize(lockbox_address_id:, description: nil, status: nil, request_options: {})
+      #   @param lockbox_address_id [String] The identifier of the Lockbox Address.
+      #
+      #   @param description [String] The description you choose for the Lockbox Address.
+      #
+      #   @param status [Symbol, Increase::Models::LockboxAddressUpdateParams::Status] The status of the Lockbox Address.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The status of the Lockbox Address.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # This Lockbox Address is active.
+        ACTIVE = :active
+
+        # This Lockbox Address is disabled.
+        DISABLED = :disabled
+
+        # This Lockbox Address is permanently disabled.
+        CANCELED = :canceled
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end