Class: Telnyx::Models::AttachmentRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/attachment_request.rb,
sig/telnyx/models/attachment_request.rbs

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(content: nil, content_id: nil, content_type: nil, disposition: nil, filename: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::AttachmentRequest for more details.

Parameters:

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

    Attachment content, typically Base64-encoded. Defaults to empty string when omit

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

    MIME Content-ID used to reference an inline attachment.

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

    MIME content type. Defaults to "application/octet-stream" when omitted.

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

    MIME disposition (attachment or inline).

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

    Attachment filename. Defaults to "attachment" when omitted.




# File 'lib/telnyx/models/attachment_request.rb', line 37

Instance Attribute Details

#content ⇒ String?

Attachment content, typically Base64-encoded. Defaults to empty string when omitted.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :content, String

#content_id ⇒ String?

MIME Content-ID used to reference an inline attachment.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :content_id, String, nil?: true

#content_type ⇒ String?

MIME content type. Defaults to "application/octet-stream" when omitted.

Parameters:

  • (String)

Returns:

  • (String, nil) 


23
 
# File 'lib/telnyx/models/attachment_request.rb', line 23

optional :content_type, String

#disposition ⇒ String?

MIME disposition (attachment or inline).

Parameters:

  • (String)

Returns:

  • (String, nil) 


29
 
# File 'lib/telnyx/models/attachment_request.rb', line 29

optional :disposition, String

#filename ⇒ String?

Attachment filename. Defaults to "attachment" when omitted.

Parameters:

  • (String)

Returns:

  • (String, nil) 


35
 
# File 'lib/telnyx/models/attachment_request.rb', line 35

optional :filename, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {