Class: Increase::Models::EntitySupplementalDocument

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/entity_supplemental_document.rb

Overview

See Also:

Defined Under Namespace

Modules: Type

Instance Attribute Summary collapse

Instance Method Summary collapse

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(created_at: , entity_id: , file_id: , idempotency_key: , type: ) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::EntitySupplementalDocument for more details.

Supplemental Documents are uploaded files connected to an Entity during onboarding.

Parameters:

  • created_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Supplem

  • entity_id (String) (defaults to: ) —

    The Entity the supplemental document is attached to.

  • file_id (String) (defaults to: ) —

    The File containing the document.

  • idempotency_key (String, nil) (defaults to: ) —

    The idempotency key you chose for this object. This value is unique across Incre

  • type (Symbol, Increase::Models::EntitySupplementalDocument::Type) (defaults to: ) —

    A constant representing the object’s type. For this resource it will always be ‘




# File 'lib/increase/models/entity_supplemental_document.rb', line 41

Instance Attribute Details

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental Document was created.

Returns:

  • (Time) 


12
 
# File 'lib/increase/models/entity_supplemental_document.rb', line 12

required :created_at, Time

#entity_id ⇒ String

The Entity the supplemental document is attached to.

Returns:

  • (String) 


18
 
# File 'lib/increase/models/entity_supplemental_document.rb', line 18

required :entity_id, String

#file_id ⇒ String

The File containing the document.

Returns:

  • (String) 


24
 
# File 'lib/increase/models/entity_supplemental_document.rb', line 24

required :file_id, String

#idempotency_key ⇒ String?

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](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


32
 
# File 'lib/increase/models/entity_supplemental_document.rb', line 32

required :idempotency_key, String, nil?: true

#type ⇒ Symbol, Increase::Models::EntitySupplementalDocument::Type

A constant representing the object’s type. For this resource it will always be ‘entity_supplemental_document`.

Returns:



39
 
# File 'lib/increase/models/entity_supplemental_document.rb', line 39

required :type, enum: -> { Increase::EntitySupplementalDocument::Type }