increase 1.362.0 → 1.364.0

data/lib/increase/resources/checkbooks.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Checkbooks
+      # Create a Checkbook
+      #
+      # @overload create(account_number_id:, mailing_address:, payer:, request_options: {})
+      #
+      # @param account_number_id [String]
+      #   The identifier of the Account Number that the checks will draw from. The Account
+      #   Number must be active.
+      #
+      # @param mailing_address [Increase::Models::CheckbookCreateParams::MailingAddress]
+      #   The destination address that the Checkbook will be mailed to.
+      #
+      # @param payer [Array<Increase::Models::CheckbookCreateParams::Payer>]
+      #   The payer of the checks. This will be printed on the top-left corner of each
+      #   check. This should be an array of up to 4 elements, each of which represents a
+      #   line of the payer.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::Checkbook]
+      #
+      # @see Increase::Models::CheckbookCreateParams
+      def create(params)
+        parsed, options = Increase::CheckbookCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "checkbooks",
+          body: parsed,
+          model: Increase::Checkbook,
+          options: options
+        )
+      end
+
+      # Retrieve a Checkbook
+      #
+      # @overload retrieve(checkbook_id, request_options: {})
+      #
+      # @param checkbook_id [String] The identifier of the Checkbook.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::Checkbook]
+      #
+      # @see Increase::Models::CheckbookRetrieveParams
+      def retrieve(checkbook_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["checkbooks/%1$s", checkbook_id],
+          model: Increase::Checkbook,
+          options: params[:request_options]
+        )
+      end
+
+      # List Checkbooks
+      #
+      # @overload list(account_number_id: nil, cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #
+      # @param account_number_id [String] Filter Checkbooks to those attached to the specified Account Number.
+      #
+      # @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
+      #   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
+      #   objects.
+      #
+      #   Defaults to `100`.
+      #
+      # @param status [Increase::Models::CheckbookListParams::Status]
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::Checkbook>]
+      #
+      # @see Increase::Models::CheckbookListParams
+      def list(params = {})
+        parsed, options = Increase::CheckbookListParams.dump_request(params)
+        query = Increase::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "checkbooks",
+          query: query,
+          page: Increase::Internal::Page,
+          model: Increase::Checkbook,
+          options: options
+        )
+      end
+
+      # Stop a Checkbook. Stopping a Checkbook stops all of its checks that have not yet
+      # been deposited.
+      #
+      # @overload stop(checkbook_id, request_options: {})
+      #
+      # @param checkbook_id [String] The identifier of the Checkbook to stop.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::Checkbook]
+      #
+      # @see Increase::Models::CheckbookStopParams
+      def stop(checkbook_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["checkbooks/%1$s/stop", checkbook_id],
+          model: Increase::Checkbook,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/increase/resources/entities.rb

@@ -5,7 +5,7 @@ module Increase
     class Entities
       # Create an Entity
       #
-      # @overload create(structure:, corporation: nil, description: nil, government_authority: nil, joint: nil, natural_person: nil, risk_rating: nil, sole_proprietorship: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
+      # @overload create(structure:, corporation: nil, government_authority: nil, joint: nil, natural_person: nil, sole_proprietorship: nil, supplemental_documents: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
       #
       # @param structure [Symbol, Increase::Models::EntityCreateParams::Structure] The type of Entity to create.
       #
@@ -13,8 +13,6 @@ module Increase
       #   Details of the corporation entity to create. Required if `structure` is equal to
       #   `corporation`.
       #
-      # @param description [String] The description you choose to give the entity.
-      #
       # @param government_authority [Increase::Models::EntityCreateParams::GovernmentAuthority]
       #   Details of the Government Authority entity to create. Required if `structure` is
       #   equal to `government_authority`.
@@ -29,10 +27,6 @@ module Increase
       #   `social_security_number` or `individual_taxpayer_identification_number`
       #   identification methods.
       #
-      # @param risk_rating [Increase::Models::EntityCreateParams::RiskRating]
-      #   An assessment of the entity's potential risk of involvement in financial crimes,
-      #   such as money laundering.
-      #
       # @param sole_proprietorship [Increase::Models::EntityCreateParams::SoleProprietorship]
       #   Details of the sole proprietorship entity to create. Required if `structure` is
       #   equal to `sole_proprietorship`.
@@ -91,7 +85,7 @@ module Increase
 
       # Update an Entity
       #
-      # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, risk_rating: nil, sole_proprietorship: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
+      # @overload update(entity_id, corporation: nil, details_confirmed_at: nil, government_authority: nil, natural_person: nil, sole_proprietorship: nil, terms_agreements: nil, third_party_verification: nil, trust: nil, request_options: {})
       #
       # @param entity_id [String] The entity identifier.
       #
@@ -112,10 +106,6 @@ module Increase
       #   Details of the natural person entity to update. If you specify this parameter
       #   and the entity is not a natural person, the request will fail.
       #
-      # @param risk_rating [Increase::Models::EntityUpdateParams::RiskRating]
-      #   An assessment of the entity’s potential risk of involvement in financial crimes,
-      #   such as money laundering.
-      #
       # @param sole_proprietorship [Increase::Models::EntityUpdateParams::SoleProprietorship]
       #   Details of the sole proprietorship entity to update. If you specify this
       #   parameter and the entity is not a sole proprietorship, the request will fail.

data/lib/increase/resources/inbound_real_time_payments_transfers.rb

@@ -64,6 +64,34 @@ module Increase
         )
       end
 
