increase 1.363.0 → 1.365.0

data/lib/increase/models/ach_transfer.rb

@@ -223,7 +223,10 @@ module Increase
       required :standard_entry_class_code, enum: -> { Increase::ACHTransfer::StandardEntryClassCode }
 
       # @!attribute statement_descriptor
-      #   The descriptor that will show on the recipient's bank statement.
+      #   A description you chose to give the transfer. If `individual_name` and
+      #   `company_name` were not explicitly set, the `statement_descriptor` will be sent
+      #   in those fields to the receiving bank to help the customer recognize the
+      #   transfer.
       #
       #   @return [String, nil]
       required :statement_descriptor, String, nil?: true
@@ -379,7 +382,11 @@ module Increase
       #     [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes)
       #     to use for the transfer.
       #
-      #   @param statement_descriptor [String, nil] The descriptor that will show on the recipient's bank statement.
+      #   @param statement_descriptor [String, nil]
+      #     A description you chose to give the transfer. If `individual_name` and
+      #     `company_name` were not explicitly set, the `statement_descriptor` will be sent
+      #     in those fields to the receiving bank to help the customer recognize the
+      #     transfer.
       #
       #   @param status [Symbol, Increase::Models::ACHTransfer::Status] The lifecycle status of the transfer.
       #

data/lib/increase/models/ach_transfer_create_params.rb

@@ -26,16 +26,25 @@ module Increase
       #   @return [Integer]
       required :amount, Integer
 
-      # @!attribute statement_descriptor
-      #   A description you choose to give the transfer. This will be saved with the
-      #   transfer details, displayed in the dashboard, and returned by the API. If
-      #   `individual_name` and `company_name` are not explicitly set by this API, the
-      #   `statement_descriptor` will be sent in those fields to the receiving bank to
-      #   help the customer recognize the transfer. You are highly encouraged to pass
-      #   `individual_name` and `company_name` instead of relying on this fallback.
+      # @!attribute company_name
+      #   The name by which the recipient knows the counterparty of this transaction. If
+      #   you're processing payments on behalf of another party, use their name, not your
+      #   own, so that it's more likely the recipient understands the context of the
+      #   payment. This value is usually displayed to the recipient on their bank
+      #   statement. We recommend setting this on every transfer; if you do not, we fall
+      #   back to the `statement_descriptor`.
+      #
+      #   @return [String]
+      required :company_name, String
+
+      # @!attribute individual_name
+      #   The name of the transfer recipient. This value is informational and generally
+      #   not verified by the recipient's bank. This value is usually displayed to the
+      #   recipient on their bank statement. We recommend setting this on every transfer;
+      #   if you do not, we fall back to the `statement_descriptor`.
       #
       #   @return [String]
-      required :statement_descriptor, String
+      required :individual_name, String
 
       # @!attribute account_number
       #   The receiver's account number. For credit transfers (transfers with a positive
@@ -83,17 +92,6 @@ module Increase
       #   @return [String, nil]
       optional :company_entry_description, String
 
-      # @!attribute company_name
-      #   The name by which the recipient knows the counterparty of this transaction. If
-      #   you're processing payments on behalf of another party, use their name, not your
-      #   own, so that it's more likely the recipient understands the context of the
-      #   payment. This value is usually displayed to the recipient on their bank
-      #   statement. We recommend setting this on every transfer; if you do not, we fall
-      #   back to the `statement_descriptor`.
-      #
-      #   @return [String, nil]
-      optional :company_name, String
-
       # @!attribute destination_account_holder
       #   The type of entity that owns the receiver's account.
       #
@@ -125,15 +123,6 @@ module Increase
       #   @return [String, nil]
       optional :individual_id, String
 
-      # @!attribute individual_name
-      #   The name of the transfer recipient. This value is informational and generally
-      #   not verified by the recipient's bank. This value is usually displayed to the
-      #   recipient on their bank statement. We recommend setting this on every transfer;
-      #   if you do not, we fall back to the `statement_descriptor`.
-      #
-      #   @return [String, nil]
-      optional :individual_name, String
-
       # @!attribute preferred_effective_date
       #   Configuration for how the effective date of the transfer will be set. This
       #   determines same-day vs future-dated settlement timing. If not set, defaults to a
