increase 0.3.2 → 1.0.0

data/lib/increase/models/digital_card_profile_list_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalCardProfiles#list
+    class DigitalCardProfileListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!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.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute status
+      #
+      #   @return [Increase::Models::DigitalCardProfileListParams::Status, nil]
+      optional :status, -> { Increase::DigitalCardProfileListParams::Status }
+
+      # @!method initialize(cursor: nil, idempotency_key: nil, limit: nil, status: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::DigitalCardProfileListParams} for more details.
+      #
+      #   @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 tha
+      #
+      #   @param limit [Integer] Limit the size of the list that is returned. The default (and maximum) is 100 ob
+      #
+      #   @param status [Increase::Models::DigitalCardProfileListParams::Status]
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class Status < Increase::Internal::Type::BaseModel
+        # @!attribute in_
+        #   Filter Digital Card Profiles for those with the specified digital wallet 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::DigitalCardProfileListParams::Status::In>, nil]
+        optional :in_,
+                 -> {
+                   Increase::Internal::Type::ArrayOf[enum: Increase::DigitalCardProfileListParams::Status::In]
+                 },
+                 api_name: :in
+
+        # @!method initialize(in_: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::DigitalCardProfileListParams::Status} for more details.
+        #
+        #   @param in_ [Array<Symbol, Increase::Models::DigitalCardProfileListParams::Status::In>] Filter Digital Card Profiles for those with the specified digital wallet status
+
+        module In
+          extend Increase::Internal::Type::Enum
+
+          # The Card Profile is awaiting review from Increase and/or processing by card networks.
+          PENDING = :pending
+
+          # There is an issue with the Card Profile preventing it from use.
+          REJECTED = :rejected
+
+          # The Card Profile can be assigned to Cards.
+          ACTIVE = :active
+
+          # The Card Profile is no longer in use.
+          ARCHIVED = :archived
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/digital_card_profile_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalCardProfiles#retrieve
+    class DigitalCardProfileRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/digital_wallet_token.rb

