increase 1.350.0 → 1.352.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: adebb64c6cd675fc86e8f775270247fd1f157a16d392b9c754a7e1c0c7938110
-  data.tar.gz: 6b39d876b4891952467d186091578d6931a5a2fd5e7d0d4d743d6c1ace4a17f9
+  metadata.gz: a3a0faba0f1fabf59ef08da704ac074fb3072fe05fd88f030085c6a1a607e21a
+  data.tar.gz: 914e704b6cc6f73250740529117d1fd2c8cfa8aa4dd4e3aa29995c0b145d0eb0
 SHA512:
-  metadata.gz: 2eca8b8f5625cc74161ccb7d7a0f2ad0013a60697508f00f78ae5f2e37ed3d4c23f7075b01e9f608698d0e11a64d9342253de4e3dee3d6df241f3091fc60c214
-  data.tar.gz: 11b583edd8100371cda43b93f2f0d625e30be93c8ef3ea68f50f15e2c684669f6aa7d6b172940028ed92feede0856ac544c80b169d641081c20c4634f54e0c0e
+  metadata.gz: e05ef8df91dc79fafdc84978f7c23289a198df220494b0459ad427a2b4b34dbe2d8e68aac97e04c20ba6dacaba97ce801e3c58f9e022a4331078fc3b1d2cf741
+  data.tar.gz: 4cefdcfc16a1f118021f0d7abe63c22187ab17429645820a782bef66f41a8d22dd3cfe52ae9379842bf0a7a4edd399ee8c4289f6970f37c5943d3a69165f384c

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.350.0"
+gem "increase", "~> 1.352.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/increase/models/account_statement.rb

@@ -49,14 +49,18 @@ module Increase
 
       # @!attribute statement_period_end
       #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
-      #   of the period the Account Statement covers.
+      #   of the period the Account Statement covers. The statement covers all
+      #   transactions up to, but not including this timestamp. Usually, this is the
+      #   beginning of the following month.
       #
       #   @return [Time]
       required :statement_period_end, Time
 
       # @!attribute statement_period_start
       #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
-      #   start of the period the Account Statement covers.
+      #   start of the period the Account Statement covers. This is the first moment of
+      #   the statement period and is inclusive. Usually, this is the beginning of the
+      #   month this statement covers.
       #
       #   @return [Time]
       required :statement_period_start, Time
@@ -91,11 +95,15 @@ module Increase
       #
       #   @param statement_period_end [Time]
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
-      #     of the period the Account Statement covers.
+      #     of the period the Account Statement covers. The statement covers all
+      #     transactions up to, but not including this timestamp. Usually, this is the
+      #     beginning of the following month.
       #
       #   @param statement_period_start [Time]
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
-      #     start of the period the Account Statement covers.
+      #     start of the period the Account Statement covers. This is the first moment of
+      #     the statement period and is inclusive. Usually, this is the beginning of the
+      #     month this statement covers.
       #
       #   @param type [Symbol, Increase::Models::AccountStatement::Type]
       #     A constant representing the object's type. For this resource it will always be

data/lib/increase/models/balance_lookup.rb

@@ -59,19 +59,6 @@ module Increase
 
       # @see Increase::Models::BalanceLookup#loan
       class Loan < Increase::Internal::Type::BaseModel
-        # @!attribute due_at
-        #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
-        #   payment is due.
-        #
-        #   @return [Time, nil]
-        required :due_at, Time, nil?: true
-
-        # @!attribute due_balance
-        #   The total amount due on the loan.
-        #
-        #   @return [Integer]
-        required :due_balance, Integer
-
         # @!attribute due_fees
         #   The fees on the loan that are due and unpaid.
         #
@@ -108,27 +95,9 @@ module Increase
         #   @return [Integer, nil]
         required :not_due_principal, Integer, nil?: true
 
