Class: Telnyx::Models::EmailBlocks::EmailBlockImport

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Telnyx::Models::EmailBlocks::EmailBlockImport

Defined in:

lib/telnyx/models/email_blocks/email_block_import.rb,
sig/telnyx/models/email_blocks/email_block_import.rbs

Defined Under Namespace

Modules: Provider, RecordType, Status

Instance Attribute Summary

• #completed_at ⇒ Time^?

  Omitted until terminal success.

• #created_at ⇒ Time
• #created_count ⇒ Integer^?

  Only when status == completed.

• #error_count ⇒ Integer^?

  Only when status == completed.

• #errors ⇒ Hash{Symbol=>String}^?

  {row_number: reason}; only rendered when non-empty.

• #existing_count ⇒ Integer^?

  Only when status == completed.

• #failure_reason ⇒ String^?

  Only on terminal failure.

• #id ⇒ String
• #processed_rows ⇒ Integer^?

  Only when status == completed.

• #provider ⇒ Symbol, ...

  Omitted when nil.

• #record_type ⇒ Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::RecordType

  View-only.

• #skipped_count ⇒ Integer^?

  Only when status == completed.

• #status ⇒ Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::Status
• #total ⇒ Integer

  Data-row count at upload.

• #updated_at ⇒ Time

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(id:, created_at:, record_type:, status:, total:, updated_at:, completed_at: nil, created_count: nil, error_count: nil, errors: nil, existing_count: nil, failure_reason: nil, processed_rows: nil, provider: nil, skipped_count: nil) ⇒ Object constructor

  Import job.

• #to_hash ⇒ {

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(id:, created_at:, record_type:, status:, total:, updated_at:, completed_at: nil, created_count: nil, error_count: nil, errors: nil, existing_count: nil, failure_reason: nil, processed_rows: nil, provider: nil, skipped_count: nil) ⇒ Object

Import job. Schema fields hidden: account_id, csv_content, block_ttl_days. Nullable fields use the omit-nullable pattern.

Parameters:

• id (String)
• created_at (Time)
• record_type (Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::RecordType) —

  View-only.

• status (Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::Status)
• total (Integer) —

  Data-row count at upload.

• updated_at (Time)
• completed_at (Time) (defaults to: nil) —

  Omitted until terminal success.

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

  Only when status == completed.

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

  Only when status == completed.

• errors (Hash{Symbol=>String}) (defaults to: nil) —

  {row_number: reason}; only rendered when non-empty.

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

  Only when status == completed.

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

  Only on terminal failure.

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

  Only when status == completed.

• provider (Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::Provider) (defaults to: nil) —

  Omitted when nil.

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

  Only when status == completed.

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 93

Instance Attribute Details

#completed_at ⇒ Time^?

Omitted until terminal success.

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 43

optional :completed_at, Time

#created_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 15

required :created_at, Time

#created_count ⇒ Integer^?

Only when status == completed.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 49

optional :created_count, Integer

#error_count ⇒ Integer^?

Only when status == completed.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 55

optional :error_count, Integer

#errors ⇒ Hash{Symbol=>String}^?

{row_number: reason}; only rendered when non-empty.

Parameters:

• (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 61

optional :errors, Telnyx::Internal::Type::HashOf[String]

#existing_count ⇒ Integer^?

Only when status == completed.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 67

optional :existing_count, Integer

#failure_reason ⇒ String^?

Only on terminal failure.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 73

optional :failure_reason, String

#id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 10

required :id, String

#processed_rows ⇒ Integer^?

Only when status == completed.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 79

optional :processed_rows, Integer

#provider ⇒ Symbol, ...

Omitted when nil.

Returns:

• (Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::Provider, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 85

optional :provider, enum: -> { Telnyx::EmailBlocks::EmailBlockImport::Provider }

#record_type ⇒ Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::RecordType

View-only.

Parameters:

• value (Telnyx::Models::EmailBlocks::EmailBlockImport::record_type)

Returns:

• (Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::RecordType)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 21

required :record_type, enum: -> { Telnyx::EmailBlocks::EmailBlockImport::RecordType }

#skipped_count ⇒ Integer^?

Only when status == completed.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 91

optional :skipped_count, Integer

#status ⇒ Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::Status

Parameters:

• value (Telnyx::Models::EmailBlocks::EmailBlockImport::status)

Returns:

• (Symbol, Telnyx::Models::EmailBlocks::EmailBlockImport::Status)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 26

required :status, enum: -> { Telnyx::EmailBlocks::EmailBlockImport::Status }

#total ⇒ Integer

Data-row count at upload.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 32

required :total, Integer

#updated_at ⇒ Time

Parameters:

• value (Time)

Returns:

• (Time)

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

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/telnyx/models/email_blocks/email_block_import.rb', line 135

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/telnyx/models/email_blocks/email_block_import.rbs', line 94

def to_hash: -> {