@@ -0,0 +1,281 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalWalletTokens#retrieve
+    class DigitalWalletToken < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Digital Wallet Token identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute card_id
+      #   The identifier for the Card this Digital Wallet Token belongs to.
+      #
+      #   @return [String]
+      required :card_id, String
+
+      # @!attribute cardholder
+      #   The cardholder information given when the Digital Wallet Token was created.
+      #
+      #   @return [Increase::Models::DigitalWalletToken::Cardholder]
+      required :cardholder, -> { Increase::DigitalWalletToken::Cardholder }
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+      #   the Digital Wallet Token was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute device
+      #   The device that was used to create the Digital Wallet Token.
+      #
+      #   @return [Increase::Models::DigitalWalletToken::Device]
+      required :device, -> { Increase::DigitalWalletToken::Device }
+
+      # @!attribute status
+      #   This indicates if payments can be made with the Digital Wallet Token.
+      #
+      #   @return [Symbol, Increase::Models::DigitalWalletToken::Status]
+      required :status, enum: -> { Increase::DigitalWalletToken::Status }
+
+      # @!attribute token_requestor
+      #   The digital wallet app being used.
+      #
+      #   @return [Symbol, Increase::Models::DigitalWalletToken::TokenRequestor]
+      required :token_requestor, enum: -> { Increase::DigitalWalletToken::TokenRequestor }
+
+      # @!attribute type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `digital_wallet_token`.
+      #
+      #   @return [Symbol, Increase::Models::DigitalWalletToken::Type]
+      required :type, enum: -> { Increase::DigitalWalletToken::Type }
+
+      # @!attribute updates
+      #   Updates to the Digital Wallet Token.
+      #
+      #   @return [Array<Increase::Models::DigitalWalletToken::Update>]
+      required :updates, -> { Increase::Internal::Type::ArrayOf[Increase::DigitalWalletToken::Update] }
+
+      # @!method initialize(id:, card_id:, cardholder:, created_at:, device:, status:, token_requestor:, type:, updates:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::DigitalWalletToken} for more details.
+      #
+      #   A Digital Wallet Token is created when a user adds a Card to their Apple Pay or
+      #   Google Pay app. The Digital Wallet Token can be used for purchases just like a
+      #   Card.
+      #
+      #   @param id [String] The Digital Wallet Token identifier.
+      #
+      #   @param card_id [String] The identifier for the Card this Digital Wallet Token belongs to.
+      #
+      #   @param cardholder [Increase::Models::DigitalWalletToken::Cardholder] The cardholder information given when the Digital Wallet Token was created.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+      #
+      #   @param device [Increase::Models::DigitalWalletToken::Device] The device that was used to create the Digital Wallet Token.
+      #
+      #   @param status [Symbol, Increase::Models::DigitalWalletToken::Status] This indicates if payments can be made with the Digital Wallet Token.
+      #
+      #   @param token_requestor [Symbol, Increase::Models::DigitalWalletToken::TokenRequestor] The digital wallet app being used.
+      #
+      #   @param type [Symbol, Increase::Models::DigitalWalletToken::Type] A constant representing the object's type. For this resource it will always be `
+      #
+      #   @param updates [Array<Increase::Models::DigitalWalletToken::Update>] Updates to the Digital Wallet Token.
+
+      # @see Increase::Models::DigitalWalletToken#cardholder
+      class Cardholder < Increase::Internal::Type::BaseModel
+        # @!attribute name
+        #   Name of the cardholder, for example "John Smith".
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!method initialize(name:)
+        #   The cardholder information given when the Digital Wallet Token was created.
+        #
+        #   @param name [String, nil] Name of the cardholder, for example "John Smith".
+      end
+
+      # @see Increase::Models::DigitalWalletToken#device
+      class Device < Increase::Internal::Type::BaseModel
+        # @!attribute device_type
+        #   Device type.
+        #
+        #   @return [Symbol, Increase::Models::DigitalWalletToken::Device::DeviceType, nil]
+        required :device_type, enum: -> { Increase::DigitalWalletToken::Device::DeviceType }, nil?: true
+
+        # @!attribute identifier
+        #   ID assigned to the device by the digital wallet provider.
+        #
+        #   @return [String, nil]
+        required :identifier, String, nil?: true
+
+        # @!attribute ip_address
+        #   IP address of the device.
+        #
+        #   @return [String, nil]
+        required :ip_address, String, nil?: true
+
+        # @!attribute name
+        #   Name of the device, for example "My Work Phone".
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!method initialize(device_type:, identifier:, ip_address:, name:)
+        #   The device that was used to create the Digital Wallet Token.
+        #
+        #   @param device_type [Symbol, Increase::Models::DigitalWalletToken::Device::DeviceType, nil] Device type.
+        #
+        #   @param identifier [String, nil] ID assigned to the device by the digital wallet provider.
+        #
+        #   @param ip_address [String, nil] IP address of the device.
+        #
+        #   @param name [String, nil] Name of the device, for example "My Work Phone".
+
+        # Device type.
+        #
+        # @see Increase::Models::DigitalWalletToken::Device#device_type
+        module DeviceType
+          extend Increase::Internal::Type::Enum
+
+          # Unknown
+          UNKNOWN = :unknown
+
+          # Mobile Phone
+          MOBILE_PHONE = :mobile_phone
+
+          # Tablet
+          TABLET = :tablet
+
+          # Watch
+          WATCH = :watch
+
+          # Mobile Phone or Tablet
+          MOBILEPHONE_OR_TABLET = :mobilephone_or_tablet
+
+          # PC
+          PC = :pc
+
+          # Household Device
+          HOUSEHOLD_DEVICE = :household_device
+
+          # Wearable Device
+          WEARABLE_DEVICE = :wearable_device
+
+          # Automobile Device
+          AUTOMOBILE_DEVICE = :automobile_device
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # This indicates if payments can be made with the Digital Wallet Token.
+      #
+      # @see Increase::Models::DigitalWalletToken#status
+      module Status
+        extend Increase::Internal::Type::Enum
+
+        # The digital wallet token is active.
+        ACTIVE = :active
+
+        # The digital wallet token has been created but not successfully activated via two-factor authentication yet.
+        INACTIVE = :inactive
+
+        # The digital wallet token has been temporarily paused.
+        SUSPENDED = :suspended
+
+        # The digital wallet token has been permanently canceled.
+        DEACTIVATED = :deactivated
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The digital wallet app being used.
+      #
+      # @see Increase::Models::DigitalWalletToken#token_requestor
+      module TokenRequestor
+        extend Increase::Internal::Type::Enum
+
+        # Apple Pay
+        APPLE_PAY = :apple_pay
+
+        # Google Pay
+        GOOGLE_PAY = :google_pay
+
+        # Samsung Pay
+        SAMSUNG_PAY = :samsung_pay
+
+        # Unknown
+        UNKNOWN = :unknown
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `digital_wallet_token`.
+      #
+      # @see Increase::Models::DigitalWalletToken#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        DIGITAL_WALLET_TOKEN = :digital_wallet_token
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Update < Increase::Internal::Type::BaseModel
+        # @!attribute status
+        #   The status the update changed this Digital Wallet Token to.
+        #
+        #   @return [Symbol, Increase::Models::DigitalWalletToken::Update::Status]
+        required :status, enum: -> { Increase::DigitalWalletToken::Update::Status }
+
+        # @!attribute timestamp
+        #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which
+        #   the update happened.
+        #
+        #   @return [Time]
+        required :timestamp, Time
+
+        # @!method initialize(status:, timestamp:)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::DigitalWalletToken::Update} for more details.
+        #
+        #   @param status [Symbol, Increase::Models::DigitalWalletToken::Update::Status] The status the update changed this Digital Wallet Token to.
+        #
+        #   @param timestamp [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which th
+
+        # The status the update changed this Digital Wallet Token to.
+        #
+        # @see Increase::Models::DigitalWalletToken::Update#status
+        module Status
+          extend Increase::Internal::Type::Enum
+
+          # The digital wallet token is active.
+          ACTIVE = :active
+
+          # The digital wallet token has been created but not successfully activated via two-factor authentication yet.
+          INACTIVE = :inactive
+
+          # The digital wallet token has been temporarily paused.
+          SUSPENDED = :suspended
+
+          # The digital wallet token has been permanently canceled.
+          DEACTIVATED = :deactivated
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/increase/models/digital_wallet_token_list_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalWalletTokens#list
+    class DigitalWalletTokenListParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute card_id
+      #   Filter Digital Wallet Tokens to ones belonging to the specified Card.
+      #
+      #   @return [String, nil]
+      optional :card_id, String
+
+      # @!attribute created_at
+      #
+      #   @return [Increase::Models::DigitalWalletTokenListParams::CreatedAt, nil]
+      optional :created_at, -> { Increase::DigitalWalletTokenListParams::CreatedAt }
+
+      # @!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.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(card_id: nil, created_at: nil, cursor: nil, limit: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::DigitalWalletTokenListParams} for more details.
+      #
+      #   @param card_id [String] Filter Digital Wallet Tokens to ones belonging to the specified Card.
+      #
+      #   @param created_at [Increase::Models::DigitalWalletTokenListParams::CreatedAt]
+      #
+      #   @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 ob
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      class CreatedAt < Increase::Internal::Type::BaseModel
+        # @!attribute after
+        #   Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :after, Time
+
+        # @!attribute before
+        #   Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+        #   timestamp.
+        #
+        #   @return [Time, nil]
+        optional :before, Time
+
+        # @!attribute on_or_after
+        #   Return results on or after this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_after, Time
+
+        # @!attribute on_or_before
+        #   Return results on or before this
+        #   [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
+        #
+        #   @return [Time, nil]
+        optional :on_or_before, Time
+
+        # @!method initialize(after: nil, before: nil, on_or_after: nil, on_or_before: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Increase::Models::DigitalWalletTokenListParams::CreatedAt} for more details.
+        #
+        #   @param after [Time] Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) tim
+        #
+        #   @param before [Time] Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) ti
+        #
+        #   @param on_or_after [Time] Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_860
+        #
+        #   @param on_or_before [Time] Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_86
+      end
+    end
+  end
+end

