increase 1.363.0 → 1.365.0

data/lib/increase/resources/cards.rb

@@ -12,7 +12,10 @@ module Increase
       # @param authorization_controls [Increase::Models::CardCreateParams::AuthorizationControls]
       #   Controls that restrict how this card can be used.
       #
-      # @param billing_address [Increase::Models::CardCreateParams::BillingAddress] The card's billing address.
+      # @param billing_address [Increase::Models::CardCreateParams::BillingAddress]
+      #   The card's billing address. This is used in card authorizations to
+      #   [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+      #   If not provided, the address associated with the account's entity will be used.
       #
       # @param cardholder_name [Increase::Models::CardCreateParams::CardholderName]
       #   The name of the cardholder. Used to respond to Account Name Inquiry requests
@@ -75,7 +78,9 @@ module Increase
       #   Controls that restrict how this card can be used.
       #
       # @param billing_address [Increase::Models::CardUpdateParams::BillingAddress]
-      #   The card's updated billing address.
+      #   The card's billing address. This is used in card authorizations to
+      #   [validate the address provided by the acquirer](/documentation/address-verification-system-codes-and-overrides).
+      #   If not provided, the address associated with the account's entity will be used.
       #
       # @param description [String] The description you choose to give the card.
       #

data/lib/increase/resources/checkbook_checks.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Increase
+  module Resources
+    class CheckbookChecks
+      # Retrieve a Checkbook Check
+      #
+      # @overload retrieve(checkbook_check_id, request_options: {})
+      #
+      # @param checkbook_check_id [String] The identifier of the Checkbook Check.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CheckbookCheck]
+      #
+      # @see Increase::Models::CheckbookCheckRetrieveParams
+      def retrieve(checkbook_check_id, params = {})
+        @client.request(
+          method: :get,
+          path: ["checkbook_checks/%1$s", checkbook_check_id],
+          model: Increase::CheckbookCheck,
+          options: params[:request_options]
+        )
+      end
+
+      # List Checkbook Checks
+      #
+      # @overload list(account_number_id: nil, check_number: nil, checkbook_id: nil, cursor: nil, limit: nil, request_options: {})
+      #
+      # @param account_number_id [String] Filter Checkbook Checks to those drawn on the specified Account Number.
+      #
+      # @param check_number [Integer] Filter Checkbook Checks to the one with the specified check number.
+      #
+      # @param checkbook_id [String] Filter Checkbook Checks to those belonging to the specified Checkbook.
+      #
+      # @param cursor [String] Return the page of entries after this one.
+      #
+      # @param limit [Integer]
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   Defaults to `100`.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Internal::Page<Increase::Models::CheckbookCheck>]
+      #
+      # @see Increase::Models::CheckbookCheckListParams
+      def list(params = {})
+        parsed, options = Increase::CheckbookCheckListParams.dump_request(params)
+        query = Increase::Internal::Util.encode_query_params(parsed)
+        @client.request(
+          method: :get,
+          path: "checkbook_checks",
+          query: query,
+          page: Increase::Internal::Page,
+          model: Increase::CheckbookCheck,
+          options: options
+        )
+      end
+
+      # Stop a Checkbook Check. A stopped check cannot be deposited.
+      #
+      # @overload stop(checkbook_check_id, request_options: {})
+      #
+      # @param checkbook_check_id [String] The identifier of the Checkbook Check to stop.
+      #
+      # @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Increase::Models::CheckbookCheck]
+      #
+      # @see Increase::Models::CheckbookCheckStopParams
+      def stop(checkbook_check_id, params = {})
+        @client.request(
+          method: :post,
+          path: ["checkbook_checks/%1$s/stop", checkbook_check_id],
+          model: Increase::CheckbookCheck,
+          options: params[:request_options]
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Increase::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

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/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.363.0"
+  VERSION = "1.365.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"
@@ -317,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"
@@ -384,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"
@@ -437,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