Class: Increase::Models::DocumentCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::DocumentCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/document_create_params.rb

Overview

See Also:

• Resources::Documents#create

Defined Under Namespace

Modules: Category Classes: AccountVerificationLetter, FundingInstructions

Instance Attribute Summary

• #account_verification_letter ⇒ Increase::Models::DocumentCreateParams::AccountVerificationLetter^?

  An account verification letter.

• #category ⇒ Symbol, Increase::Models::DocumentCreateParams::Category

  The type of document to create.

• #funding_instructions ⇒ Increase::Models::DocumentCreateParams::FundingInstructions^?

  Funding instructions.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account_number_id: , balance_date: nil) ⇒ Object constructor

  An account verification letter.

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(account_number_id: , balance_date: nil) ⇒ Object

An account verification letter. Required if and only if ‘category` is `account_verification_letter`.

Parameters:

• account_number_id (String) (defaults to: ) —

  The Account Number the bank letter should be generated for.

• balance_date (Date) (defaults to: nil) —

  If provided, the letter will include the Account’s balance as of the date.

# File 'lib/increase/models/document_create_params.rb', line 30

Instance Attribute Details

#account_verification_letter ⇒ Increase::Models::DocumentCreateParams::AccountVerificationLetter^?

An account verification letter. Required if and only if ‘category` is `account_verification_letter`.

Returns:

• (Increase::Models::DocumentCreateParams::AccountVerificationLetter, nil)

# File 'lib/increase/models/document_create_params.rb', line 21

optional :account_verification_letter, -> { Increase::DocumentCreateParams::AccountVerificationLetter }

#category ⇒ Symbol, Increase::Models::DocumentCreateParams::Category

The type of document to create.

Returns:

• (Symbol, Increase::Models::DocumentCreateParams::Category)

# File 'lib/increase/models/document_create_params.rb', line 14

required :category, enum: -> { Increase::DocumentCreateParams::Category }

#funding_instructions ⇒ Increase::Models::DocumentCreateParams::FundingInstructions^?

Funding instructions. Required if and only if ‘category` is `funding_instructions`.

Returns:

• (Increase::Models::DocumentCreateParams::FundingInstructions, nil)

# File 'lib/increase/models/document_create_params.rb', line 28

optional :funding_instructions, -> { Increase::DocumentCreateParams::FundingInstructions }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/increase/models/document_create_params.rb', line 52