data/lib/increase/models/digital_wallet_token_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::DigitalWalletTokens#retrieve
+    class DigitalWalletTokenRetrieveParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/increase/models/document.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Documents#create
+    class Document < Increase::Internal::Type::BaseModel
+      # @!attribute id
+      #   The Document identifier.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_verification_letter
+      #   Properties of an account verification letter document.
+      #
+      #   @return [Increase::Models::Document::AccountVerificationLetter, nil]
+      required :account_verification_letter, -> { Increase::Document::AccountVerificationLetter }, nil?: true
+
+      # @!attribute category
+      #   The type of document.
+      #
+      #   @return [Symbol, Increase::Models::Document::Category]
+      required :category, enum: -> { Increase::Document::Category }
+
+      # @!attribute created_at
+      #   The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the
+      #   Document was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute entity_id
+      #   The identifier of the Entity the document was generated for.
+      #
+      #   @return [String, nil]
+      required :entity_id, String, nil?: true
+
+      # @!attribute file_id
+      #   The identifier of the File containing the Document's contents.
+      #
+      #   @return [String]
+      required :file_id, String
+
+      # @!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 type
+      #   A constant representing the object's type. For this resource it will always be
+      #   `document`.
+      #
+      #   @return [Symbol, Increase::Models::Document::Type]
+      required :type, enum: -> { Increase::Document::Type }
+
+      # @!method initialize(id:, account_verification_letter:, category:, created_at:, entity_id:, file_id:, idempotency_key:, type:)
+      #   Some parameter documentations has been truncated, see
+      #   {Increase::Models::Document} for more details.
+      #
+      #   Increase generates certain documents / forms automatically for your application;
+      #   they can be listed here.
+      #
+      #   @param id [String] The Document identifier.
+      #
+      #   @param account_verification_letter [Increase::Models::Document::AccountVerificationLetter, nil] Properties of an account verification letter document.
+      #
+      #   @param category [Symbol, Increase::Models::Document::Category] The type of document.
+      #
+      #   @param created_at [Time] The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Documen
+      #
+      #   @param entity_id [String, nil] The identifier of the Entity the document was generated for.
+      #
+      #   @param file_id [String] The identifier of the File containing the Document's contents.
+      #
+      #   @param idempotency_key [String, nil] The idempotency key you chose for this object. This value is unique across Incre
+      #
+      #   @param type [Symbol, Increase::Models::Document::Type] A constant representing the object's type. For this resource it will always be `
+
+      # @see Increase::Models::Document#account_verification_letter
+      class AccountVerificationLetter < Increase::Internal::Type::BaseModel
+        # @!attribute account_number_id
+        #   The identifier of the Account Number the document was generated for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!method initialize(account_number_id:)
+        #   Properties of an account verification letter document.
+        #
+        #   @param account_number_id [String] The identifier of the Account Number the document was generated for.
+      end
+
+      # The type of document.
+      #
+      # @see Increase::Models::Document#category
+      module Category
+        extend Increase::Internal::Type::Enum
+
+        # Internal Revenue Service Form 1099-INT.
+        FORM_1099_INT = :form_1099_int
+
+        # Internal Revenue Service Form 1099-MISC.
+        FORM_1099_MISC = :form_1099_misc
+
+        # A document submitted in response to a proof of authorization request for an ACH transfer.
+        PROOF_OF_AUTHORIZATION = :proof_of_authorization
+
+        # Company information, such a policies or procedures, typically submitted during our due diligence process.
+        COMPANY_INFORMATION = :company_information
+
+        # An account verification letter.
+        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # A constant representing the object's type. For this resource it will always be
+      # `document`.
+      #
+      # @see Increase::Models::Document#type
+      module Type
+        extend Increase::Internal::Type::Enum
+
+        DOCUMENT = :document
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/increase/models/document_create_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Increase
+  module Models
+    # @see Increase::Resources::Documents#create
+    class DocumentCreateParams < Increase::Internal::Type::BaseModel
+      extend Increase::Internal::Type::RequestParameters::Converter
+      include Increase::Internal::Type::RequestParameters
+
+      # @!attribute category
+      #   The type of document to create.
+      #
+      #   @return [Symbol, Increase::Models::DocumentCreateParams::Category]
+      required :category, enum: -> { Increase::DocumentCreateParams::Category }
+
+      # @!attribute account_verification_letter
+      #   An account verification letter.
+      #
+      #   @return [Increase::Models::DocumentCreateParams::AccountVerificationLetter, nil]
+      optional :account_verification_letter, -> { Increase::DocumentCreateParams::AccountVerificationLetter }
+
+      # @!method initialize(category:, account_verification_letter: nil, request_options: {})
+      #   @param category [Symbol, Increase::Models::DocumentCreateParams::Category] The type of document to create.
+      #
+      #   @param account_verification_letter [Increase::Models::DocumentCreateParams::AccountVerificationLetter] An account verification letter.
+      #
+      #   @param request_options [Increase::RequestOptions, Hash{Symbol=>Object}]
+
+      # The type of document to create.
+      module Category
+        extend Increase::Internal::Type::Enum
+
+        # An account verification letter.
+        ACCOUNT_VERIFICATION_LETTER = :account_verification_letter
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class AccountVerificationLetter < Increase::Internal::Type::BaseModel
+        # @!attribute account_number_id
+        #   The Account Number the bank letter should be generated for.
+        #
+        #   @return [String]
+        required :account_number_id, String
+
+        # @!attribute balance_date
+        #   If provided, the letter will include the Account's balance as of the date.
+        #
+        #   @return [Date, nil]
+        optional :balance_date, Date
+
+        # @!method initialize(account_number_id:, balance_date: nil)
+        #   An account verification letter.
+        #
+        #   @param account_number_id [String] The Account Number the bank letter should be generated for.
+        #
+        #   @param balance_date [Date] If provided, the letter will include the Account's balance as of the date.
+      end
+    end
+  end
+end