increase 1.339.0 → 1.341.0

data/lib/increase/resources/swift_transfers.rb

@@ -3,9 +3,6 @@
 module Increase
   module Resources
     class SwiftTransfers
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::SwiftTransferCreateParams} for more details.
-      #
       # Create a Swift Transfer
       #
       # @overload create(account_id:, account_number:, bank_identification_code:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, instructed_amount:, instructed_currency:, source_account_number_id:, unstructured_remittance_information:, require_approval: nil, routing_number: nil, request_options: {})
@@ -14,9 +11,13 @@ module Increase
       #
       # @param account_number [String] The creditor's account number.
       #
-      # @param bank_identification_code [String] The bank identification code (BIC) of the creditor. If it ends with the three-ch
+      # @param bank_identification_code [String]
+      #   The bank identification code (BIC) of the creditor. If it ends with the
+      #   three-character branch code, this must be 11 characters long. Otherwise this
+      #   must be 8 characters and the branch code will be assumed to be `XXX`.
       #
-      # @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress] The creditor's address.
+      # @param creditor_address [Increase::Models::SwiftTransferCreateParams::CreditorAddress]
+      #   The creditor's address.
       #
       # @param creditor_name [String] The creditor's name.
       #
@@ -24,17 +25,25 @@ module Increase
       #
       # @param debtor_name [String] The debtor's name.
       #
-      # @param instructed_amount [Integer] The amount, in minor units of `instructed_currency`, to send to the creditor.
+      # @param instructed_amount [Integer]
+      #   The amount, in minor units of `instructed_currency`, to send to the creditor.
       #
-      # @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency] The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the inst
+      # @param instructed_currency [Symbol, Increase::Models::SwiftTransferCreateParams::InstructedCurrency]
+      #   The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the
+      #   instructed amount.
       #
-      # @param source_account_number_id [String] The Account Number to include in the transfer as the debtor's account number.
+      # @param source_account_number_id [String]
+      #   The Account Number to include in the transfer as the debtor's account number.
       #
-      # @param unstructured_remittance_information [String] Unstructured remittance information to include in the transfer.
+      # @param unstructured_remittance_information [String]
+      #   Unstructured remittance information to include in the transfer.
       #
-      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      # @param require_approval [Boolean]
+      #   Whether the transfer requires explicit approval via the dashboard or API.
       #
-      # @param routing_number [String] The creditor's bank account routing or transit number. Required in certain count
+      # @param routing_number [String]
+      #   The creditor's bank account routing or transit number. Required in certain
+      #   countries.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -72,9 +81,6 @@ module Increase
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::SwiftTransferListParams} for more details.
-      #
       # List Swift Transfers
       #
       # @overload list(account_id: nil, created_at: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -85,9 +91,15 @@ module Increase
       #
       # @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 idempotency_key [String]
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that 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).
       #
-      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      # @param limit [Integer]
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
       #
       # @param status [Increase::Models::SwiftTransferListParams::Status]
       #

data/lib/increase/resources/transactions.rb

@@ -23,9 +23,6 @@ module Increase
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::TransactionListParams} for more details.
-      #
       # List Transactions
       #
       # @overload list(account_id: nil, category: nil, created_at: nil, cursor: nil, limit: nil, route_id: nil, request_options: {})
@@ -38,9 +35,13 @@ module Increase
       #
       # @param cursor [String] Return the page of entries after this one.
       #
-      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      # @param limit [Integer]
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
       #
-      # @param route_id [String] Filter Transactions for those belonging to the specified route. This could be a
+      # @param route_id [String]
+      #   Filter Transactions for those belonging to the specified route. This could be a
+      #   Card ID or an Account Number ID.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/increase/resources/wire_drawdown_requests.rb

@@ -3,9 +3,6 @@
 module Increase
   module Resources
     class WireDrawdownRequests
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::WireDrawdownRequestCreateParams} for more details.
-      #
       # Create a Wire Drawdown Request
       #
       # @overload create(account_number_id:, amount:, creditor_address:, creditor_name:, debtor_address:, debtor_name:, unstructured_remittance_information:, charge_bearer: nil, debtor_account_number: nil, debtor_external_account_id: nil, debtor_routing_number: nil, end_to_end_identification: nil, request_options: {})
