increase 1.123.0 → 1.124.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +8 -0
- data/README.md +1 -1
- data/lib/increase/models/check_transfer_create_params.rb +25 -1
- data/lib/increase/resources/check_transfers.rb +3 -1
- data/lib/increase/version.rb +1 -1
- data/rbi/increase/models/check_transfer_create_params.rbi +60 -0
- data/rbi/increase/resources/check_transfers.rbi +5 -0
- data/sig/increase/models/check_transfer_create_params.rbs +23 -0
- data/sig/increase/resources/check_transfers.rbs +1 -0
- metadata +1 -1
    
        checksums.yaml
    CHANGED
    
    | @@ -1,7 +1,7 @@ | |
| 1 1 | 
             
            ---
         | 
| 2 2 | 
             
            SHA256:
         | 
| 3 | 
            -
              metadata.gz:  | 
| 4 | 
            -
              data.tar.gz:  | 
| 3 | 
            +
              metadata.gz: 6315a93ae9dff308ad0da9c6bfb3e71528e2efce2d74ea4cf08fa7e72ac62499
         | 
| 4 | 
            +
              data.tar.gz: 5ae2291980caf35e12cf07fe469a3af5996dd8d5f0547b5c8282c5be6e018ce5
         | 
| 5 5 | 
             
            SHA512:
         | 
| 6 | 
            -
              metadata.gz:  | 
| 7 | 
            -
              data.tar.gz:  | 
| 6 | 
            +
              metadata.gz: 8243e5fb2507403e64cf8949fcc86699e27c8a227e1097d087364b917091e3d0ef6819eb9dab59367d170cba87117d6817d1f3d7c6b383720043374b8e9ae02c
         | 
| 7 | 
            +
              data.tar.gz: 0d7b0c1e14b82ed2a100eae59a99c8301208ebe39a3f5f36ef233fdec4619b73444a470ea6fab91b5a3ad09945899ffb8fdb2ac21f8c8f7041a9120f48297d2c
         | 
    
        data/CHANGELOG.md
    CHANGED
    
    | @@ -1,5 +1,13 @@ | |
| 1 1 | 
             
            # Changelog
         | 
| 2 2 |  | 
| 3 | 
            +
            ## 1.124.0 (2025-10-30)
         | 
| 4 | 
            +
             | 
