Class: Telnyx::Models::FaxFailed::Data::Payload

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

Overview

See Also:

  • Telnyx::Models::FaxFailed::Data#payload

Defined Under Namespace

Modules: Direction, Status

Instance Attribute Summary collapse

Class Method 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(client_state: nil, connection_id: nil, direction: nil, failure_reason: nil, fax_id: nil, from: nil, internal_failure_reason: nil, media_name: nil, original_media_url: nil, status: nil, to: nil, user_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::FaxFailed::Data::Payload for more details.

Parameters:

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

    State received from a command.

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

    The ID of the connection used to send the fax.

  • direction (Symbol, Telnyx::Models::FaxFailed::Data::Payload::Direction) (defaults to: nil) —

    The direction of the fax.

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

    Customer-facing cause of the fax failure. Mapped from the more granular `interna

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

    Identifies the fax.

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

    The phone number, in E.164 format, the fax will be sent from.

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

    Internal, more granular cause of the fax failure. Useful for deeper debugging be

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

    The media_name used for the fax's media. Must point to a file previously uploade

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

    The original URL to the PDF used for the fax's media. If media_name was supplied

  • status (Symbol, Telnyx::Models::FaxFailed::Data::Payload::Status) (defaults to: nil) —

    The status of the fax.

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

    The phone number, in E.164 format, the fax will be sent to or SIP URI

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

    Identifier of the user to whom the fax belongs




# File 'lib/telnyx/models/fax_failed.rb', line 156

Instance Attribute Details

#client_state ⇒ String?

State received from a command.

Parameters:

  • (String)

Returns:

  • (String, nil) 


82
 
# File 'lib/telnyx/models/fax_failed.rb', line 82

optional :client_state, String

#connection_id ⇒ String?

The ID of the connection used to send the fax.

Parameters:

  • (String)

Returns:

  • (String, nil) 


88
 
# File 'lib/telnyx/models/fax_failed.rb', line 88

optional :connection_id, String

#direction ⇒ Symbol, ...

The direction of the fax.

Returns:



94
 
# File 'lib/telnyx/models/fax_failed.rb', line 94

optional :direction, enum: -> { Telnyx::FaxFailed::Data::Payload::Direction }

#failure_reason ⇒ String?

Customer-facing cause of the fax failure. Mapped from the more granular internal_failure_reason.

Parameters:

  • (String)

Returns:

  • (String, nil) 


101
 
# File 'lib/telnyx/models/fax_failed.rb', line 101

optional :failure_reason, String

#fax_id ⇒ String?

Identifies the fax.

Parameters:

  • (String)

Returns:

  • (String, nil) 


107
 
# File 'lib/telnyx/models/fax_failed.rb', line 107

optional :fax_id, String

#from ⇒ String?

The phone number, in E.164 format, the fax will be sent from.

Parameters:

  • (String)

Returns:

  • (String, nil) 


113
 
# File 'lib/telnyx/models/fax_failed.rb', line 113

optional :from, String

#internal_failure_reason ⇒ String?

Internal, more granular cause of the fax failure. Useful for deeper debugging beyond the customer-facing failure_reason.

Parameters:

  • (String)

Returns:

  • (String, nil) 


120
 
# File 'lib/telnyx/models/fax_failed.rb', line 120

optional :internal_failure_reason, String

#media_name ⇒ String?

The media_name used for the fax's media. Must point to a file previously uploaded to api.telnyx.com/v2/media by the same user/organization. Supported formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and media_url/contents can't be submitted together.

Parameters:

  • (String)

Returns:

  • (String, nil) 


129
 
# File 'lib/telnyx/models/fax_failed.rb', line 129

optional :media_name, String

#original_media_url ⇒ String?

The original URL to the PDF used for the fax's media. If media_name was supplied, this is omitted

Parameters:

  • (String)

Returns:

  • (String, nil) 


136
 
# File 'lib/telnyx/models/fax_failed.rb', line 136

optional :original_media_url, String

#status ⇒ Symbol, ...

The status of the fax.

Returns:



142
 
# File 'lib/telnyx/models/fax_failed.rb', line 142

optional :status, enum: -> { Telnyx::FaxFailed::Data::Payload::Status }

#to ⇒ String?

The phone number, in E.164 format, the fax will be sent to or SIP URI

Parameters:

  • (String)

Returns:

  • (String, nil) 


148
 
# File 'lib/telnyx/models/fax_failed.rb', line 148

optional :to, String

#user_id ⇒ String?

Identifier of the user to whom the fax belongs

Parameters:

  • (String)

Returns:

  • (String, nil) 


154
 
# File 'lib/telnyx/models/fax_failed.rb', line 154

optional :user_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/fax_failed.rb', line 193

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


171
 
# File 'sig/telnyx/models/fax_failed.rbs', line 171

def to_hash: -> {