@@ -14,25 +11,34 @@ module Increase
       #
       # @param amount [Integer] The amount requested from the debtor, in USD cents.
       #
-      # @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress] The creditor's address.
+      # @param creditor_address [Increase::Models::WireDrawdownRequestCreateParams::CreditorAddress]
+      #   The creditor's address.
       #
       # @param creditor_name [String] The creditor's name.
       #
-      # @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress] The debtor's address.
+      # @param debtor_address [Increase::Models::WireDrawdownRequestCreateParams::DebtorAddress]
+      #   The debtor's address.
       #
       # @param debtor_name [String] The debtor's name.
       #
-      # @param unstructured_remittance_information [String] Remittance information the debtor will see as part of the request.
+      # @param unstructured_remittance_information [String]
+      #   Remittance information the debtor will see as part of the request.
       #
-      # @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer] Determines who bears the cost of the drawdown request. Defaults to `shared` if n
+      # @param charge_bearer [Symbol, Increase::Models::WireDrawdownRequestCreateParams::ChargeBearer]
+      #   Determines who bears the cost of the drawdown request. Defaults to `shared` if
+      #   not specified.
       #
       # @param debtor_account_number [String] The debtor's account number.
       #
-      # @param debtor_external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
+      # @param debtor_external_account_id [String]
+      #   The ID of an External Account to initiate a transfer to. If this parameter is
+      #   provided, `debtor_account_number` and `debtor_routing_number` must be absent.
       #
       # @param debtor_routing_number [String] The debtor's routing number.
       #
-      # @param end_to_end_identification [String] A free-form reference string set by the sender mirrored back in the subsequent w
+      # @param end_to_end_identification [String]
+      #   A free-form reference string set by the sender mirrored back in the subsequent
+      #   wire transfer.
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -70,18 +76,21 @@ module Increase
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::WireDrawdownRequestListParams} for more details.
-      #
       # List Wire Drawdown Requests
       #
       # @overload list(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
       #
       # @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 idempotency_key [String]
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that 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).
       #
-      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      # @param limit [Integer]
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
       #
       # @param status [Increase::Models::WireDrawdownRequestListParams::Status]
       #

data/lib/increase/resources/wire_transfers.rb

@@ -3,9 +3,6 @@
 module Increase
   module Resources
     class WireTransfers
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::WireTransferCreateParams} for more details.
-      #
       # Create a Wire Transfer
       #
       # @overload create(account_id:, amount:, creditor:, remittance:, account_number: nil, debtor: nil, external_account_id: nil, inbound_wire_drawdown_request_id: nil, require_approval: nil, routing_number: nil, source_account_number_id: nil, request_options: {})
@@ -14,23 +11,36 @@ module Increase
       #
       # @param amount [Integer] The transfer amount in USD cents.
       #
-      # @param creditor [Increase::Models::WireTransferCreateParams::Creditor] The person or business that is receiving the funds from the transfer.
+      # @param creditor [Increase::Models::WireTransferCreateParams::Creditor]
+      #   The person or business that is receiving the funds from the transfer.
       #
-      # @param remittance [Increase::Models::WireTransferCreateParams::Remittance] Additional remittance information related to the wire transfer.
+      # @param remittance [Increase::Models::WireTransferCreateParams::Remittance]
+      #   Additional remittance information related to the wire transfer.
       #
       # @param account_number [String] The account number for the destination account.
       #
-      # @param debtor [Increase::Models::WireTransferCreateParams::Debtor] The person or business whose funds are being transferred. This is only necessary
+      # @param debtor [Increase::Models::WireTransferCreateParams::Debtor]
+      #   The person or business whose funds are being transferred. This is only necessary
+      #   if you're transferring from a commingled account. Otherwise, we'll use the
+      #   associated entity's details.
       #
-      # @param external_account_id [String] The ID of an External Account to initiate a transfer to. If this parameter is pr
+      # @param external_account_id [String]
+      #   The ID of an External Account to initiate a transfer to. If this parameter is
+      #   provided, `account_number` and `routing_number` must be absent.
       #