| 5 | 
            +
            Full Changelog: [v1.123.0...v1.124.0](https://github.com/Increase/increase-ruby/compare/v1.123.0...v1.124.0)
         | 
| 6 | 
            +
             | 
| 7 | 
            +
            ### Features
         | 
| 8 | 
            +
             | 
| 9 | 
            +
            * **api:** api update ([47c2289](https://github.com/Increase/increase-ruby/commit/47c2289b57e327e94599112b37f716e6af2f5211))
         | 
| 10 | 
            +
             | 
| 3 11 | 
             
            ## 1.123.0 (2025-10-30)
         | 
| 4 12 |  | 
| 5 13 | 
             
            Full Changelog: [v1.122.0...v1.123.0](https://github.com/Increase/increase-ruby/compare/v1.122.0...v1.123.0)
         | 
    
        data/README.md
    CHANGED
    
    
| @@ -32,6 +32,13 @@ module Increase | |
| 32 32 | 
             
                  #   @return [String]
         | 
| 33 33 | 
             
                  required :source_account_number_id, String
         | 
| 34 34 |  | 
| 35 | 
            +
                  # @!attribute balance_check
         | 
| 36 | 
            +
                  #   How the account's available balance should be checked. Please contact
         | 
| 37 | 
            +
                  #   [support@increase.com](mailto:support@increase.com) to enable this parameter.
         | 
| 38 | 
            +
                  #
         | 
| 39 | 
            +
                  #   @return [Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck, nil]
         | 
| 40 | 
            +
                  optional :balance_check, enum: -> { Increase::CheckTransferCreateParams::BalanceCheck }
         | 
| 41 | 
            +
             | 
| 35 42 | 
             
                  # @!attribute check_number
         | 
| 36 43 | 
             
                  #   The check number Increase should use for the check. This should not contain
         | 
| 37 44 | 
             
                  #   leading zeroes and must be unique across the `source_account_number`. If this is
         | 
| @@ -62,7 +69,7 @@ module Increase | |
| 62 69 | 
             
                  #   @return [Increase::Models::CheckTransferCreateParams::ThirdParty, nil]
         | 
| 63 70 | 
             
                  optional :third_party, -> { Increase::CheckTransferCreateParams::ThirdParty }
         | 
| 64 71 |  | 
| 65 | 
            -
                  # @!method initialize(account_id:, amount:, fulfillment_method:, source_account_number_id:, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, request_options: {})
         | 
| 72 | 
            +
                  # @!method initialize(account_id:, amount:, fulfillment_method:, source_account_number_id:, balance_check: nil, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, request_options: {})
         | 
| 66 73 | 
             
                  #   Some parameter documentations has been truncated, see
         | 
| 67 74 | 
             
                  #   {Increase::Models::CheckTransferCreateParams} for more details.
         | 
| 68 75 | 
             
                  #
         | 
| @@ -74,6 +81,8 @@ module Increase | |
| 74 81 | 
             
                  #
         | 
| 75 82 | 
             
                  #   @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer and print o
         | 
| 76 83 | 
             
                  #
         | 
| 84 | 
            +
                  #   @param balance_check [Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck] How the account's available balance should be checked. Please contact [support@i
         | 
| 85 | 
            +
                  #
         | 
| 77 86 | 
             
                  #   @param check_number [String] The check number Increase should use for the check. This should not contain lead
         | 
| 78 87 | 
             
                  #
         | 
| 79 88 | 
             
                  #   @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] Details relating to the physical check that Increase will print and mail. This i
         | 
| @@ -98,6 +107,21 @@ module Increase | |
| 98 107 | 
             
                    #   @return [Array<Symbol>]
         | 
| 99 108 | 
             
                  end
         | 
| 100 109 |  | 
| 110 | 
            +
                  # How the account's available balance should be checked. Please contact
         | 
| 111 | 
            +
                  # [support@increase.com](mailto:support@increase.com) to enable this parameter.
         | 
| 112 | 
            +
                  module BalanceCheck
         | 
| 113 | 
            +
                    extend Increase::Internal::Type::Enum
         | 
| 114 | 
            +
             | 
| 115 | 
            +
                    # The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount.
         | 
| 116 | 
            +
                    FULL = :full
         | 
| 117 | 
            +
             | 
| 118 | 
            +
                    # No balance check will performed when the check transfer is initiated. A zero-dollar Pending Transaction will be created. The balance will still be checked when the Inbound Check Deposit is created.
         | 
| 119 | 
            +
                    NONE = :none
         | 
| 120 | 
            +
             | 
| 121 | 
            +
                    # @!method self.values
         | 
| 122 | 
            +
                    #   @return [Array<Symbol>]
         | 
| 123 | 
            +
                  end
         | 
| 124 | 
            +
             | 
| 101 125 | 
             
                  class PhysicalCheck < Increase::Internal::Type::BaseModel
         | 
| 102 126 | 
             
                    # @!attribute mailing_address
         | 
| 103 127 | 
             
                    #   Details for where Increase will mail the check.
         | 
| @@ -8,7 +8,7 @@ module Increase | |
| 8 8 | 
             
                  #
         | 
| 9 9 | 
             
                  # Create a Check Transfer
         | 
| 10 10 | 
             
                  #
         | 
| 11 | 
            -
                  # @overload create(account_id:, amount:, fulfillment_method:, source_account_number_id:, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, request_options: {})
         | 
| 11 | 
            +
                  # @overload create(account_id:, amount:, fulfillment_method:, source_account_number_id:, balance_check: nil, check_number: nil, physical_check: nil, require_approval: nil, third_party: nil, request_options: {})
         | 
| 12 12 | 
             
                  #
         | 
| 13 13 | 
             
                  # @param account_id [String] The identifier for the account that will send the transfer.
         | 
| 14 14 | 
             
                  #
         | 
| @@ -18,6 +18,8 @@ module Increase | |
| 18 18 | 
             
                  #
         | 
| 19 19 | 
             
                  # @param source_account_number_id [String] The identifier of the Account Number from which to send the transfer and print o
         | 
| 20 20 | 
             
                  #
         | 
| 21 | 
            +
                  # @param balance_check [Symbol, Increase::Models::CheckTransferCreateParams::BalanceCheck] How the account's available balance should be checked. Please contact [support@i
         | 
| 22 | 
            +
                  #
         | 
| 21 23 | 
             
                  # @param check_number [String] The check number Increase should use for the check. This should not contain lead
         | 
| 22 24 | 
             
                  #
         | 
| 23 25 | 
             
                  # @param physical_check [Increase::Models::CheckTransferCreateParams::PhysicalCheck] Details relating to the physical check that Increase will print and mail. This i
         | 
    
        data/lib/increase/version.rb
    CHANGED
    
    
| @@ -35,6 +35,23 @@ module Increase | |
| 35 35 | 
             
                  sig { returns(String) }
         | 
| 36 36 | 
             
                  attr_accessor :source_account_number_id
         | 
| 37 37 |  | 
| 38 | 
            +
                  # How the account's available balance should be checked. Please contact
         | 
| 39 | 
            +
                  # [support@increase.com](mailto:support@increase.com) to enable this parameter.
         | 
| 40 | 
            +
                  sig do
         | 
| 41 | 
            +
                    returns(
         | 
| 42 | 
            +
                      T.nilable(Increase::CheckTransferCreateParams::BalanceCheck::OrSymbol)
         | 
| 43 | 
            +
                    )
         | 
| 44 | 
            +
                  end
         | 
| 45 | 
            +
                  attr_reader :balance_check
         | 
| 46 | 
            +
             | 
| 47 | 
            +
                  sig do
         | 
| 48 | 
            +
                    params(
         | 
| 49 | 
            +
                      balance_check:
         | 
| 50 | 
            +
                        Increase::CheckTransferCreateParams::BalanceCheck::OrSymbol
         | 
| 51 | 
            +
                    ).void
         | 
| 52 | 
            +
                  end
         | 
| 53 | 
            +
                  attr_writer :balance_check
         | 
| 54 | 
            +
             | 
| 38 55 | 
             
                  # The check number Increase should use for the check. This should not contain
         | 
| 39 56 | 
             
                  # leading zeroes and must be unique across the `source_account_number`. If this is
         | 
| 40 57 | 
             
                  # omitted, Increase will generate a check number for you.
         | 
| @@ -89,6 +106,8 @@ module Increase | |
| 89 106 | 
             
                      fulfillment_method:
         | 
| 90 107 | 
             
                        Increase::CheckTransferCreateParams::FulfillmentMethod::OrSymbol,
         | 
| 91 108 | 
             
                      source_account_number_id: String,
         | 
| 109 | 
            +
                      balance_check:
         | 
| 110 | 
            +
                        Increase::CheckTransferCreateParams::BalanceCheck::OrSymbol,
         | 
| 92 111 | 
             
                      check_number: String,
         | 
| 93 112 | 
             
                      physical_check:
         | 
| 94 113 | 
             
                        Increase::CheckTransferCreateParams::PhysicalCheck::OrHash,
         | 
| @@ -107,6 +126,9 @@ module Increase | |
| 107 126 | 
             
                    # The identifier of the Account Number from which to send the transfer and print
         | 
| 108 127 | 
             
                    # on the check.
         | 
| 109 128 | 
             
                    source_account_number_id:,
         | 
| 129 | 
            +
                    # How the account's available balance should be checked. Please contact
         | 
| 130 | 
            +
                    # [support@increase.com](mailto:support@increase.com) to enable this parameter.
         | 
| 131 | 
            +
                    balance_check: nil,
         | 
| 110 132 | 
             
                    # The check number Increase should use for the check. This should not contain
         | 
| 111 133 | 
             
                    # leading zeroes and must be unique across the `source_account_number`. If this is
         | 
| 112 134 | 
             
                    # omitted, Increase will generate a check number for you.
         | 
| @@ -133,6 +155,8 @@ module Increase | |
| 133 155 | 
             
                        fulfillment_method:
         | 
| 134 156 | 
             
                          Increase::CheckTransferCreateParams::FulfillmentMethod::OrSymbol,
         | 
| 135 157 | 
             
                        source_account_number_id: String,
         | 
| 158 | 
            +
                        balance_check:
         | 
| 159 | 
            +
                          Increase::CheckTransferCreateParams::BalanceCheck::OrSymbol,
         | 
| 136 160 | 
             
                        check_number: String,
         | 
| 137 161 | 
             
                        physical_check: Increase::CheckTransferCreateParams::PhysicalCheck,
         | 
| 138 162 | 
             
                        require_approval: T::Boolean,
         | 
| @@ -182,6 +206,42 @@ module Increase | |
| 182 206 | 
             
                    end
         | 
| 183 207 | 
             
                  end
         | 
| 184 208 |  | 
| 209 | 
            +
                  # How the account's available balance should be checked. Please contact
         | 
| 210 | 
            +
                  # [support@increase.com](mailto:support@increase.com) to enable this parameter.
         | 
| 211 | 
            +
                  module BalanceCheck
         | 
| 212 | 
            +
                    extend Increase::Internal::Type::Enum
         | 
| 213 | 
            +
             | 
| 214 | 
            +
                    TaggedSymbol =
         | 
| 215 | 
            +
                      T.type_alias do
         | 
| 216 | 
            +
                        T.all(Symbol, Increase::CheckTransferCreateParams::BalanceCheck)
         | 
| 217 | 
            +
                      end
         | 
| 218 | 
            +
                    OrSymbol = T.type_alias { T.any(Symbol, String) }
         | 
| 219 | 
            +
             | 
| 220 | 
            +
                    # The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount.
         | 
| 221 | 
            +
                    FULL =
         | 
| 222 | 
            +
                      T.let(
         | 
| 223 | 
            +
                        :full,
         | 
| 224 | 
            +
                        Increase::CheckTransferCreateParams::BalanceCheck::TaggedSymbol
         | 
| 225 | 
            +
                      )
         | 
| 226 | 
            +
             | 
| 227 | 
            +
                    # No balance check will performed when the check transfer is initiated. A zero-dollar Pending Transaction will be created. The balance will still be checked when the Inbound Check Deposit is created.
         | 
| 228 | 
            +
                    NONE =
         | 
| 229 | 
            +
                      T.let(
         | 
| 230 | 
            +
                        :none,
         | 
| 231 | 
            +
                        Increase::CheckTransferCreateParams::BalanceCheck::TaggedSymbol
         | 
| 232 | 
            +
                      )
         | 
| 233 | 
            +
             | 
| 234 | 
            +
                    sig do
         | 
| 235 | 
            +
                      override.returns(
         | 
| 236 | 
            +
                        T::Array[
         | 
| 237 | 
            +
                          Increase::CheckTransferCreateParams::BalanceCheck::TaggedSymbol
         | 
| 238 | 
            +
                        ]
         | 
| 239 | 
            +
                      )
         | 
| 240 | 
            +
                    end
         | 
| 241 | 
            +
                    def self.values
         | 
| 242 | 
            +
                    end
         | 
| 243 | 
            +
                  end
         | 
| 244 | 
            +
             | 
| 185 245 | 
             
                  class PhysicalCheck < Increase::Internal::Type::BaseModel
         | 
| 186 246 | 
             
                    OrHash =
         | 
| 187 247 | 
             
                      T.type_alias do
         | 
| @@ -11,6 +11,8 @@ module Increase | |
| 11 11 | 
             
                      fulfillment_method:
         | 
| 12 12 | 
             
                        Increase::CheckTransferCreateParams::FulfillmentMethod::OrSymbol,
         | 
| 13 13 | 
             
                      source_account_number_id: String,
         | 
| 14 | 
            +
                      balance_check:
         | 
| 15 | 
            +
                        Increase::CheckTransferCreateParams::BalanceCheck::OrSymbol,
         | 
| 14 16 | 
             
                      check_number: String,
         | 
| 15 17 | 
             
                      physical_check:
         | 
| 16 18 | 
             
                        Increase::CheckTransferCreateParams::PhysicalCheck::OrHash,
         | 
| @@ -29,6 +31,9 @@ module Increase | |
| 29 31 | 
             
                    # The identifier of the Account Number from which to send the transfer and print
         | 
| 30 32 | 
             
                    # on the check.
         | 
| 31 33 | 
             
                    source_account_number_id:,
         | 
| 34 | 
            +
                    # How the account's available balance should be checked. Please contact
         | 
| 35 | 
            +
                    # [support@increase.com](mailto:support@increase.com) to enable this parameter.
         | 
| 36 | 
            +
                    balance_check: nil,
         | 
| 32 37 | 
             
                    # The check number Increase should use for the check. This should not contain
         | 
| 33 38 | 
             
                    # leading zeroes and must be unique across the `source_account_number`. If this is
         | 
| 34 39 | 
             
                    # omitted, Increase will generate a check number for you.
         | 
| @@ -6,6 +6,7 @@ module Increase | |
| 6 6 | 
             
                    amount: Integer,
         | 
| 7 7 | 
             
                    fulfillment_method: Increase::Models::CheckTransferCreateParams::fulfillment_method,
         | 
| 8 8 | 
             
                    source_account_number_id: String,
         | 
| 9 | 
            +
                    balance_check: Increase::Models::CheckTransferCreateParams::balance_check,
         | 
| 9 10 | 
             
                    check_number: String,
         | 
| 10 11 | 
             
                    physical_check: Increase::CheckTransferCreateParams::PhysicalCheck,
         | 
| 11 12 | 
             
                    require_approval: bool,
         | 
| @@ -25,6 +26,12 @@ module Increase | |
| 25 26 |  | 
| 26 27 | 
             
                  attr_accessor source_account_number_id: String
         | 
| 27 28 |  | 
| 29 | 
            +
                  attr_reader balance_check: Increase::Models::CheckTransferCreateParams::balance_check?
         | 
| 30 | 
            +
             | 
| 31 | 
            +
                  def balance_check=: (
         | 
| 32 | 
            +
                    Increase::Models::CheckTransferCreateParams::balance_check
         | 
| 33 | 
            +
                  ) -> Increase::Models::CheckTransferCreateParams::balance_check
         | 
| 34 | 
            +
             | 
| 28 35 | 
             
                  attr_reader check_number: String?
         | 
| 29 36 |  | 
| 30 37 | 
             
                  def check_number=: (String) -> String
         | 
| @@ -50,6 +57,7 @@ module Increase | |
| 50 57 | 
             
                    amount: Integer,
         | 
| 51 58 | 
             
                    fulfillment_method: Increase::Models::CheckTransferCreateParams::fulfillment_method,
         | 
| 52 59 | 
             
                    source_account_number_id: String,
         | 
| 60 | 
            +
                    ?balance_check: Increase::Models::CheckTransferCreateParams::balance_check,
         | 
| 53 61 | 
             
                    ?check_number: String,
         | 
| 54 62 | 
             
                    ?physical_check: Increase::CheckTransferCreateParams::PhysicalCheck,
         | 
| 55 63 | 
             
                    ?require_approval: bool,
         | 
| @@ -62,6 +70,7 @@ module Increase | |
| 62 70 | 
             
                    amount: Integer,
         | 
| 63 71 | 
             
                    fulfillment_method: Increase::Models::CheckTransferCreateParams::fulfillment_method,
         | 
| 64 72 | 
             
                    source_account_number_id: String,
         | 
| 73 | 
            +
                    balance_check: Increase::Models::CheckTransferCreateParams::balance_check,
         | 
| 65 74 | 
             
                    check_number: String,
         | 
| 66 75 | 
             
                    physical_check: Increase::CheckTransferCreateParams::PhysicalCheck,
         | 
| 67 76 | 
             
                    require_approval: bool,
         | 
| @@ -83,6 +92,20 @@ module Increase | |
| 83 92 | 
             
                    def self?.values: -> ::Array[Increase::Models::CheckTransferCreateParams::fulfillment_method]
         | 
| 84 93 | 
             
                  end
         | 
| 85 94 |  | 
| 95 | 
            +
                  type balance_check = :full | :none
         | 
| 96 | 
            +
             | 
| 97 | 
            +
                  module BalanceCheck
         | 
| 98 | 
            +
                    extend Increase::Internal::Type::Enum
         | 
| 99 | 
            +
             | 
| 100 | 
            +
                    # The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount.
         | 
| 101 | 
            +
                    FULL: :full
         | 
| 102 | 
            +
             | 
| 103 | 
            +
                    # No balance check will performed when the check transfer is initiated. A zero-dollar Pending Transaction will be created. The balance will still be checked when the Inbound Check Deposit is created.
         | 
| 104 | 
            +
                    NONE: :none
         | 
| 105 | 
            +
             | 
| 106 | 
            +
                    def self?.values: -> ::Array[Increase::Models::CheckTransferCreateParams::balance_check]
         | 
| 107 | 
            +
                  end
         | 
| 108 | 
            +
             | 
| 86 109 | 
             
                  type physical_check =
         | 
| 87 110 | 
             
                    {
         | 
| 88 111 | 
             
                      mailing_address: Increase::CheckTransferCreateParams::PhysicalCheck::MailingAddress,
         | 
| @@ -6,6 +6,7 @@ module Increase | |
| 6 6 | 
             
                    amount: Integer,
         | 
| 7 7 | 
             
                    fulfillment_method: Increase::Models::CheckTransferCreateParams::fulfillment_method,
         | 
| 8 8 | 
             
                    source_account_number_id: String,
         | 
| 9 | 
            +
                    ?balance_check: Increase::Models::CheckTransferCreateParams::balance_check,
         | 
| 9 10 | 
             
                    ?check_number: String,
         | 
| 10 11 | 
             
                    ?physical_check: Increase::CheckTransferCreateParams::PhysicalCheck,
         | 
| 11 12 | 
             
                    ?require_approval: bool,
         |