increase 1.203.0 → 1.205.0

data/lib/increase/models/wire_transfer.rb

@@ -273,55 +273,41 @@ module Increase
 
       # @see Increase::Models::WireTransfer#created_by
       class CreatedBy < Increase::Internal::Type::BaseModel
-        # @!attribute api_key
-        #   If present, details about the API key that created the transfer.
-        #
-        #   @return [Increase::Models::WireTransfer::CreatedBy::APIKey, nil]
-        required :api_key, -> { Increase::WireTransfer::CreatedBy::APIKey }, nil?: true
-
         # @!attribute category
         #   The type of object that created this transfer.
         #
         #   @return [Symbol, Increase::Models::WireTransfer::CreatedBy::Category]
         required :category, enum: -> { Increase::WireTransfer::CreatedBy::Category }
 
+        # @!attribute api_key
+        #   If present, details about the API key that created the transfer.
+        #
+        #   @return [Increase::Models::WireTransfer::CreatedBy::APIKey, nil]
+        optional :api_key, -> { Increase::WireTransfer::CreatedBy::APIKey }, nil?: true
+
         # @!attribute oauth_application
         #   If present, details about the OAuth Application that created the transfer.
         #
         #   @return [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil]
-        required :oauth_application, -> { Increase::WireTransfer::CreatedBy::OAuthApplication }, nil?: true
+        optional :oauth_application, -> { Increase::WireTransfer::CreatedBy::OAuthApplication }, nil?: true
 
         # @!attribute user
         #   If present, details about the User that created the transfer.
         #
         #   @return [Increase::Models::WireTransfer::CreatedBy::User, nil]
-        required :user, -> { Increase::WireTransfer::CreatedBy::User }, nil?: true
+        optional :user, -> { Increase::WireTransfer::CreatedBy::User }, nil?: true
 
-        # @!method initialize(api_key:, category:, oauth_application:, user:)
+        # @!method initialize(category:, api_key: nil, oauth_application: nil, user: nil)
         #   What object created the transfer, either via the API or the dashboard.
         #
-        #   @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
-        #
         #   @param category [Symbol, Increase::Models::WireTransfer::CreatedBy::Category] The type of object that created this transfer.
         #
+        #   @param api_key [Increase::Models::WireTransfer::CreatedBy::APIKey, nil] If present, details about the API key that created the transfer.
+        #
         #   @param oauth_application [Increase::Models::WireTransfer::CreatedBy::OAuthApplication, nil] If present, details about the OAuth Application that created the transfer.
         #
         #   @param user [Increase::Models::WireTransfer::CreatedBy::User, nil] If present, details about the User that created the transfer.
 
-        # @see Increase::Models::WireTransfer::CreatedBy#api_key
-        class APIKey < Increase::Internal::Type::BaseModel
-          # @!attribute description
-          #   The description set for the API key when it was created.
-          #
-          #   @return [String, nil]
-          required :description, String, nil?: true
-
-          # @!method initialize(description:)
-          #   If present, details about the API key that created the transfer.
-          #
-          #   @param description [String, nil] The description set for the API key when it was created.
-        end
-
         # The type of object that created this transfer.
         #
         # @see Increase::Models::WireTransfer::CreatedBy#category
@@ -341,6 +327,20 @@ module Increase
           #   @return [Array<Symbol>]
         end
 
+        # @see Increase::Models::WireTransfer::CreatedBy#api_key
+        class APIKey < Increase::Internal::Type::BaseModel
+          # @!attribute description
+          #   The description set for the API key when it was created.
+          #
+          #   @return [String, nil]
+          required :description, String, nil?: true
+
+          # @!method initialize(description:)
+          #   If present, details about the API key that created the transfer.
+          #
+          #   @param description [String, nil] The description set for the API key when it was created.
+        end
+
         # @see Increase::Models::WireTransfer::CreatedBy#oauth_application
         class OAuthApplication < Increase::Internal::Type::BaseModel
           # @!attribute name
@@ -541,16 +541,16 @@ module Increase
         #   is equal to `tax`.
         #
         #   @return [Increase::Models::WireTransfer::Remittance::Tax, nil]
-        required :tax, -> { Increase::WireTransfer::Remittance::Tax }, nil?: true
+        optional :tax, -> { Increase::WireTransfer::Remittance::Tax }, nil?: true
 
         # @!attribute unstructured
         #   Unstructured remittance information. Required if `category` is equal to
         #   `unstructured`.
         #
         #   @return [Increase::Models::WireTransfer::Remittance::Unstructured, nil]