-      # @param inbound_wire_drawdown_request_id [String] The ID of an Inbound Wire Drawdown Request in response to which this transfer is
+      # @param inbound_wire_drawdown_request_id [String]
+      #   The ID of an Inbound Wire Drawdown Request in response to which this transfer is
+      #   being sent.
       #
-      # @param require_approval [Boolean] Whether the transfer requires explicit approval via the dashboard or API.
+      # @param require_approval [Boolean]
+      #   Whether the transfer requires explicit approval via the dashboard or API.
       #
-      # @param routing_number [String] The American Bankers' Association (ABA) Routing Transit Number (RTN) for the des
+      # @param routing_number [String]
+      #   The American Bankers' Association (ABA) Routing Transit Number (RTN) for the
+      #   destination account.
       #
-      # @param source_account_number_id [String] The ID of an Account Number that will be passed to the wire's recipient
+      # @param source_account_number_id [String]
+      #   The ID of an Account Number that will be passed to the wire's recipient
       #
       # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -68,9 +78,6 @@ module Increase
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Increase::Models::WireTransferListParams} for more details.
-      #
       # List Wire Transfers
       #
       # @overload list(account_id: nil, created_at: nil, cursor: nil, external_account_id: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
@@ -83,9 +90,15 @@ module Increase
       #
       # @param external_account_id [String] Filter Wire Transfers to those made to the specified External Account.
       #
-      # @param idempotency_key [String] Filter records to the one with the specified `idempotency_key` you chose for tha
+      # @param idempotency_key [String]
+      #   Filter records to the one with the specified `idempotency_key` you chose for
+      #   that 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).
       #
-      # @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      # @param limit [Integer]
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
       #
       # @param status [Increase::Models::WireTransferListParams::Status]
       #

data/lib/increase/version.rb

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

data/rbi/increase/models/beneficial_owner_create_params.rbi

@@ -14,7 +14,8 @@ module Increase
           )
         end
 
-      # The identifier of the Entity to associate with the new Beneficial Owner.
+      # The identifier of the Entity to associate with the new Beneficial Owner. Only
+      # `corporation` entities have beneficial owners.
       sig { returns(String) }
       attr_accessor :entity_id
 