@@ -166,7 +155,7 @@ module Increase
       optional :standard_entry_class_code,
                enum: -> { Increase::ACHTransferCreateParams::StandardEntryClassCode }
 
-      # @!method initialize(account_id:, amount:, statement_descriptor:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, company_name: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, individual_name: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
+      # @!method initialize(account_id:, amount:, company_name:, individual_name:, account_number: nil, addenda: nil, company_descriptive_date: nil, company_discretionary_data: nil, company_entry_description: nil, destination_account_holder: nil, external_account_id: nil, funding: nil, individual_id: nil, preferred_effective_date: nil, require_approval: nil, routing_number: nil, standard_entry_class_code: nil, request_options: {})
       #   @param account_id [String]
       #     The Increase identifier for the account that will originate the transfer. For
       #     credit transfers (transfers with a positive `amount`), this is the account that
@@ -180,13 +169,19 @@ module Increase
       #     into Increase. Debit transfers
       #     [might result in a hold before funds are available](/documentation/sending-ach-debit-transfers).
       #
-      #   @param statement_descriptor [String]
-      #     A description you choose to give the transfer. This will be saved with the
-      #     transfer details, displayed in the dashboard, and returned by the API. If
-      #     `individual_name` and `company_name` are not explicitly set by this API, the
-      #     `statement_descriptor` will be sent in those fields to the receiving bank to
-      #     help the customer recognize the transfer. You are highly encouraged to pass
-      #     `individual_name` and `company_name` instead of relying on this fallback.
+      #   @param company_name [String]
+      #     The name by which the recipient knows the counterparty of this transaction. If
+      #     you're processing payments on behalf of another party, use their name, not your
+      #     own, so that it's more likely the recipient understands the context of the
+      #     payment. This value is usually displayed to the recipient on their bank
+      #     statement. We recommend setting this on every transfer; if you do not, we fall
+      #     back to the `statement_descriptor`.
+      #
+      #   @param individual_name [String]
+      #     The name of the transfer recipient. This value is informational and generally
+      #     not verified by the recipient's bank. This value is usually displayed to the
+      #     recipient on their bank statement. We recommend setting this on every transfer;
+      #     if you do not, we fall back to the `statement_descriptor`.
       #
       #   @param account_number [String]
       #     The receiver's account number. For credit transfers (transfers with a positive
@@ -219,14 +214,6 @@ module Increase
       #     code and use case. For example, some use cases require constants like
       #     `ACCTVERIFY`, `PURCHASE`, `PAYROLL`, or `REVERSAL`.
       #
-      #   @param company_name [String]
-      #     The name by which the recipient knows the counterparty of this transaction. If
-      #     you're processing payments on behalf of another party, use their name, not your
-      #     own, so that it's more likely the recipient understands the context of the
-      #     payment. This value is usually displayed to the recipient on their bank
-      #     statement. We recommend setting this on every transfer; if you do not, we fall
-      #     back to the `statement_descriptor`.
-      #
       #   @param destination_account_holder [Symbol, Increase::Models::ACHTransferCreateParams::DestinationAccountHolder]
       #     The type of entity that owns the receiver's account.
       #
@@ -245,12 +232,6 @@ module Increase
       #     unset. For the specific case of person-to-person credits with the WEB standard
       #     entry class code, this must include the name of the payer.
       #
-      #   @param individual_name [String]
-      #     The name of the transfer recipient. This value is informational and generally
-      #     not verified by the recipient's bank. This value is usually displayed to the
-      #     recipient on their bank statement. We recommend setting this on every transfer;
-      #     if you do not, we fall back to the `statement_descriptor`.
-      #
       #   @param preferred_effective_date [Increase::Models::ACHTransferCreateParams::PreferredEffectiveDate]
       #     Configuration for how the effective date of the transfer will be set. This
       #     determines same-day vs future-dated settlement timing. If not set, defaults to a

