increase 1.363.0 → 1.365.0

data/lib/increase/models/checkbook_check.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckbookChecks#retrieve
+    class CheckbookCheck < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Checkbook Check's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute check_number
+      #   The check number printed on the check.
+      #
+      #   @return [Integer]
+      required :check_number, Integer
+
+      # @!attribute checkbook_id
+      #   The identifier of the Checkbook the check belongs to.
+      #
+      #   @return [String]
+      required :checkbook_id, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the Checkbook Check was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute status
+      #   The status of the Checkbook Check.
+      #
+      #   @return [Symbol, Increase::Models::CheckbookCheck::Status]
+      required :status, enum: -> { Increase::CheckbookCheck::Status }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `checkbook_check`.
+      #
+      #   @return [Symbol, Increase::Models::CheckbookCheck::Type]
+      required :type, enum: -> { Increase::CheckbookCheck::Type }
+
+      # @!method initialize(id:, check_number:, checkbook_id:, created_at:, status:, type:)
+      #   A Checkbook Check is a single check within a Checkbook.
+      #
+      #   @param id [String] The Checkbook Check's identifier.
+      #
+      #   @param check_number [Integer] The check number printed on the check.
+      #
+      #   @param checkbook_id [String] The identifier of the Checkbook the check belongs to.
+      #
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the Checkbook Check was created.
+      #
+      #   @param status [Symbol, Increase::Models::CheckbookCheck::Status] The status of the Checkbook Check.
+      #
+      #   @param type [Symbol, Increase::Models::CheckbookCheck::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `checkbook_check`.
+
+      # The status of the Checkbook Check.
+      #
+      # @see Increase::Models::CheckbookCheck#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The check has not yet been deposited.
+        PENDING_DEPOSIT = :pending_deposit
+
+        # The check has been deposited.
+        DEPOSITED = :deposited
+
+        # The check has been stopped and can no longer be deposited.
+        STOPPED = :stopped
+
+        # The check requires attention from an Increase operator.
+        REQUIRES_ATTENTION = :requires_attention
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `checkbook_check`.
+      #
+      # @see Increase::Models::CheckbookCheck#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CHECKBOOK_CHECK = :checkbook_check
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/checkbook_check_list_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckbookChecks#list
+    class CheckbookCheckListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_number_id
+      #   Filter Checkbook Checks to those drawn on the specified Account Number.
+      #
+      #   @return [String, nil]
+      optional :account_number_id, String
+
+      # @!attribute check_number
+      #   Filter Checkbook Checks to the one with the specified check number.
+      #
+      #   @return [Integer, nil]
+      optional :check_number, Integer
+
+      # @!attribute checkbook_id
+      #   Filter Checkbook Checks to those belonging to the specified Checkbook.
+      #
+      #   @return [String, nil]
+      optional :checkbook_id, String
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   Defaults to `100`.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/increase/models/checkbook_check_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckbookChecks#retrieve
+    class CheckbookCheckRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute checkbook_check_id
+      #   The identifier of the Checkbook Check.
+      #
+      #   @return [String]
+      required :checkbook_check_id, String
+
+      # @!method initialize(checkbook_check_id:, request_options: {})
+      #   @param checkbook_check_id [String] The identifier of the Checkbook Check.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/checkbook_check_stop_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::CheckbookChecks#stop
+    class CheckbookCheckStopParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute checkbook_check_id
+      #   The identifier of the Checkbook Check to stop.
+      #
+      #   @return [String]
+      required :checkbook_check_id, String
+
+      # @!method initialize(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}]
+    end
+  end
+end

data/lib/increase/models/checkbook_create_params.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Checkbooks#create
+    class CheckbookCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_number_id
+      #   The identifier of the Account Number that the checks will draw from. The Account
+      #   Number must be active.
+      #
+      #   @return [String]
+      required :account_number_id, String
+
+      # @!attribute mailing_address
+      #   The destination address that the Checkbook will be mailed to.
+      #
+      #   @return [Increase::Models::CheckbookCreateParams::MailingAddress]
+      required :mailing_address, -> { Increase::CheckbookCreateParams::MailingAddress }
+
+      # @!attribute 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.
+      #
+      #   @return [Array<Increase::Models::CheckbookCreateParams::Payer>]
+      required :payer, -> { Increase::Internal::Type::ArrayOf[Increase::CheckbookCreateParams::Payer] }
+
+      # @!method initialize(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}]
+
+      class MailingAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the destination address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute line1
+        #   The first line of the destination address.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute name
+        #   The recipient at the destination address.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute postal_code
+        #   The postal code of the destination address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute state
+        #   The US state of the destination address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!attribute line2
+        #   The second line of the destination address.
+        #
+        #   @return [String, nil]
+        optional :line2, String
+
+        # @!method initialize(city:, line1:, name:, postal_code:, state:, line2: nil)
+        #   The destination address that the Checkbook will be mailed to.
+        #
+        #   @param city [String] The city of the destination address.
+        #
+        #   @param line1 [String] The first line of the destination address.
+        #
+        #   @param name [String] The recipient at the destination address.
+        #
+        #   @param postal_code [String] The postal code of the destination address.
+        #
+        #   @param state [String] The US state of the destination address.
+        #
+        #   @param line2 [String] The second line of the destination address.
+      end
+
+      class Payer < Increase::Internal::Type::BaseModel
+        # @!attribute contents
+        #   The contents of the line.
+        #
+        #   @return [String]
+        required :contents, String
+
+        # @!method initialize(contents:)
+        #   @param contents [String] The contents of the line.
+      end
+    end
+  end
+end