@@ -57,7 +58,8 @@ module Increase
         ).returns(T.attached_class)
       end
       def self.new(
-        # The identifier of the Entity to associate with the new Beneficial Owner.
+        # The identifier of the Entity to associate with the new Beneficial Owner. Only
+        # `corporation` entities have beneficial owners.
         entity_id:,
         # Personal details for the beneficial owner.
         individual:,

data/rbi/increase/models/check_transfer.rbi

@@ -813,6 +813,10 @@ module Increase
         end
         attr_writer :return_address
 
+        # A custom name printed above the Increase-managed return address.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :return_address_name
+
         # The shipping method for the check.
         sig do
           returns(
@@ -857,6 +861,7 @@ module Increase
               T.nilable(
                 Increase::CheckTransfer::PhysicalCheck::ReturnAddress::OrHash
               ),
+            return_address_name: T.nilable(String),
             shipping_method:
               Increase::CheckTransfer::PhysicalCheck::ShippingMethod::OrSymbol,
             signature:
@@ -885,6 +890,8 @@ module Increase
           recipient_name:,
           # The return address to be printed on the check.
           return_address:,
+          # A custom name printed above the Increase-managed return address.
+          return_address_name:,
           # The shipping method for the check.
           shipping_method:,
           # The signature that will appear on the check.
@@ -909,6 +916,7 @@ module Increase
                 T.nilable(
                   Increase::CheckTransfer::PhysicalCheck::ReturnAddress
                 ),
+              return_address_name: T.nilable(String),
               shipping_method:
                 Increase::CheckTransfer::PhysicalCheck::ShippingMethod::TaggedSymbol,
               signature: Increase::CheckTransfer::PhysicalCheck::Signature,
@@ -1356,6 +1364,13 @@ module Increase
             Increase::CheckTransfer::Status::TaggedSymbol
           )
 
+        # The transfer is pending review by Increase.
+        PENDING_REVIEWING =
+          T.let(
+            :pending_reviewing,
+            Increase::CheckTransfer::Status::TaggedSymbol
+          )
+
         # The transfer requires attention from an Increase operator.
         REQUIRES_ATTENTION =
           T.let(

data/rbi/increase/models/check_transfer_create_params.rbi

@@ -288,6 +288,16 @@ module Increase
         sig { returns(String) }
         attr_accessor :memo
 
+        # The payer of the check. This will be printed on the top-left portion of the
+        # check. This should be an array of up to 4 elements, each of which represents a
+        # line of the payer.
+        sig do
+          returns(
+            T::Array[Increase::CheckTransferCreateParams::PhysicalCheck::Payer]
+          )
+        end
+        attr_accessor :payer
+
         # The name that will be printed on the check in the 'To:' field.
         sig { returns(String) }
         attr_accessor :recipient_name
@@ -317,30 +327,6 @@ module Increase
         sig { params(note: String).void }
         attr_writer :note
 
-        # The payer of the check. This will be printed on the top-left portion of the
-        # check and defaults to the return address if unspecified. This should be an array
-        # of up to 4 elements, each of which represents a line of the payer.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[
-                Increase::CheckTransferCreateParams::PhysicalCheck::Payer
-              ]
-            )
-          )
-        end
-        attr_reader :payer
-
-        sig do
-          params(
-            payer:
-              T::Array[
-                Increase::CheckTransferCreateParams::PhysicalCheck::Payer::OrHash
-              ]
-          ).void
-        end
-        attr_writer :payer
-
         # The return address to be printed on the check. If omitted this will default to
         # an Increase-owned address that will mark checks as delivery failed and shred
         # them.
@@ -361,6 +347,14 @@ module Increase
         end
         attr_writer :return_address
 
+        # A custom name to print above the default return address. Cannot be provided
+        # together with `return_address`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :return_address_name
+
+        sig { params(return_address_name: String).void }
+        attr_writer :return_address_name
+
         # How to ship the check. For details on pricing, timing, and restrictions, see
         # https://increase.com/documentation/originating-checks#printing-checks .
         sig do
@@ -408,16 +402,17 @@ module Increase
             mailing_address:
               Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress::OrHash,
             memo: String,
-            recipient_name: String,
-            attachment_file_id: String,
-            check_voucher_image_file_id: String,
-            note: String,
             payer:
               T::Array[
                 Increase::CheckTransferCreateParams::PhysicalCheck::Payer::OrHash
               ],
+            recipient_name: String,
+            attachment_file_id: String,
+            check_voucher_image_file_id: String,
+            note: String,
             return_address:
               Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress::OrHash,
+            return_address_name: String,
             shipping_method:
               Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod::OrSymbol,
             signature:
@@ -429,6 +424,10 @@ module Increase
           mailing_address:,
           # The descriptor that will be printed on the memo field on the check.
           memo:,
+          # The payer of the check. This will be printed on the top-left portion of the
+          # check. This should be an array of up to 4 elements, each of which represents a
+          # line of the payer.
+          payer:,
           # The name that will be printed on the check in the 'To:' field.
           recipient_name:,
           # The ID of a File to be attached to the check. This must have
@@ -441,14 +440,13 @@ module Increase
           check_voucher_image_file_id: nil,
           # The descriptor that will be printed on the letter included with the check.
           note: nil,
-          # The payer of the check. This will be printed on the top-left portion of the
-          # check and defaults to the return address if unspecified. This should be an array
-          # of up to 4 elements, each of which represents a line of the payer.
-          payer: nil,
           # The return address to be printed on the check. If omitted this will default to
           # an Increase-owned address that will mark checks as delivery failed and shred
           # them.
           return_address: nil,
+          # A custom name to print above the default return address. Cannot be provided
+          # together with `return_address`.
+          return_address_name: nil,
           # How to ship the check. For details on pricing, timing, and restrictions, see
           # https://increase.com/documentation/originating-checks#printing-checks .
           shipping_method: nil,