data/lib/increase/models/card_create_params.rb

@@ -20,7 +20,9 @@ module Increase
       optional :authorization_controls, -> { Increase::CardCreateParams::AuthorizationControls }
 
       # @!attribute billing_address
-      #   The card's 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.
       #
       #   @return [Increase::Models::CardCreateParams::BillingAddress, nil]
       optional :billing_address, -> { Increase::CardCreateParams::BillingAddress }
@@ -68,7 +70,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
@@ -528,7 +533,9 @@ module Increase
         optional :line2, String
 
         # @!method initialize(city:, line1:, postal_code:, state:, line2: nil)
-        #   The card's 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 city [String] The city of the billing address.
         #

data/lib/increase/models/card_payment.rb

@@ -10120,6 +10120,9 @@ module Increase
                 # Electric vehicle charging level 3 480 volt
                 ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
 
+                # Diesel 1 off-road non-taxable
+                DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
+
                 # Renewable diesel R95 or greater off-road non-taxable
                 RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
                   :renewable_diesel_r95_or_greater_off_road_non_taxable
@@ -12859,6 +12862,9 @@ module Increase
                 # Electric vehicle charging level 3 480 volt
                 ELECTRIC_VEHICLE_CHARGING_LEVEL_3_480_VOLT = :electric_vehicle_charging_level_3_480_volt
 
+                # Diesel 1 off-road non-taxable
+                DIESEL_1_OFF_ROAD_NON_TAXABLE = :diesel_1_off_road_non_taxable
+
                 # Renewable diesel R95 or greater off-road non-taxable
                 RENEWABLE_DIESEL_R95_OR_GREATER_OFF_ROAD_NON_TAXABLE =
                   :renewable_diesel_r95_or_greater_off_road_non_taxable

data/lib/increase/models/card_update_params.rb

@@ -20,7 +20,9 @@ module Increase
       optional :authorization_controls, -> { Increase::CardUpdateParams::AuthorizationControls }
 
       # @!attribute billing_address
-      #   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.
       #
       #   @return [Increase::Models::CardUpdateParams::BillingAddress, nil]
       optional :billing_address, -> { Increase::CardUpdateParams::BillingAddress }
@@ -59,7 +61,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.
       #
@@ -511,7 +515,9 @@ module Increase
         optional :line2, String
 
         # @!method initialize(city:, line1:, postal_code:, state:, line2: nil)
-        #   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 city [String] The city of the billing address.
         #
@@ -533,18 +539,20 @@ module Increase
 
         # @!attribute email
         #   An email address that can be used to verify the cardholder via one-time passcode
-        #   over email.
+        #   over email. Send `null` to clear the email address. Omit this field to leave it
+        #   unchanged.
         #
         #   @return [String, nil]
-        optional :email, String
+        optional :email, String, nil?: true
 
         # @!attribute phone
         #   A phone number that can be used to verify the cardholder via one-time passcode
         #   over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
-        #   `(415) 555-0123`.
+        #   `(415) 555-0123`. Send `null` to clear the phone number. Omit this field to
+        #   leave it unchanged.
         #
         #   @return [String, nil]
-        optional :phone, String
+        optional :phone, String, nil?: true
 
         # @!method initialize(digital_card_profile_id: nil, email: nil, phone: nil)
         #   The contact information used in the two-factor steps for digital wallet card
@@ -553,14 +561,16 @@ module Increase
         #
         #   @param digital_card_profile_id [String] The digital card profile assigned to this digital card.
         #
-        #   @param email [String]
+        #   @param email [String, nil]
         #     An email address that can be used to verify the cardholder via one-time passcode
-        #     over email.
+        #     over email. Send `null` to clear the email address. Omit this field to leave it
+        #     unchanged.
         #
-        #   @param phone [String]
+        #   @param phone [String, nil]
         #     A phone number that can be used to verify the cardholder via one-time passcode
         #     over SMS. Accepts formats like `+14155550123`, `4155550123`, `415-555-0123`, or