-        required :unstructured, -> { Increase::WireTransfer::Remittance::Unstructured }, nil?: true
+        optional :unstructured, -> { Increase::WireTransfer::Remittance::Unstructured }, nil?: true
 
-        # @!method initialize(category:, tax:, unstructured:)
+        # @!method initialize(category:, tax: nil, unstructured: nil)
         #   Some parameter documentations has been truncated, see
         #   {Increase::Models::WireTransfer::Remittance} for more details.
         #

data/lib/increase/version.rb

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

data/rbi/increase/models/account_transfer.rbi

@@ -309,6 +309,12 @@ module Increase
             )
           end
 
+        # The type of object that created this transfer.
+        sig do
+          returns(Increase::AccountTransfer::CreatedBy::Category::TaggedSymbol)
+        end
+        attr_accessor :category
+
         # If present, details about the API key that created the transfer.
         sig { returns(T.nilable(Increase::AccountTransfer::CreatedBy::APIKey)) }
         attr_reader :api_key
@@ -321,12 +327,6 @@ module Increase
         end
         attr_writer :api_key
 
-        # The type of object that created this transfer.
-        sig do
-          returns(Increase::AccountTransfer::CreatedBy::Category::TaggedSymbol)
-        end
-        attr_accessor :category
-
         # If present, details about the OAuth Application that created the transfer.
         sig do
           returns(
@@ -359,9 +359,9 @@ module Increase
         # What object created the transfer, either via the API or the dashboard.
         sig do
           params(
+            category: Increase::AccountTransfer::CreatedBy::Category::OrSymbol,
             api_key:
               T.nilable(Increase::AccountTransfer::CreatedBy::APIKey::OrHash),
-            category: Increase::AccountTransfer::CreatedBy::Category::OrSymbol,
             oauth_application:
               T.nilable(
                 Increase::AccountTransfer::CreatedBy::OAuthApplication::OrHash
@@ -370,23 +370,23 @@ module Increase
           ).returns(T.attached_class)
         end
         def self.new(
-          # If present, details about the API key that created the transfer.
-          api_key:,
           # The type of object that created this transfer.
           category:,
+          # If present, details about the API key that created the transfer.
+          api_key: nil,
           # If present, details about the OAuth Application that created the transfer.
-          oauth_application:,
+          oauth_application: nil,
           # If present, details about the User that created the transfer.
-          user:
+          user: nil
         )
         end
 
         sig do
           override.returns(
             {
-              api_key: T.nilable(Increase::AccountTransfer::CreatedBy::APIKey),
               category:
                 Increase::AccountTransfer::CreatedBy::Category::TaggedSymbol,
+              api_key: T.nilable(Increase::AccountTransfer::CreatedBy::APIKey),
               oauth_application:
                 T.nilable(
                   Increase::AccountTransfer::CreatedBy::OAuthApplication
@@ -398,34 +398,6 @@ module Increase
         def to_hash
         end
 
-        class APIKey < Increase::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Increase::AccountTransfer::CreatedBy::APIKey,
-                Increase::Internal::AnyHash
-              )
-            end
-
-          # The description set for the API key when it was created.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :description
-
-          # If present, details about the API key that created the transfer.
-          sig do
-            params(description: T.nilable(String)).returns(T.attached_class)
-          end
-          def self.new(
-            # The description set for the API key when it was created.
-            description:
-          )
-          end
-
-          sig { override.returns({ description: T.nilable(String) }) }
-          def to_hash
-          end
-        end
-
         # The type of object that created this transfer.
         module Category
           extend Increase::Internal::Type::Enum
@@ -468,6 +440,34 @@ module Increase
           end
         end
 
+        class APIKey < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::AccountTransfer::CreatedBy::APIKey,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The description set for the API key when it was created.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # If present, details about the API key that created the transfer.
+          sig do
+            params(description: T.nilable(String)).returns(T.attached_class)
+          end
+          def self.new(
+            # The description set for the API key when it was created.
+            description:
+          )
+          end
+
+          sig { override.returns({ description: T.nilable(String) }) }
+          def to_hash
+          end
+        end
+
         class OAuthApplication < Increase::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/increase/models/ach_prenotification.rbi

@@ -575,7 +575,7 @@ module Increase
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF.
+          # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to "NSF."
           INSUFFICIENT_FUND =
             T.let(
               :insufficient_fund,
@@ -603,21 +603,21 @@ module Increase
               Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R16. The account at the receiving bank was frozen per the Office of Foreign Assets Control.
+          # Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry.
           ACCOUNT_FROZEN_ENTRY_RETURNED_PER_OFAC_INSTRUCTION =
             T.let(
               :account_frozen_entry_returned_per_ofac_instruction,
               Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R23. The receiving bank account refused a credit transfer.
+          # Code R23. The receiving bank refused the credit transfer.
           CREDIT_ENTRY_REFUSED_BY_RECEIVER =
             T.let(
               :credit_entry_refused_by_receiver,
               Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code.
+          # Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`.
           UNAUTHORIZED_DEBIT_TO_CONSUMER_ACCOUNT_USING_CORPORATE_SEC_CODE =
             T.let(
               :unauthorized_debit_to_consumer_account_using_corporate_sec_code,
@@ -638,7 +638,7 @@ module Increase
               Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R20. The receiving bank account does not perform transfers.
+          # Code R20. The account is not eligible for ACH, such as a savings account with transaction limits.
           NON_TRANSACTION_ACCOUNT =
             T.let(
               :non_transaction_account,
@@ -673,7 +673,7 @@ module Increase
               Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R07. The customer at the receiving institution informed their bank that they have revoked authorization for a previously authorized transfer.
+          # Code R07. The customer revoked their authorization for a previously authorized transfer.
           AUTHORIZATION_REVOKED_BY_CUSTOMER =
             T.let(
               :authorization_revoked_by_customer,
@@ -694,7 +694,7 @@ module Increase
               Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R45. The individual name field was invalid.
+          # Code R45. A rare return reason. The individual name field was invalid.
           ENR_INVALID_INDIVIDUAL_NAME =
             T.let(
               :enr_invalid_individual_name,
@@ -1002,7 +1002,7 @@ module Increase
               Increase::ACHPrenotification::PrenotificationReturn::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry.
+          # Code R33. A rare return reason. Return of a destroyed check ("XCK") entry.
           RETURN_OF_XCK_ENTRY =
             T.let(
               :return_of_xck_entry,

data/rbi/increase/models/ach_transfer.rbi

@@ -546,10 +546,10 @@ module Increase
           # over time; your application should be able to handle such additions gracefully.
           category:,
           # Unstructured `payment_related_information` passed through with the transfer.
-          freeform:,
+          freeform: nil,
           # Structured ASC X12 820 remittance advice records. Please reach out to
           # [support@increase.com](mailto:support@increase.com) for more information.
-          payment_order_remittance_advice:
+          payment_order_remittance_advice: nil
         )
         end
 
@@ -862,6 +862,12 @@ module Increase
             T.any(Increase::ACHTransfer::CreatedBy, Increase::Internal::AnyHash)
           end
 
+        # The type of object that created this transfer.
+        sig do
+          returns(Increase::ACHTransfer::CreatedBy::Category::TaggedSymbol)
+        end
+        attr_accessor :category
+
         # If present, details about the API key that created the transfer.
         sig { returns(T.nilable(Increase::ACHTransfer::CreatedBy::APIKey)) }
         attr_reader :api_key
@@ -873,12 +879,6 @@ module Increase
         end
         attr_writer :api_key
 
-        # The type of object that created this transfer.
-        sig do
-          returns(Increase::ACHTransfer::CreatedBy::Category::TaggedSymbol)
-        end
-        attr_accessor :category
-
         # If present, details about the OAuth Application that created the transfer.
         sig do
           returns(T.nilable(Increase::ACHTransfer::CreatedBy::OAuthApplication))
@@ -909,9 +909,9 @@ module Increase
         # What object created the transfer, either via the API or the dashboard.
         sig do
           params(
+            category: Increase::ACHTransfer::CreatedBy::Category::OrSymbol,
             api_key:
               T.nilable(Increase::ACHTransfer::CreatedBy::APIKey::OrHash),
-            category: Increase::ACHTransfer::CreatedBy::Category::OrSymbol,
             oauth_application:
               T.nilable(
                 Increase::ACHTransfer::CreatedBy::OAuthApplication::OrHash
@@ -920,23 +920,23 @@ module Increase
           ).returns(T.attached_class)
         end
         def self.new(
-          # If present, details about the API key that created the transfer.
-          api_key:,
           # The type of object that created this transfer.
           category:,
+          # If present, details about the API key that created the transfer.
+          api_key: nil,
           # If present, details about the OAuth Application that created the transfer.
-          oauth_application:,
+          oauth_application: nil,
           # If present, details about the User that created the transfer.
-          user:
+          user: nil
         )
         end
 
         sig do
           override.returns(
             {
-              api_key: T.nilable(Increase::ACHTransfer::CreatedBy::APIKey),
               category:
                 Increase::ACHTransfer::CreatedBy::Category::TaggedSymbol,
+              api_key: T.nilable(Increase::ACHTransfer::CreatedBy::APIKey),
               oauth_application:
                 T.nilable(Increase::ACHTransfer::CreatedBy::OAuthApplication),
               user: T.nilable(Increase::ACHTransfer::CreatedBy::User)
@@ -946,34 +946,6 @@ module Increase
         def to_hash
         end
 
-        class APIKey < Increase::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Increase::ACHTransfer::CreatedBy::APIKey,
-                Increase::Internal::AnyHash
-              )
-            end
-
-          # The description set for the API key when it was created.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :description
-
-          # If present, details about the API key that created the transfer.
-          sig do
-            params(description: T.nilable(String)).returns(T.attached_class)
-          end
-          def self.new(
-            # The description set for the API key when it was created.
-            description:
-          )
-          end
-
-          sig { override.returns({ description: T.nilable(String) }) }
-          def to_hash
-          end
-        end
-
         # The type of object that created this transfer.
         module Category
           extend Increase::Internal::Type::Enum
@@ -1014,6 +986,34 @@ module Increase
           end
         end
 
+        class APIKey < Increase::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Increase::ACHTransfer::CreatedBy::APIKey,
+                Increase::Internal::AnyHash
+              )
+            end
+
+          # The description set for the API key when it was created.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # If present, details about the API key that created the transfer.
+          sig do
+            params(description: T.nilable(String)).returns(T.attached_class)
+          end
+          def self.new(
+            # The description set for the API key when it was created.
+            description:
+          )
+          end
+
+          sig { override.returns({ description: T.nilable(String) }) }
+          def to_hash
+          end
+        end
+
         class OAuthApplication < Increase::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -1818,7 +1818,7 @@ module Increase
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to NSF.
+          # Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to "NSF."
           INSUFFICIENT_FUND =
             T.let(
               :insufficient_fund,
@@ -1846,21 +1846,21 @@ module Increase
               Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R16. The account at the receiving bank was frozen per the Office of Foreign Assets Control.
+          # Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry.
           ACCOUNT_FROZEN_ENTRY_RETURNED_PER_OFAC_INSTRUCTION =
             T.let(
               :account_frozen_entry_returned_per_ofac_instruction,
               Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R23. The receiving bank account refused a credit transfer.
+          # Code R23. The receiving bank refused the credit transfer.
           CREDIT_ENTRY_REFUSED_BY_RECEIVER =
             T.let(
               :credit_entry_refused_by_receiver,
               Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code.
+          # Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`.
           UNAUTHORIZED_DEBIT_TO_CONSUMER_ACCOUNT_USING_CORPORATE_SEC_CODE =
             T.let(
               :unauthorized_debit_to_consumer_account_using_corporate_sec_code,
@@ -1881,7 +1881,7 @@ module Increase
               Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R20. The receiving bank account does not perform transfers.
+          # Code R20. The account is not eligible for ACH, such as a savings account with transaction limits.
           NON_TRANSACTION_ACCOUNT =
             T.let(
               :non_transaction_account,
@@ -1916,7 +1916,7 @@ module Increase
               Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R07. The customer at the receiving institution informed their bank that they have revoked authorization for a previously authorized transfer.
+          # Code R07. The customer revoked their authorization for a previously authorized transfer.
           AUTHORIZATION_REVOKED_BY_CUSTOMER =
             T.let(
               :authorization_revoked_by_customer,
@@ -1937,7 +1937,7 @@ module Increase
               Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R45. The individual name field was invalid.
+          # Code R45. A rare return reason. The individual name field was invalid.
           ENR_INVALID_INDIVIDUAL_NAME =
             T.let(
               :enr_invalid_individual_name,
@@ -2245,7 +2245,7 @@ module Increase
               Increase::ACHTransfer::Return::ReturnReasonCode::TaggedSymbol
             )
 
-          # Code R33. A rare return reason. Return of a Destroyed Check ("XKC") entry.
+          # Code R33. A rare return reason. Return of a destroyed check ("XCK") entry.
           RETURN_OF_XCK_ENTRY =
             T.let(
               :return_of_xck_entry,