+      # Return an Inbound Real-Time Payments Transfer
+      #
+      # @overload return_(inbound_real_time_payments_transfer_id, amount: nil, request_options: {})
+      #
+      # @param inbound_real_time_payments_transfer_id [String]
+      #   The identifier of the Inbound Real-Time Payments Transfer to return to its
+      #   sender.
+      #
+      # @param amount [Integer]
+      #   The amount to return, in USD cents. Defaults to the full amount of the Inbound
+      #   Real-Time Payments Transfer, and can't be higher than it.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::RealTimePaymentsTransfer]
+      #
+      # @see Increase::Models::InboundRealTimePaymentsTransferReturnParams
+      def return_(inbound_real_time_payments_transfer_id, params = {})
+        parsed, options = Increase::InboundRealTimePaymentsTransferReturnParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["inbound_real_time_payments_transfers/%1$s/return", inbound_real_time_payments_transfer_id],
+          body: parsed,
+          model: Increase::RealTimePaymentsTransfer,
+          options: options
+        )
+      end
+
       # @api private
       #
       # @param client [Increase::Client]

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class Simulations
+      class Checkbooks
+        # Simulates the mailing of a [Checkbook](#checkbooks), which happens periodically
+        # throughout the day in production but can be sped up in sandbox. This Checkbook
+        # must have a `status` of `pending_submission` or `pending_mailing`.
+        #
+        # @overload mail(checkbook_id, request_options: {})
+        #
+        # @param checkbook_id [String] The identifier of the Checkbook you wish to mail.
+        #
+        # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [Increase::Models::Checkbook]
+        #
+        # @see Increase::Models::Simulations::CheckbookMailParams
+        def mail(checkbook_id, params = {})
+          @client.request(
+            method: :post,
+            path: ["simulations/checkbooks/%1$s/mail", checkbook_id],
+            model: Increase::Checkbook,
+            options: params[:request_options]
+          )
+        end
+
+        # @api private
+        #
+        # @param client [Increase::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

data/lib/increase/resources/simulations.rb

@@ -72,6 +72,9 @@ module Increase
       # @return [Increase::Resources::Simulations::CheckTransfers]
       attr_reader :check_transfers
 
+      # @return [Increase::Resources::Simulations::Checkbooks]
+      attr_reader :checkbooks
+
       # @return [Increase::Resources::Simulations::InboundCheckDeposits]
       attr_reader :inbound_check_deposits
 
@@ -143,6 +146,7 @@ module Increase
         @inbound_wire_drawdown_requests =
           Increase::Resources::Simulations::InboundWireDrawdownRequests.new(client: client)
         @check_transfers = Increase::Resources::Simulations::CheckTransfers.new(client: client)
+        @checkbooks = Increase::Resources::Simulations::Checkbooks.new(client: client)
         @inbound_check_deposits = Increase::Resources::Simulations::InboundCheckDeposits.new(client: client)
         @real_time_payments_transfers =
           Increase::Resources::Simulations::RealTimePaymentsTransfers.new(client: client)

data/lib/increase/version.rb

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

data/lib/increase.rb

@@ -131,6 +131,15 @@ require_relative "increase/models/card_validation"
 require_relative "increase/models/card_validation_create_params"
 require_relative "increase/models/card_validation_list_params"
 require_relative "increase/models/card_validation_retrieve_params"
+require_relative "increase/models/checkbook"
+require_relative "increase/models/checkbook_check"
+require_relative "increase/models/checkbook_check_list_params"
+require_relative "increase/models/checkbook_check_retrieve_params"
+require_relative "increase/models/checkbook_check_stop_params"
+require_relative "increase/models/checkbook_create_params"
+require_relative "increase/models/checkbook_list_params"
+require_relative "increase/models/checkbook_retrieve_params"
+require_relative "increase/models/checkbook_stop_params"
 require_relative "increase/models/check_deposit"
 require_relative "increase/models/check_deposit_create_params"
 require_relative "increase/models/check_deposit_list_params"
@@ -202,8 +211,6 @@ require_relative "increase/models/file_link"
 require_relative "increase/models/file_link_create_params"
 require_relative "increase/models/file_list_params"
 require_relative "increase/models/file_retrieve_params"
-require_relative "increase/models/group"
-require_relative "increase/models/group_retrieve_params"
 require_relative "increase/models/inbound_ach_transfer"
 require_relative "increase/models/inbound_ach_transfer_create_notification_of_change_params"
 require_relative "increase/models/inbound_ach_transfer_decline_params"
@@ -228,6 +235,7 @@ require_relative "increase/models/inbound_real_time_payments_requests_for_paymen
 require_relative "increase/models/inbound_real_time_payments_transfer"
 require_relative "increase/models/inbound_real_time_payments_transfer_list_params"
 require_relative "increase/models/inbound_real_time_payments_transfer_retrieve_params"