data/lib/increase/models/checkbook_list_params.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Checkbooks#list
+    class CheckbookListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute account_number_id
+      #   Filter Checkbooks to those attached to the specified Account Number.
+      #
+      #   @return [String, nil]
+      optional :account_number_id, String
+
+      # @!attribute cursor
+      #   Return the page of entries after this one.
+      #
+      #   @return [String, nil]
+      optional :cursor, String
+
+      # @!attribute idempotency_key
+      #   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).
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute limit
+      #   Limit the size of the list that is returned. The default (and maximum) is 100
+      #   objects.
+      #
+      #   Defaults to `100`.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::CheckbookListParams::Status, nil]
+      optional :status, -> { Increase::CheckbookListParams::Status }
+
+      # @!method initialize(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}]
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Checkbooks for those with the specified status or statuses. For GET
+        #   requests, this should be encoded as a comma-delimited string, such as
+        #   `?in=one,two,three`.
+        #
+        #   @return [Array<Symbol, Increase::Models::CheckbookListParams::Status::In>, nil]
+        optional :in_,
+                 -> { Increase::Internal::Type::ArrayOf[enum: Increase::CheckbookListParams::Status::In] },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   @param in_ [Array<Symbol, Increase::Models::CheckbookListParams::Status::In>]
+        #     Filter Checkbooks for those with the specified status or statuses. For GET
+        #     requests, this should be encoded as a comma-delimited string, such as
+        #     `?in=one,two,three`.
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The Checkbook is pending submission to the printer.
+          PENDING_SUBMISSION = :pending_submission
+
+          # The Checkbook has been submitted to the printer and is pending mailing.
+          PENDING_MAILING = :pending_mailing
+
+          # The Checkbook has been mailed.
+          MAILED = :mailed
+
+          # The Checkbook has been stopped and its checks can no longer be deposited.
+          STOPPED = :stopped
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/checkbook_retrieve_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Checkbooks#retrieve
+    class CheckbookRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute checkbook_id
+      #   The identifier of the Checkbook.
+      #
+      #   @return [String]
+      required :checkbook_id, String
+
+      # @!method initialize(checkbook_id:, request_options: {})
+      #   @param checkbook_id [String] The identifier of the Checkbook.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/checkbook_stop_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Checkbooks#stop
+    class CheckbookStopParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute checkbook_id
+      #   The identifier of the Checkbook to stop.
+      #
+      #   @return [String]
+      required :checkbook_id, String
+
+      # @!method initialize(checkbook_id:, request_options: {})
+      #   @param checkbook_id [String] The identifier of the Checkbook to stop.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/declined_transaction.rb

@@ -2166,6 +2166,12 @@ module Increase
           #   @return [String, nil]
           required :check_transfer_id, String, nil?: true
 
+          # @!attribute checkbook_check_id
+          #   The identifier of the Checkbook Check object associated with this decline.
+          #
+          #   @return [String, nil]
+          required :checkbook_check_id, String, nil?: true
+
           # @!attribute front_image_file_id
           #   The identifier of the API File object containing an image of the front of the
           #   declined check.
@@ -2185,7 +2191,7 @@ module Increase
           #   @return [Symbol, Increase::Models::DeclinedTransaction::Source::CheckDecline::Reason]
           required :reason, enum: -> { Increase::DeclinedTransaction::Source::CheckDecline::Reason }
 
-          # @!method initialize(amount:, auxiliary_on_us:, back_image_file_id:, check_transfer_id:, front_image_file_id:, inbound_check_deposit_id:, reason:)
+          # @!method initialize(amount:, auxiliary_on_us:, back_image_file_id:, check_transfer_id:, checkbook_check_id:, front_image_file_id:, inbound_check_deposit_id:, reason:)
           #   A Check Decline object. This field will be present in the JSON response if and
           #   only if `category` is equal to `check_decline`.
           #