-        #     `(415) 555-0123`.
+        #     `(415) 555-0123`. Send `null` to clear the phone number. Omit this field to
+        #     leave it unchanged.
       end
 
       # The status to update the Card with.

data/lib/increase/models/checkbook.rb

@@ -0,0 +1,352 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Checkbooks#create
+    class Checkbook < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Checkbook's identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_number_id
+      #   The identifier of the Account Number the Checkbook is attached to.
+      #
+      #   @return [String]
+      required :account_number_id, String
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the Checkbook was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute idempotency_key
+      #   The idempotency key you chose for this 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]
+      required :idempotency_key, String, nil?: true
+
+      # @!attribute mailing_address
+      #   The destination address that the Checkbook will be mailed to.
+      #
+      #   @return [Increase::Models::Checkbook::MailingAddress]
+      required :mailing_address, -> { Increase::Checkbook::MailingAddress }
+
+      # @!attribute payer
+      #   The payer information printed on the top-left corner of each check.
+      #
+      #   @return [Array<Increase::Models::Checkbook::Payer>]
+      required :payer, -> { Increase::Internal::Type::ArrayOf[Increase::Checkbook::Payer] }
+
+      # @!attribute return_address
+      #   The address the Checkbook will return to if there is a delivery issue.
+      #
+      #   @return [Increase::Models::Checkbook::ReturnAddress]
+      required :return_address, -> { Increase::Checkbook::ReturnAddress }
+
+      # @!attribute status
+      #   The lifecycle status of the Checkbook.
+      #
+      #   @return [Symbol, Increase::Models::Checkbook::Status]
+      required :status, enum: -> { Increase::Checkbook::Status }
+
+      # @!attribute style
+      #   The physical format of the Checkbook.
+      #
+      #   @return [Symbol, Increase::Models::Checkbook::Style]
+      required :style, enum: -> { Increase::Checkbook::Style }
+
+      # @!attribute tracking_updates
+      #   Tracking updates relating to the Checkbook's delivery.
+      #
+      #   @return [Array<Increase::Models::Checkbook::TrackingUpdate>]
+      required :tracking_updates, -> { Increase::Internal::Type::ArrayOf[Increase::Checkbook::TrackingUpdate] }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `checkbook`.
+      #
+      #   @return [Symbol, Increase::Models::Checkbook::Type]
+      required :type, enum: -> { Increase::Checkbook::Type }
+
+      # @!method initialize(id:, account_number_id:, created_at:, idempotency_key:, mailing_address:, payer:, return_address:, status:, style:, tracking_updates:, type:)
+      #   Checkbooks are sets of blank checks that Increase prints and mails on your
+      #   behalf.
+      #
+      #   @param id [String] The Checkbook's identifier.
+      #
+      #   @param account_number_id [String] The identifier of the Account Number the Checkbook is attached to.
+      #
+      #   @param created_at [Time]
+      #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #     the Checkbook was created.
+      #
+      #   @param idempotency_key [String, nil]
+      #     The idempotency key you chose for this 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 mailing_address [Increase::Models::Checkbook::MailingAddress]
+      #     The destination address that the Checkbook will be mailed to.
+      #
+      #   @param payer [Array<Increase::Models::Checkbook::Payer>]
+      #     The payer information printed on the top-left corner of each check.
+      #
+      #   @param return_address [Increase::Models::Checkbook::ReturnAddress]
+      #     The address the Checkbook will return to if there is a delivery issue.
+      #
+      #   @param status [Symbol, Increase::Models::Checkbook::Status] The lifecycle status of the Checkbook.
+      #
+      #   @param style [Symbol, Increase::Models::Checkbook::Style] The physical format of the Checkbook.
+      #
+      #   @param tracking_updates [Array<Increase::Models::Checkbook::TrackingUpdate>]
+      #     Tracking updates relating to the Checkbook's delivery.
+      #
+      #   @param type [Symbol, Increase::Models::Checkbook::Type]
+      #     A constant representing the object's type. For this resource it will always be
+      #     `checkbook`.
+
+      # @see Increase::Models::Checkbook#mailing_address
+      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 line2
+        #   The second line of the destination address.
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!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 state of the destination address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:)
+        #   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 line2 [String, nil] The second 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 state 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
+
+      # @see Increase::Models::Checkbook#return_address
+      class ReturnAddress < Increase::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the return address.
+        #
+        #   @return [String]
+        required :city, String
+
+        # @!attribute line1
+        #   The first line of the return address.
+        #
+        #   @return [String]
+        required :line1, String
+
+        # @!attribute line2
+        #   The second line of the return address.
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute name
+        #   The recipient at the return address.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute postal_code
+        #   The postal code of the return address.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!attribute state
+        #   The state of the return address.
+        #
+        #   @return [String]
+        required :state, String
+
+        # @!method initialize(city:, line1:, line2:, name:, postal_code:, state:)
+        #   The address the Checkbook will return to if there is a delivery issue.
+        #
+        #   @param city [String] The city of the return address.
+        #
+        #   @param line1 [String] The first line of the return address.
+        #
+        #   @param line2 [String, nil] The second line of the return address.
+        #
+        #   @param name [String] The recipient at the return address.
+        #
+        #   @param postal_code [String] The postal code of the return address.
+        #
+        #   @param state [String] The state of the return address.
+      end
+
+      # The lifecycle status of the Checkbook.
+      #
+      # @see Increase::Models::Checkbook#status
+      module Status
+        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
+
+      # The physical format of the Checkbook.
+      #
+      # @see Increase::Models::Checkbook#style
+      module Style
+        extend Increase::Internal::Type::Enum
+
+        # A half-inch three-ring binder holding 75 pages of checks with 3 checks per page.
+        THREE_RING_BINDER = :three_ring_binder
+
+        # A folder holding 15 pages of checks with 3 checks per page.
+        FOLDER = :folder
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class TrackingUpdate < Increase::Internal::Type::BaseModel
+        # @!attribute category
+        #   The type of tracking event.
+        #
+        #   @return [Symbol, Increase::Models::Checkbook::TrackingUpdate::Category]
+        required :category, enum: -> { Increase::Checkbook::TrackingUpdate::Category }
+
+        # @!attribute country
+        #   The ISO 3166-1 alpha-2 country code for the country where the event took place.
+        #
+        #   @return [String]
+        required :country, String
+
+        # @!attribute created_at
+        #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #   the tracking event took place.
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute postal_code
+        #   The postal code where the event took place.
+        #
+        #   @return [String]
+        required :postal_code, String
+
+        # @!method initialize(category:, country:, created_at:, postal_code:)
+        #   @param category [Symbol, Increase::Models::Checkbook::TrackingUpdate::Category]
+        #     The type of tracking event.
+        #
+        #   @param country [String] The ISO 3166-1 alpha-2 country code for the country where the event took place.
+        #
+        #   @param created_at [Time]
+        #     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #     the tracking event took place.
+        #
+        #   @param postal_code [String] The postal code where the event took place.
+
+        # The type of tracking event.
+        #
+        # @see Increase::Models::Checkbook::TrackingUpdate#category
+        module Category
+          extend Increase::Internal::Type::Enum
+
+          # The checkbook is in transit.
+          IN_TRANSIT = :in_transit
+
+          # The checkbook has been processed for delivery.
+          PROCESSED_FOR_DELIVERY = :processed_for_delivery
+
+          # The checkbook has been delivered. Note that some couriers track delivery status based on driver location data rather than an explicit scan. While uncommon, a single checkbook may have more than one delivered event.
+          DELIVERED = :delivered
+
+          # There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the checkbook will be rerouted to the return address.
+          DELIVERY_ISSUE = :delivery_issue
+
+          # The checkbook has been rerouted to the return address.
+          RETURNING_TO_SENDER = :returning_to_sender
+
+          # The checkbook has been delivered to the return address.
+          RETURNED_TO_SENDER = :returned_to_sender
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `checkbook`.
+      #
+      # @see Increase::Models::Checkbook#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        CHECKBOOK = :checkbook
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end