+require_relative "increase/models/inbound_real_time_payments_transfer_return_params"
 require_relative "increase/models/inbound_wire_drawdown_request"
 require_relative "increase/models/inbound_wire_drawdown_request_list_params"
 require_relative "increase/models/inbound_wire_drawdown_request_retrieve_params"
@@ -257,14 +265,6 @@ require_relative "increase/models/lockbox_recipient_create_params"
 require_relative "increase/models/lockbox_recipient_list_params"
 require_relative "increase/models/lockbox_recipient_retrieve_params"
 require_relative "increase/models/lockbox_recipient_update_params"
-require_relative "increase/models/oauth_application"
-require_relative "increase/models/oauth_application_list_params"
-require_relative "increase/models/oauth_application_retrieve_params"
-require_relative "increase/models/oauth_connection"
-require_relative "increase/models/oauth_connection_list_params"
-require_relative "increase/models/oauth_connection_retrieve_params"
-require_relative "increase/models/oauth_token"
-require_relative "increase/models/oauth_token_create_params"
 require_relative "increase/models/pending_transaction"
 require_relative "increase/models/pending_transaction_create_params"
 require_relative "increase/models/pending_transaction_list_params"
@@ -326,6 +326,7 @@ require_relative "increase/models/simulations/card_refund_create_params"
 require_relative "increase/models/simulations/card_reversal_create_params"
 require_relative "increase/models/simulations/card_settlement_create_params"
 require_relative "increase/models/simulations/card_token_create_params"
+require_relative "increase/models/simulations/checkbook_mail_params"
 require_relative "increase/models/simulations/check_deposit_adjustment_params"
 require_relative "increase/models/simulations/check_deposit_reject_params"
 require_relative "increase/models/simulations/check_deposit_return_params"
@@ -393,6 +394,8 @@ require_relative "increase/resources/card_push_transfers"
 require_relative "increase/resources/cards"
 require_relative "increase/resources/card_tokens"
 require_relative "increase/resources/card_validations"
+require_relative "increase/resources/checkbook_checks"
+require_relative "increase/resources/checkbooks"
 require_relative "increase/resources/check_deposits"
 require_relative "increase/resources/check_transfers"
 require_relative "increase/resources/declined_transactions"
@@ -408,7 +411,6 @@ require_relative "increase/resources/external_accounts"
 require_relative "increase/resources/fednow_transfers"
 require_relative "increase/resources/file_links"
 require_relative "increase/resources/files"
-require_relative "increase/resources/groups"
 require_relative "increase/resources/inbound_ach_transfers"
 require_relative "increase/resources/inbound_check_deposits"
 require_relative "increase/resources/inbound_fednow_transfers"
@@ -422,9 +424,6 @@ require_relative "increase/resources/intrafi_balances"
 require_relative "increase/resources/intrafi_exclusions"
 require_relative "increase/resources/lockbox_addresses"
 require_relative "increase/resources/lockbox_recipients"
-require_relative "increase/resources/oauth_applications"
-require_relative "increase/resources/oauth_connections"
-require_relative "increase/resources/oauth_tokens"
 require_relative "increase/resources/pending_transactions"
 require_relative "increase/resources/physical_card_profiles"
 require_relative "increase/resources/physical_cards"
@@ -450,6 +449,7 @@ require_relative "increase/resources/simulations/card_refunds"
 require_relative "increase/resources/simulations/card_reversals"
 require_relative "increase/resources/simulations/card_settlements"
 require_relative "increase/resources/simulations/card_tokens"
+require_relative "increase/resources/simulations/checkbooks"
 require_relative "increase/resources/simulations/check_deposits"
 require_relative "increase/resources/simulations/check_transfers"
 require_relative "increase/resources/simulations/digital_wallet_token_requests"

data/rbi/increase/client.rbi

@@ -94,6 +94,12 @@ module Increase
     sig { returns(Increase::Resources::CheckTransfers) }
     attr_reader :check_transfers
 
+    sig { returns(Increase::Resources::Checkbooks) }
+    attr_reader :checkbooks
+
+    sig { returns(Increase::Resources::CheckbookChecks) }
+    attr_reader :checkbook_checks
+
     sig { returns(Increase::Resources::InboundCheckDeposits) }
     attr_reader :inbound_check_deposits
 
@@ -174,18 +180,6 @@ module Increase
     sig { returns(Increase::Resources::RealTimeDecisions) }
     attr_reader :real_time_decisions
 
-    sig { returns(Increase::Resources::Groups) }
-    attr_reader :groups
-
-    sig { returns(Increase::Resources::OAuthApplications) }
-    attr_reader :oauth_applications
-
-    sig { returns(Increase::Resources::OAuthConnections) }
-    attr_reader :oauth_connections
-
-    sig { returns(Increase::Resources::OAuthTokens) }
-    attr_reader :oauth_tokens
-
     sig { returns(Increase::Resources::IntrafiAccountEnrollments) }
     attr_reader :intrafi_account_enrollments