@@ -2203,6 +2209,9 @@ module Increase
           #   @param check_transfer_id [String, nil]
           #     The identifier of the Check Transfer object associated with this decline.
           #
+          #   @param checkbook_check_id [String, nil]
+          #     The identifier of the Checkbook Check object associated with this decline.
+          #
           #   @param front_image_file_id [String, nil]
           #     The identifier of the API File object containing an image of the front of the
           #     declined check.

data/lib/increase/models/entity.rb

@@ -31,12 +31,6 @@ module Increase
       #   @return [String, nil]
       required :creating_entity_onboarding_session_id, String, nil?: true
 
-      # @!attribute description
-      #   The entity's description for display purposes.
-      #
-      #   @return [String, nil]
-      required :description, String, nil?: true
-
       # @!attribute details_confirmed_at
       #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
       #   Entity's details were most recently confirmed.
@@ -72,13 +66,6 @@ module Increase
       #   @return [Increase::Models::Entity::NaturalPerson, nil]
       required :natural_person, -> { Increase::Entity::NaturalPerson }, nil?: true
 
-      # @!attribute risk_rating
-      #   An assessment of the entity’s potential risk of involvement in financial crimes,
-      #   such as money laundering.
-      #
-      #   @return [Increase::Models::Entity::RiskRating, nil]
-      required :risk_rating, -> { Increase::Entity::RiskRating }, nil?: true
-
       # @!attribute sole_proprietorship
       #   Details of the sole proprietorship entity. Will be present if `structure` is
       #   equal to `sole_proprietorship`.
@@ -142,7 +129,7 @@ module Increase
       #   @return [Increase::Models::Entity::Validation, nil]
       required :validation, -> { Increase::Entity::Validation }, nil?: true
 
-      # @!method initialize(id:, corporation:, created_at:, creating_entity_onboarding_session_id:, description:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, risk_rating:, sole_proprietorship:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:, validation:)
+      # @!method initialize(id:, corporation:, created_at:, creating_entity_onboarding_session_id:, details_confirmed_at:, government_authority:, idempotency_key:, joint:, natural_person:, sole_proprietorship:, status:, structure:, supplemental_documents:, terms_agreements:, third_party_verification:, trust:, type:, validation:)
       #   Entities are the legal entities that own accounts. They can be people,
       #   corporations, joint accounts, trusts, or government authorities. To learn more,
       #   see [Entities](/documentation/entities).
@@ -161,8 +148,6 @@ module Increase
       #     The identifier of the Entity Onboarding Session that was used to create this
       #     Entity, if any.
       #
-      #   @param description [String, nil] The entity's description for display purposes.
-      #
       #   @param details_confirmed_at [Time, nil]
       #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
       #     Entity's details were most recently confirmed.
@@ -183,10 +168,6 @@ module Increase
       #     Details of the natural person entity. Will be present if `structure` is equal to
       #     `natural_person`.
       #
-      #   @param risk_rating [Increase::Models::Entity::RiskRating, nil]
-      #     An assessment of the entity’s potential risk of involvement in financial crimes,
-      #     such as money laundering.
-      #
       #   @param sole_proprietorship [Increase::Models::Entity::SoleProprietorship, nil]
       #     Details of the sole proprietorship entity. Will be present if `structure` is
       #     equal to `sole_proprietorship`.
@@ -1129,51 +1110,6 @@ module Increase
         end
       end
 
-      # @see Increase::Models::Entity#risk_rating
-      class RiskRating < Increase::Internal::Type::BaseModel
-        # @!attribute rated_at
-        #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-        #   rating was performed.
-        #
-        #   @return [Time]
-        required :rated_at, Time
-
-        # @!attribute rating
-        #   The rating given to this entity.
-        #
-        #   @return [Symbol, Increase::Models::Entity::RiskRating::Rating]
-        required :rating, enum: -> { Increase::Entity::RiskRating::Rating }
-
-        # @!method initialize(rated_at:, rating:)
-        #   An assessment of the entity’s potential risk of involvement in financial crimes,
-        #   such as money laundering.
-        #
-        #   @param rated_at [Time]
-        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk
-        #     rating was performed.
-        #
-        #   @param rating [Symbol, Increase::Models::Entity::RiskRating::Rating] The rating given to this entity.
-
-        # The rating given to this entity.
-        #
-        # @see Increase::Models::Entity::RiskRating#rating
-        module Rating
-          extend Increase::Internal::Type::Enum
-
-          # Minimal risk of involvement in financial crime.
-          LOW = :low
-
-          # Moderate risk of involvement in financial crime.
-          MEDIUM = :medium
-
-          # Elevated risk of involvement in financial crime.
-          HIGH = :high
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
-
       # @see Increase::Models::Entity#sole_proprietorship
       class SoleProprietorship < Increase::Internal::Type::BaseModel
         # @!attribute address