increase 1.304.0 → 1.306.0

data/lib/increase/resources/lockbox_recipients.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class LockboxRecipients
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::LockboxRecipientCreateParams} for more details.
+      #
+      # Create a Lockbox Recipient
+      #
+      # @overload create(account_id:, lockbox_address_id:, description: nil, recipient_name: nil, request_options: {})
+      #
+      # @param account_id [String] The Account that checks sent to this Lockbox Recipient should be deposited into.
+      #
+      # @param lockbox_address_id [String] The Lockbox Address where this Lockbox Recipient may receive mail.
+      #
+      # @param description [String] The description you choose for the Lockbox Recipient.
+      #
+      # @param recipient_name [String] The name of the Lockbox Recipient
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::LockboxRecipient]
+      #
+      # @see Increase::Models::LockboxRecipientCreateParams
+      def create(params)
+        parsed, options = Increase::LockboxRecipientCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "lockbox_recipients",
+          body: parsed,
+          model: Increase::LockboxRecipient,
+          options: options
+        )
+      end
+
+      # Retrieve a Lockbox Recipient
+      #
+      # @overload retrieve(lockbox_recipient_id, request_options: {})
+      #
+      # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to retrieve.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::LockboxRecipient]
+      #
+      # @see Increase::Models::LockboxRecipientRetrieveParams
+      def retrieve(lockbox_recipient_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["lockbox_recipients/%1$s", lockbox_recipient_id],
+          model: Increase::LockboxRecipient,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a Lockbox Recipient
+      #
+      # @overload update(lockbox_recipient_id, description: nil, recipient_name: nil, status: nil, request_options: {})
+      #
+      # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient.
+      #
+      # @param description [String] The description you choose for the Lockbox Recipient.
+      #
+      # @param recipient_name [String] The name of the Lockbox Recipient.
+      #
+      # @param status [Symbol, Increase::Models::LockboxRecipientUpdateParams::Status] The status of the Lockbox Recipient.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::LockboxRecipient]
+      #
+      # @see Increase::Models::LockboxRecipientUpdateParams
+      def update(lockbox_recipient_id, params = {})
+        parsed, options = Increase::LockboxRecipientUpdateParams.dump_request(params)
+        @client.request(
+          method: :patch,
+          path: ["lockbox_recipients/%1$s", lockbox_recipient_id],
+          body: parsed,
+          model: Increase::LockboxRecipient,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Increase::Models::LockboxRecipientListParams} for more details.
+      #
+      # List Lockbox Recipients
+      #
+      # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, lockbox_address_id: nil, request_options: {})
+      #
+      # @param account_id [String] Filter Lockbox Recipients to those associated with the provided Account.
+      #
+      # @param created_at [Increase::Models::LockboxRecipientListParams::CreatedAt]
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      #
+      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      # @param lockbox_address_id [String] Filter Lockbox Recipients to those associated with the provided Lockbox Address.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::LockboxRecipient>]
+      #
+      # @see Increase::Models::LockboxRecipientListParams
+      def list(params = {})
+        parsed, options = Increase::LockboxRecipientListParams.dump_request(params)
+        query = Increase::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "lockbox_recipients",
+          query: query,
+          page: Increase::Internal::Page,
+          model: Increase::LockboxRecipient,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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

@@ -10,14 +10,16 @@ module Increase
         # Simulates an inbound mail item to your account, as if someone had mailed a
         # physical check to one of your account's Lockboxes.
         #
-        # @overload create(amount:, lockbox_id:, contents_file_id: nil, request_options: {})
+        # @overload create(amount:, contents_file_id: nil, lockbox_address_id: nil, lockbox_recipient_id: nil, request_options: {})
         #
         # @param amount [Integer] The amount of the check to be simulated, in cents.
         #
-        # @param lockbox_id [String] The identifier of the Lockbox to simulate inbound mail to.
-        #
         # @param contents_file_id [String] The file containing the PDF contents. If not present, a default check image file
         #
+        # @param lockbox_address_id [String] The identifier of the Lockbox Address to simulate inbound mail to.
+        #
+        # @param lockbox_recipient_id [String] The identifier of the Lockbox Recipient to simulate inbound mail to.
+        #
         # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Increase::Models::InboundMailItem]

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -236,11 +236,16 @@ require_relative "increase/models/intrafi_exclusion_archive_params"
 require_relative "increase/models/intrafi_exclusion_create_params"
 require_relative "increase/models/intrafi_exclusion_list_params"
 require_relative "increase/models/intrafi_exclusion_retrieve_params"
-require_relative "increase/models/lockbox"
-require_relative "increase/models/lockbox_create_params"
-require_relative "increase/models/lockbox_list_params"
-require_relative "increase/models/lockbox_retrieve_params"
-require_relative "increase/models/lockbox_update_params"
+require_relative "increase/models/lockbox_address"
+require_relative "increase/models/lockbox_address_create_params"
+require_relative "increase/models/lockbox_address_list_params"
+require_relative "increase/models/lockbox_address_retrieve_params"
+require_relative "increase/models/lockbox_address_update_params"
+require_relative "increase/models/lockbox_recipient"
+require_relative "increase/models/lockbox_recipient_create_params"
+require_relative "increase/models/lockbox_recipient_list_params"
+require_relative "increase/models/lockbox_recipient_retrieve_params"
+require_relative "increase/models/lockbox_recipient_update_params"
 require_relative "increase/models/oauth_application"
 require_relative "increase/models/oauth_application_list_params"
 require_relative "increase/models/oauth_application_retrieve_params"
@@ -389,7 +394,8 @@ require_relative "increase/resources/inbound_wire_transfers"
 require_relative "increase/resources/intrafi_account_enrollments"
 require_relative "increase/resources/intrafi_balances"
 require_relative "increase/resources/intrafi_exclusions"
-require_relative "increase/resources/lockboxes"
+require_relative "increase/resources/lockbox_addresses"
+require_relative "increase/resources/lockbox_recipients"
 require_relative "increase/resources/oauth_applications"
 require_relative "increase/resources/oauth_connections"
 require_relative "increase/resources/oauth_tokens"

data/rbi/increase/client.rbi

@@ -112,8 +112,11 @@ module Increase
     sig { returns(Increase::Resources::CheckDeposits) }
     attr_reader :check_deposits
 
-    sig { returns(Increase::Resources::Lockboxes) }
-    attr_reader :lockboxes
+    sig { returns(Increase::Resources::LockboxAddresses) }
+    attr_reader :lockbox_addresses
+
+    sig { returns(Increase::Resources::LockboxRecipients) }
+    attr_reader :lockbox_recipients
 
     sig { returns(Increase::Resources::InboundMailItems) }
     attr_reader :inbound_mail_items

data/rbi/increase/models/card_push_transfer.rbi

@@ -2638,6 +2638,9 @@ module Increase
         MASTERCARD =
           T.let(:mastercard, Increase::CardPushTransfer::Route::TaggedSymbol)
 
+        # Pulse
+        PULSE = T.let(:pulse, Increase::CardPushTransfer::Route::TaggedSymbol)
+
         sig do
           override.returns(
             T::Array[Increase::CardPushTransfer::Route::TaggedSymbol]

data/rbi/increase/models/card_token_capabilities.rbi

@@ -218,6 +218,13 @@ module Increase
               Increase::CardTokenCapabilities::Route::Route::TaggedSymbol
             )
 
+          # Pulse
+          PULSE =
+            T.let(
+              :pulse,
+              Increase::CardTokenCapabilities::Route::Route::TaggedSymbol
+            )
+
           sig do
             override.returns(
               T::Array[

data/rbi/increase/models/card_validation.rbi

@@ -1482,6 +1482,9 @@ module Increase
         MASTERCARD =
           T.let(:mastercard, Increase::CardValidation::Route::TaggedSymbol)
 
+        # Pulse
+        PULSE = T.let(:pulse, Increase::CardValidation::Route::TaggedSymbol)
+
         sig do
           override.returns(
             T::Array[Increase::CardValidation::Route::TaggedSymbol]

data/rbi/increase/models/check_deposit.rbi

@@ -118,10 +118,11 @@ module Increase
       sig { returns(T.nilable(String)) }
       attr_accessor :inbound_mail_item_id
 
-      # If the Check Deposit was the result of an Inbound Mail Item, this will contain
-      # the identifier of the Lockbox that received it.
+      # 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.
       sig { returns(T.nilable(String)) }
-      attr_accessor :lockbox_id
+      attr_accessor :lockbox_recipient_id
 
       # The status of the Check Deposit.
       sig { returns(Increase::CheckDeposit::Status::TaggedSymbol) }
@@ -160,7 +161,7 @@ module Increase
           inbound_funds_hold:
             T.nilable(Increase::CheckDeposit::InboundFundsHold::OrHash),
           inbound_mail_item_id: T.nilable(String),
-          lockbox_id: T.nilable(String),
+          lockbox_recipient_id: T.nilable(String),
           status: Increase::CheckDeposit::Status::OrSymbol,
           transaction_id: T.nilable(String),
           type: Increase::CheckDeposit::Type::OrSymbol
@@ -207,9 +208,10 @@ module Increase
         # If the Check Deposit was the result of an Inbound Mail Item, this will contain
         # the identifier of the Inbound Mail Item.
         inbound_mail_item_id:,
-        # If the Check Deposit was the result of an Inbound Mail Item, this will contain
-        # the identifier of the Lockbox that received it.
-        lockbox_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.
+        lockbox_recipient_id:,
         # The status of the Check Deposit.
         status:,
         # The ID for the Transaction created by the deposit.
@@ -243,7 +245,7 @@ module Increase
             inbound_funds_hold:
               T.nilable(Increase::CheckDeposit::InboundFundsHold),
             inbound_mail_item_id: T.nilable(String),
-            lockbox_id: T.nilable(String),
+            lockbox_recipient_id: T.nilable(String),
             status: Increase::CheckDeposit::Status::TaggedSymbol,
             transaction_id: T.nilable(String),
             type: Increase::CheckDeposit::Type::TaggedSymbol

data/rbi/increase/models/inbound_mail_item.rbi

@@ -25,10 +25,14 @@ module Increase
       sig { returns(String) }
       attr_accessor :file_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.
+      # The identifier for the Lockbox Address that received this mail item.
       sig { returns(T.nilable(String)) }
-      attr_accessor :lockbox_id
+      attr_accessor :lockbox_address_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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :lockbox_recipient_id
 
       # The recipient name as written on the mail item.
       sig { returns(T.nilable(String)) }
@@ -51,14 +55,16 @@ module Increase
       sig { returns(Increase::InboundMailItem::Type::TaggedSymbol) }
       attr_accessor :type
 
-      # 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.
       sig do
         params(
           id: String,
           checks: T::Array[Increase::InboundMailItem::Check::OrHash],
           created_at: Time,
           file_id: String,
-          lockbox_id: T.nilable(String),
+          lockbox_address_id: T.nilable(String),
+          lockbox_recipient_id: T.nilable(String),
           recipient_name: T.nilable(String),
           rejection_reason:
             T.nilable(Increase::InboundMailItem::RejectionReason::OrSymbol),
@@ -76,9 +82,11 @@ module Increase
         created_at:,
         # The identifier for the File containing the scanned contents of the mail item.
         file_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.
-        lockbox_id:,
+        # The identifier for the Lockbox Address that received this mail item.
+        lockbox_address_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.
+        lockbox_recipient_id:,
         # The recipient name as written on the mail item.
         recipient_name:,
         # If the mail item has been rejected, why it was rejected.
@@ -98,7 +106,8 @@ module Increase
             checks: T::Array[Increase::InboundMailItem::Check],
             created_at: Time,
             file_id: String,
-            lockbox_id: T.nilable(String),
+            lockbox_address_id: T.nilable(String),
+            lockbox_recipient_id: T.nilable(String),
             recipient_name: T.nilable(String),
             rejection_reason:
               T.nilable(
@@ -256,6 +265,20 @@ module Increase
             Increase::InboundMailItem::RejectionReason::TaggedSymbol
           )
 
+        # The Lockbox Address is not active.
+        LOCKBOX_ADDRESS_NOT_ACTIVE =
+          T.let(
+            :lockbox_address_not_active,
+            Increase::InboundMailItem::RejectionReason::TaggedSymbol
+          )
+
+        # The Lockbox Recipient or its associated Account is not active.
+        LOCKBOX_RECIPIENT_NOT_ACTIVE =
+          T.let(
+            :lockbox_recipient_not_active,
+            Increase::InboundMailItem::RejectionReason::TaggedSymbol
+          )
+
         sig do
           override.returns(
             T::Array[Increase::InboundMailItem::RejectionReason::TaggedSymbol]

data/rbi/increase/models/inbound_mail_item_list_params.rbi

@@ -39,19 +39,27 @@ module Increase
       sig { params(limit: Integer).void }
       attr_writer :limit
 
-      # Filter Inbound Mail Items to ones sent to the provided Lockbox.
+      # Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
       sig { returns(T.nilable(String)) }
-      attr_reader :lockbox_id
+      attr_reader :lockbox_address_id
 
-      sig { params(lockbox_id: String).void }
-      attr_writer :lockbox_id
+      sig { params(lockbox_address_id: String).void }
+      attr_writer :lockbox_address_id
+
+      # Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
+      sig { returns(T.nilable(String)) }
+      attr_reader :lockbox_recipient_id
+
+      sig { params(lockbox_recipient_id: String).void }
+      attr_writer :lockbox_recipient_id
 
       sig do
         params(
           created_at: Increase::InboundMailItemListParams::CreatedAt::OrHash,
           cursor: String,
           limit: Integer,
-          lockbox_id: String,
+          lockbox_address_id: String,
+          lockbox_recipient_id: String,
           request_options: Increase::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -62,8 +70,10 @@ module Increase
         # Limit the size of the list that is returned. The default (and maximum) is 100
         # objects.
         limit: nil,
-        # Filter Inbound Mail Items to ones sent to the provided Lockbox.
-        lockbox_id: nil,
+        # Filter Inbound Mail Items to ones sent to the provided Lockbox Address.
+        lockbox_address_id: nil,
+        # Filter Inbound Mail Items to ones sent to the provided Lockbox Recipient.
+        lockbox_recipient_id: nil,
         request_options: {}
       )
       end
@@ -74,7 +84,8 @@ module Increase
             created_at: Increase::InboundMailItemListParams::CreatedAt,
             cursor: String,
             limit: Integer,
-            lockbox_id: String,
+            lockbox_address_id: String,
+            lockbox_recipient_id: String,
             request_options: Increase::RequestOptions
           }
         )

data/rbi/increase/models/lockbox_address.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module Increase
+  module Models
+    class LockboxAddress < Increase::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Increase::LockboxAddress, Increase::Internal::AnyHash)
+        end
+
+      # The Lockbox Address identifier.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The mailing address for the Lockbox Address. It will be present after Increase
+      # generates it.
+      sig { returns(T.nilable(Increase::LockboxAddress::Address)) }
+      attr_reader :address
+
+      sig do
+        params(
+          address: T.nilable(Increase::LockboxAddress::Address::OrHash)
+        ).void
+      end
+      attr_writer :address
+
+      # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+      # Address was created.
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # The description you choose for the Lockbox Address.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # 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).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :idempotency_key
+
+      # The status of the Lockbox Address.
+      sig { returns(Increase::LockboxAddress::Status::TaggedSymbol) }
+      attr_accessor :status
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_address`.
+      sig { returns(Increase::LockboxAddress::Type::TaggedSymbol) }
+      attr_accessor :type
+
+      # Lockbox Addresses are physical locations that can receive mail containing paper
+      # checks.
+      sig do
+        params(
+          id: String,
+          address: T.nilable(Increase::LockboxAddress::Address::OrHash),
+          created_at: Time,
+          description: T.nilable(String),
+          idempotency_key: T.nilable(String),
+          status: Increase::LockboxAddress::Status::OrSymbol,
+          type: Increase::LockboxAddress::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The Lockbox Address identifier.
+        id:,
+        # The mailing address for the Lockbox Address. It will be present after Increase
+        # generates it.
+        address:,
+        # The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Lockbox
+        # Address was created.
+        created_at:,
+        # The description you choose for the Lockbox Address.
+        description:,
+        # 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).
+        idempotency_key:,
+        # The status of the Lockbox Address.
+        status:,
+        # A constant representing the object's type. For this resource it will always be
+        # `lockbox_address`.
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            address: T.nilable(Increase::LockboxAddress::Address),
+            created_at: Time,
+            description: T.nilable(String),
+            idempotency_key: T.nilable(String),
+            status: Increase::LockboxAddress::Status::TaggedSymbol,
+            type: Increase::LockboxAddress::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Address < Increase::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Increase::LockboxAddress::Address,
+              Increase::Internal::AnyHash
+            )
+          end
+
+        # The city of the address.
+        sig { returns(String) }
+        attr_accessor :city
+
+        # The first line of the address.
+        sig { returns(String) }
+        attr_accessor :line1
+
+        # The second line of the address.
+        sig { returns(String) }
+        attr_accessor :line2
+
+        # The postal code of the address.
+        sig { returns(String) }
+        attr_accessor :postal_code
+
+        # The two-letter United States Postal Service (USPS) abbreviation for the state of
+        # the address.
+        sig { returns(String) }
+        attr_accessor :state
+
+        # The mailing address for the Lockbox Address. It will be present after Increase
+        # generates it.
+        sig do
+          params(
+            city: String,
+            line1: String,
+            line2: String,
+            postal_code: String,
+            state: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The city of the address.
+          city:,
+          # The first line of the address.
+          line1:,
+          # The second line of the address.
+          line2:,
+          # The postal code of the address.
+          postal_code:,
+          # The two-letter United States Postal Service (USPS) abbreviation for the state of
+          # the address.
+          state:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              city: String,
+              line1: String,
+              line2: String,
+              postal_code: String,
+              state: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The status of the Lockbox Address.
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::LockboxAddress::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        # Increase is generating this Lockbox Address.
+        PENDING =
+          T.let(:pending, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        # This Lockbox Address is active.
+        ACTIVE = T.let(:active, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        # This Lockbox Address is disabled.
+        DISABLED =
+          T.let(:disabled, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        # This Lockbox Address is permanently disabled.
+        CANCELED =
+          T.let(:canceled, Increase::LockboxAddress::Status::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::LockboxAddress::Status::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `lockbox_address`.
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Increase::LockboxAddress::Type) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        LOCKBOX_ADDRESS =
+          T.let(:lockbox_address, Increase::LockboxAddress::Type::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Increase::LockboxAddress::Type::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end