-        # @!attribute past_due_balance
-        #   The amount past due on the loan.
-        #
-        #   @return [Integer]
-        required :past_due_balance, Integer
-
-        # @!attribute receivables
-        #   The receivables balances for the loan.
-        #
-        #   @return [Increase::Models::BalanceLookup::Loan::Receivables, nil]
-        required :receivables, -> { Increase::BalanceLookup::Loan::Receivables }, nil?: true
-
-        # @!method initialize(due_at:, due_balance:, due_fees:, due_interest:, due_principal:, not_due_fees:, not_due_interest:, not_due_principal:, past_due_balance:, receivables:)
+        # @!method initialize(due_fees:, due_interest:, due_principal:, not_due_fees:, not_due_interest:, not_due_principal:)
         #   The loan balances for the Account.
         #
-        #   @param due_at [Time, nil]
-        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan
-        #     payment is due.
-        #
-        #   @param due_balance [Integer] The total amount due on the loan.
-        #
         #   @param due_fees [Integer, nil] The fees on the loan that are due and unpaid.
         #
         #   @param due_interest [Integer, nil] The interest on the loan that is due and unpaid.
@@ -140,33 +109,6 @@ module Increase
         #   @param not_due_interest [Integer, nil] The interest on the loan that is not yet due.
         #
         #   @param not_due_principal [Integer, nil] The principal on the loan that is not yet due.
-        #
-        #   @param past_due_balance [Integer] The amount past due on the loan.
-        #
-        #   @param receivables [Increase::Models::BalanceLookup::Loan::Receivables, nil]
-        #     The receivables balances for the loan.
-
-        # @see Increase::Models::BalanceLookup::Loan#receivables
-        class Receivables < Increase::Internal::Type::BaseModel
-          # @!attribute purchasable_balance
-          #   The balance of seasoned receivables available to be purchased.
-          #
-          #   @return [Integer]
-          required :purchasable_balance, Integer
-
-          # @!attribute purchased_balance
-          #   The balance of receivables that have been purchased.
-          #
-          #   @return [Integer]
-          required :purchased_balance, Integer
-
-          # @!method initialize(purchasable_balance:, purchased_balance:)
-          #   The receivables balances for the loan.
-          #
-          #   @param purchasable_balance [Integer] The balance of seasoned receivables available to be purchased.
-          #
-          #   @param purchased_balance [Integer] The balance of receivables that have been purchased.
-        end
       end
 
       # A constant representing the object's type. For this resource it will always be

data/lib/increase/models/declined_transaction.rb

@@ -2594,6 +2594,9 @@ module Increase
             # Your account is not enabled to receive Real-Time Payments transfers.
             REAL_TIME_PAYMENTS_NOT_ENABLED = :real_time_payments_not_enabled
 
+            # The transaction is not allowed per Increase's terms.
+            TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
+
             # @!method self.values
             #   @return [Array<Symbol>]
           end

data/lib/increase/models/digital_wallet_token.rb

@@ -56,12 +56,24 @@ module Increase
                -> { Increase::DigitalWalletToken::DynamicPrimaryAccountNumber },
                nil?: true
 
+      # @!attribute primary_account_number_reference_identifier
+      #   The reference identifier assigned by the card network to the underlying Card.
+      #
+      #   @return [String]
+      required :primary_account_number_reference_identifier, String
+
       # @!attribute status
       #   This indicates if payments can be made with the Digital Wallet Token.
       #
       #   @return [Symbol, Increase::Models::DigitalWalletToken::Status]
       required :status, enum: -> { Increase::DigitalWalletToken::Status }
 
+      # @!attribute token_reference_identifier
+      #   The reference identifier assigned by the card network to the token.
+      #
+      #   @return [String]
+      required :token_reference_identifier, String
+
       # @!attribute token_requestor
       #   The digital wallet app being used.
       #
@@ -81,7 +93,7 @@ module Increase
       #   @return [Array<Increase::Models::DigitalWalletToken::Update>]
       required :updates, -> { Increase::Internal::Type::ArrayOf[Increase::DigitalWalletToken::Update] }
 
-      # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, decline:, device:, dynamic_primary_account_number:, status:, token_requestor:, type:, updates:)
+      # @!method initialize(id:, account_id:, card_id:, cardholder:, created_at:, decline:, device:, dynamic_primary_account_number:, primary_account_number_reference_identifier:, status:, token_reference_identifier:, token_requestor:, type:, updates:)
       #   A Digital Wallet Token is created when a user adds a Card to their Apple Pay or
       #   Google Pay app. The Digital Wallet Token can be used for purchases just like a
       #   Card.
@@ -109,9 +121,15 @@ module Increase
       #   @param dynamic_primary_account_number [Increase::Models::DigitalWalletToken::DynamicPrimaryAccountNumber, nil]
       #     The redacted Dynamic Primary Account Number.
       #
+      #   @param primary_account_number_reference_identifier [String]
+      #     The reference identifier assigned by the card network to the underlying Card.
+      #
       #   @param status [Symbol, Increase::Models::DigitalWalletToken::Status]
       #     This indicates if payments can be made with the Digital Wallet Token.
       #
+      #   @param token_reference_identifier [String]
+      #     The reference identifier assigned by the card network to the token.
+      #
       #   @param token_requestor [Symbol, Increase::Models::DigitalWalletToken::TokenRequestor]
       #     The digital wallet app being used.
       #

data/lib/increase/models/entity_create_params.rb

@@ -2193,29 +2193,24 @@ module Increase
         # @see Increase::Models::EntityCreateParams::Trust#address
         class Address < Increase::Internal::Type::BaseModel
           # @!attribute city
-          #   The city of the address.
+          #   The city, district, town, or village of the address.
           #
           #   @return [String]
           required :city, String
 
-          # @!attribute line1
-          #   The first line of the address. This is usually the street number and street.
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
-          #   @return [String]
-          required :line1, String
-
-          # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          #   Defaults to `US`.
           #
           #   @return [String]
-          required :state, String
+          required :country, String
 
-          # @!attribute zip
-          #   The ZIP code of the address.
+          # @!attribute line1
+          #   The first line of the address. This is usually the street number and street.
           #
           #   @return [String]
-          required :zip, String
+          required :line1, String
 
           # @!attribute line2
           #   The second line of the address. This might be the floor or room number.
@@ -2223,21 +2218,39 @@ module Increase
           #   @return [String, nil]
           optional :line2, String
 
-          # @!method initialize(city:, line1:, state:, zip:, line2: nil)
+          # @!attribute state
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address. Required in certain countries.
+          #
+          #   @return [String, nil]
+          optional :state, String
+
+          # @!attribute zip
+          #   The ZIP or postal code of the address. Required in certain countries.
+          #
+          #   @return [String, nil]
+          optional :zip, String
+
+          # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
           #   The trust's physical address. Mail receiving locations like PO Boxes and PMB's
           #   are disallowed.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String] The city, district, town, or village of the address.
           #
-          #   @param line1 [String] The first line of the address. This is usually the street number and street.
+          #   @param country [String]
+          #     The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
-          #   @param state [String]
-          #     The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #     the address.
+          #     Defaults to `US`.
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param line1 [String] The first line of the address. This is usually the street number and street.
           #
           #   @param line2 [String] The second line of the address. This might be the floor or room number.
+          #
+          #   @param state [String]
+          #     The two-letter United States Postal Service (USPS) abbreviation for the US
+          #     state, province, or region of the address. Required in certain countries.
+          #
+          #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
         end
 
         # Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require

data/lib/increase/models/entity_update_params.rb

@@ -1350,29 +1350,24 @@ module Increase
         # @see Increase::Models::EntityUpdateParams::Trust#address
         class Address < Increase::Internal::Type::BaseModel
           # @!attribute city
-          #   The city of the address.
+          #   The city, district, town, or village of the address.
           #
           #   @return [String]
           required :city, String
 
