Class: Telnyx::Models::DocServiceDocument

Inherits:
DocServiceRecord show all
Defined in:
lib/telnyx/models/doc_service_document.rb,
sig/telnyx/models/doc_service_document.rbs

Overview

See Also:

  • Telnyx::Resources::Documents#list

Direct Known Subclasses

DocumentUpdateParams

Defined Under Namespace

Modules: AvScanStatus, Status Classes: Size

Instance Attribute Summary collapse

Attributes inherited from DocServiceRecord

#created_at, #id, #record_type, #updated_at

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from DocServiceRecord

#created_at=, #id=, #record_type=, #updated_at=

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(amount: nil, unit: nil) ⇒ Object

Indicates the document's filesize

Parameters:

  • amount (Integer) (defaults to: nil) —

    The number of bytes

  • unit (String) (defaults to: nil) —

    Identifies the unit




# File 'lib/telnyx/models/doc_service_document.rb', line 51

Instance Attribute Details

#customer_reference ⇒ String?

Optional reference string for customer tracking.

Parameters:

  • _ (String)

Returns:

  • (String, nil) 


11
 
# File 'lib/telnyx/models/doc_service_document.rb', line 11

optional :customer_reference, String

#filename ⇒ String?

The filename of the document.

Parameters:

  • _ (String)

Returns:

  • (String, nil) 


17
 
# File 'lib/telnyx/models/doc_service_document.rb', line 17

optional :filename, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/doc_service_document.rb', line 77

Instance Method Details

#av_scan_status ⇒ Telnyx::Models::DocServiceDocument::av_scan_status?

Returns:

  • (Telnyx::Models::DocServiceDocument::av_scan_status, nil) 


23
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 23

def av_scan_status: -> Telnyx::Models::DocServiceDocument::av_scan_status?

#av_scan_status= ⇒ Object 



25
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 25

def av_scan_status=: (

#content_type ⇒ String?

Returns:

  • (String, nil) 


29
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 29

def content_type: -> String?

#content_type= ⇒ String

Parameters:

  • _ (String)

Returns:

  • (String) 


31
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 31

def content_type=: (String _) -> String

#sha256 ⇒ String?

Returns:

  • (String, nil) 


33
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 33

def sha256: -> String?

#sha256= ⇒ String

Parameters:

  • _ (String)

Returns:

  • (String) 


35
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 35

def sha256=: (String _) -> String

#size ⇒ Telnyx::DocServiceDocument::Size?

Returns:

  • (Telnyx::DocServiceDocument::Size, nil) 


37
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 37

def size: -> Telnyx::DocServiceDocument::Size?

#size= ⇒ Object 



39
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 39

def size=: (

#status ⇒ Telnyx::Models::DocServiceDocument::status?

Returns:

  • (Telnyx::Models::DocServiceDocument::status, nil) 


43
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 43

def status: -> Telnyx::Models::DocServiceDocument::status?

#status= ⇒ Object 



45
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 45

def status=: (

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/telnyx/models/doc_service_document.rbs', line 59

def to_hash: -> {