Class: ModernTreasury::Models::DocumentCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/document_create_params.rb

Overview

See Also:

• Resources::Documents#create

Defined Under Namespace

Modules: DocumentableType

Instance Attribute Summary

• #document_type ⇒ String^?

  A category given to the document, can be ‘null`.

• #documentable_id ⇒ String

  The unique identifier for the associated object.

• #documentable_type ⇒ Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType
• #file ⇒ Pathname, ...

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #initialize, 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

This class inherits a constructor from ModernTreasury::Internal::Type::BaseModel

Instance Attribute Details

#document_type ⇒ String^?

A category given to the document, can be ‘null`.

Returns:

• (String, nil)

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

optional :document_type, String

#documentable_id ⇒ String

The unique identifier for the associated object.

Returns:

• (String)

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

required :documentable_id, String

#documentable_type ⇒ Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType

Returns:

• (Symbol, ModernTreasury::Models::DocumentCreateParams::DocumentableType)

# File 'lib/modern_treasury/models/document_create_params.rb', line 19

required :documentable_type, enum: -> { ModernTreasury::DocumentCreateParams::DocumentableType }

#file ⇒ Pathname, ...

Returns:

• (Pathname, StringIO, IO, String, ModernTreasury::FilePart)

# File 'lib/modern_treasury/models/document_create_params.rb', line 24

required :file, ModernTreasury::Internal::Type::FileInput