-          # @!attribute line1
-          #   The first line of the address. This is usually the street number and street.
+          # @!attribute country
+          #   The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
-          #   @return [String]
-          required :line1, String
-
-          # @!attribute state
-          #   The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #   the address.
+          #   Defaults to `US`.
           #
           #   @return [String]
-          required :state, String
+          required :country, String
 
-          # @!attribute zip
-          #   The ZIP code of the address.
+          # @!attribute line1
+          #   The first line of the address. This is usually the street number and street.
           #
           #   @return [String]
-          required :zip, String
+          required :line1, String
 
           # @!attribute line2
           #   The second line of the address. This might be the floor or room number.
@@ -1380,21 +1375,39 @@ module Increase
           #   @return [String, nil]
           optional :line2, String
 
-          # @!method initialize(city:, line1:, state:, zip:, line2: nil)
+          # @!attribute state
+          #   The two-letter United States Postal Service (USPS) abbreviation for the US
+          #   state, province, or region of the address. Required in certain countries.
+          #
+          #   @return [String, nil]
+          optional :state, String
+
+          # @!attribute zip
+          #   The ZIP or postal code of the address. Required in certain countries.
+          #
+          #   @return [String, nil]
+          optional :zip, String
+
+          # @!method initialize(city:, country:, line1:, line2: nil, state: nil, zip: nil)
           #   The entity's physical address. Mail receiving locations like PO Boxes and PMB's
           #   are disallowed.
           #
-          #   @param city [String] The city of the address.
+          #   @param city [String] The city, district, town, or village of the address.
           #
-          #   @param line1 [String] The first line of the address. This is usually the street number and street.
+          #   @param country [String]
+          #     The two-letter ISO 3166-1 alpha-2 code for the country of the address.
           #
-          #   @param state [String]
-          #     The two-letter United States Postal Service (USPS) abbreviation for the state of
-          #     the address.
+          #     Defaults to `US`.
           #
-          #   @param zip [String] The ZIP code of the address.
+          #   @param line1 [String] The first line of the address. This is usually the street number and street.
           #
           #   @param line2 [String] The second line of the address. This might be the floor or room number.
+          #
+          #   @param state [String]
+          #     The two-letter United States Postal Service (USPS) abbreviation for the US
+          #     state, province, or region of the address. Required in certain countries.
+          #
+          #   @param zip [String] The ZIP or postal code of the address. Required in certain countries.
         end
 
         # @see Increase::Models::EntityUpdateParams::Trust#grantor

data/lib/increase/models/event.rb

@@ -423,6 +423,12 @@ module Increase
         # Occurs whenever a Real-Time Payments Request for Payment is updated.
         REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
 
+        # Occurs whenever a SEPA Instant Transfer is created.
+        SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
+
+        # Occurs whenever a SEPA Instant Transfer is updated.
+        SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
+
         # Occurs whenever a Swift Transfer is created.
         SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
 
@@ -432,6 +438,12 @@ module Increase
         # Occurs whenever a Transaction is created.
         TRANSACTION_CREATED = :"transaction.created"
 
+        # Occurs whenever a UK Faster Payment System Transfer is created.
+        UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
+
+        # Occurs whenever a UK Faster Payment System Transfer is updated.
+        UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
+
         # Occurs whenever a Wire Drawdown Request is created.
         WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
 

data/lib/increase/models/event_list_params.rb

@@ -435,6 +435,12 @@ module Increase
           # Occurs whenever a Real-Time Payments Request for Payment is updated.
           REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
 
+          # Occurs whenever a SEPA Instant Transfer is created.
+          SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
+
+          # Occurs whenever a SEPA Instant Transfer is updated.
+          SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
+
           # Occurs whenever a Swift Transfer is created.
           SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
 
@@ -444,6 +450,12 @@ module Increase
           # Occurs whenever a Transaction is created.
           TRANSACTION_CREATED = :"transaction.created"
 
+          # Occurs whenever a UK Faster Payment System Transfer is created.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
+
+          # Occurs whenever a UK Faster Payment System Transfer is updated.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
+
           # Occurs whenever a Wire Drawdown Request is created.
           WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
 

