increase 1.363.0 → 1.364.0

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

@@ -533,18 +533,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 +555,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

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