@@ -465,16 +463,17 @@ module Increase
               mailing_address:
                 Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress,
               memo: String,
-              recipient_name: String,
-              attachment_file_id: String,
-              check_voucher_image_file_id: String,
-              note: String,
               payer:
                 T::Array[
                   Increase::CheckTransferCreateParams::PhysicalCheck::Payer
                 ],
+              recipient_name: String,
+              attachment_file_id: String,
+              check_voucher_image_file_id: String,
+              note: String,
               return_address:
                 Increase::CheckTransferCreateParams::PhysicalCheck::ReturnAddress,
+              return_address_name: String,
               shipping_method:
                 Increase::CheckTransferCreateParams::PhysicalCheck::ShippingMethod::OrSymbol,
               signature:

data/rbi/increase/models/check_transfer_list_params.rbi

@@ -267,6 +267,13 @@ module Increase
               Increase::CheckTransferListParams::Status::In::TaggedSymbol
             )
 
+          # The transfer is pending review by Increase.
+          PENDING_REVIEWING =
+            T.let(
+              :pending_reviewing,
+              Increase::CheckTransferListParams::Status::In::TaggedSymbol
+            )
+
           # The transfer requires attention from an Increase operator.
           REQUIRES_ATTENTION =
             T.let(

data/rbi/increase/models/entity.rbi

@@ -147,7 +147,7 @@ module Increase
       attr_writer :validation
 
       # Entities are the legal entities that own accounts. They can be people,
-      # corporations, partnerships, government authorities, or trusts. To learn more,
+      # corporations, joint accounts, trusts, or government authorities. To learn more,
       # see [Entities](/documentation/entities).
       sig do
         params(
@@ -311,7 +311,8 @@ module Increase
         sig { returns(T.nilable(String)) }
         attr_accessor :industry_code
 
-        # The legal identifier of the corporation.
+        # The legal identifier of the corporation, like an Employer Identification Number
+        # (EIN).
         sig do
           returns(T.nilable(Increase::Entity::Corporation::LegalIdentifier))
         end
@@ -370,7 +371,8 @@ module Increase
           # The numeric North American Industry Classification System (NAICS) code submitted
           # for the corporation.
           industry_code:,
-          # The legal identifier of the corporation.
+          # The legal identifier of the corporation, like an Employer Identification Number
+          # (EIN).
           legal_identifier:,
           # The legal name of the corporation.
           name:,
@@ -955,11 +957,12 @@ module Increase
           end
           attr_accessor :category
 
-          # The identifier of the legal identifier.
+          # The legal identifier itself.
           sig { returns(String) }
           attr_accessor :value
 
-          # The legal identifier of the corporation.
+          # The legal identifier of the corporation, like an Employer Identification Number
+          # (EIN).
           sig do
             params(
               category:
@@ -970,7 +973,7 @@ module Increase
           def self.new(
             # The category of the legal identifier.
             category:,
-            # The identifier of the legal identifier.
+            # The legal identifier itself.
             value:
           )
           end

data/rbi/increase/models/entity_create_params.rbi

@@ -1266,8 +1266,9 @@ module Increase
               )
             end
 
-          # The legal identifier. For US Employer Identification Numbers, submit nine digits
-          # with no dashes or other separators. When testing in sandbox, use one of our
+          # The legal identifier itself. For US Employer Identification Numbers, submit nine
+          # digits with no dashes or other separators. When testing in sandbox, use one of
+          # our
           # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
           sig { returns(String) }
           attr_accessor :value
@@ -1302,8 +1303,9 @@ module Increase
             ).returns(T.attached_class)
           end
           def self.new(
-            # The legal identifier. For US Employer Identification Numbers, submit nine digits
-            # with no dashes or other separators. When testing in sandbox, use one of our
+            # The legal identifier itself. For US Employer Identification Numbers, submit nine
+            # digits with no dashes or other separators. When testing in sandbox, use one of
+            # our
             # [sandbox test values](https://increase.com/documentation/sandbox-test-values).
             value:,
             # The category of the legal identifier. If not provided, the default is