data/lib/increase/models/event_subscription.rb

@@ -464,6 +464,12 @@ module Increase
           # Occurs whenever a Real-Time Payments Request for Payment is updated.
           REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
 
+          # Occurs whenever a SEPA Instant Transfer is created.
+          SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
+
+          # Occurs whenever a SEPA Instant Transfer is updated.
+          SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
+
           # Occurs whenever a Swift Transfer is created.
           SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
 
@@ -473,6 +479,12 @@ module Increase
           # Occurs whenever a Transaction is created.
           TRANSACTION_CREATED = :"transaction.created"
 
+          # Occurs whenever a UK Faster Payment System Transfer is created.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
+
+          # Occurs whenever a UK Faster Payment System Transfer is updated.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
+
           # Occurs whenever a Wire Drawdown Request is created.
           WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
 

data/lib/increase/models/event_subscription_create_params.rb

@@ -433,6 +433,12 @@ module Increase
           # Occurs whenever a Real-Time Payments Request for Payment is updated.
           REAL_TIME_PAYMENTS_REQUEST_FOR_PAYMENT_UPDATED = :"real_time_payments_request_for_payment.updated"
 
+          # Occurs whenever a SEPA Instant Transfer is created.
+          SEPA_INSTANT_TRANSFER_CREATED = :"sepa_instant_transfer.created"
+
+          # Occurs whenever a SEPA Instant Transfer is updated.
+          SEPA_INSTANT_TRANSFER_UPDATED = :"sepa_instant_transfer.updated"
+
           # Occurs whenever a Swift Transfer is created.
           SWIFT_TRANSFER_CREATED = :"swift_transfer.created"
 
@@ -442,6 +448,12 @@ module Increase
           # Occurs whenever a Transaction is created.
           TRANSACTION_CREATED = :"transaction.created"
 
+          # Occurs whenever a UK Faster Payment System Transfer is created.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_CREATED = :"uk_faster_payment_system_transfer.created"
+
+          # Occurs whenever a UK Faster Payment System Transfer is updated.
+          UK_FASTER_PAYMENT_SYSTEM_TRANSFER_UPDATED = :"uk_faster_payment_system_transfer.updated"
+
           # Occurs whenever a Wire Drawdown Request is created.
           WIRE_DRAWDOWN_REQUEST_CREATED = :"wire_drawdown_request.created"
 

data/lib/increase/models/inbound_ach_transfer.rb

@@ -1088,6 +1088,12 @@ module Increase
 
       # @see Increase::Models::InboundACHTransfer#transfer_return
       class TransferReturn < Increase::Internal::Type::BaseModel
+        # @!attribute raw_reason_code
+        #   The three character ACH return code, in the range R01 to R85.
+        #
+        #   @return [String]
+        required :raw_reason_code, String
+
         # @!attribute reason
         #   The reason for the transfer return.
         #
@@ -1106,9 +1112,11 @@ module Increase
         #   @return [String]
         required :transaction_id, String
 
-        # @!method initialize(reason:, returned_at:, transaction_id:)
+        # @!method initialize(raw_reason_code:, reason:, returned_at:, transaction_id:)
         #   If your transfer is returned, this will contain details of the return.
         #
+        #   @param raw_reason_code [String] The three character ACH return code, in the range R01 to R85.
+        #
         #   @param reason [Symbol, Increase::Models::InboundACHTransfer::TransferReturn::Reason]
         #     The reason for the transfer return.
         #

data/lib/increase/models/inbound_real_time_payments_transfer.rb

@@ -240,6 +240,9 @@ module Increase
           # Your account is not enabled to receive Real-Time Payments transfers.
           REAL_TIME_PAYMENTS_NOT_ENABLED = :real_time_payments_not_enabled
 
+          # The transaction is not allowed per Increase's terms.
+          TRANSACTION_NOT_ALLOWED = :transaction_not_allowed
+
           # @!method self.values
           #   @return [Array<Symbol>]
         end