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,
sig/modern_treasury/models/document_create_params.rbs

Overview

See Also:

• ModernTreasury::Resources::Documents#create

Defined Under Namespace

Modules: DocumentableType

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::ModernTreasury

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, ...
• #file ⇒ Pathname, ...

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

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 ⇒ Object

# File 'sig/modern_treasury/models/document_create_params.rbs', line 32

def initialize: (

Instance Attribute Details

#document_type ⇒ String^?

A category given to the document, can be null.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :document_type, String

#documentable_id ⇒ String^?

The unique identifier for the associated object.

Parameters:

• (String)

Returns:

• (String, nil)

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

optional :documentable_id, String

#documentable_type ⇒ Symbol, ...

Returns:

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

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

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

#file ⇒ Pathname, ...

Parameters:

• value (ModernTreasury::Internal::file_input)

Returns:

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

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

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

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/modern_treasury/models/document_create_params.rbs', line 40

def to_hash: -> {