Class: Telnyx::Models::Enterprises::Reputation::RemediationRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/enterprises/reputation/remediation_request.rb,
sig/telnyx/models/enterprises/reputation/remediation_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(id:, call_purpose:, created_at:, phone_numbers_count:, phone_numbers_ineligible:, phone_numbers_submitted:, status:, updated_at:, contact_email: nil, results: nil, tier1_completed_at: nil, tier2_completed_at: nil, webhook_url: nil) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Enterprises::Reputation::RemediationRequest for more details.

Full detail of a remediation request, returned on submit and GET by id.

Parameters:

  • id (String)
  • call_purpose (String)
  • created_at (Time)
  • phone_numbers_count (Integer) —

    Total phone numbers in this batch, including any later cancelled. May exceed the

  • phone_numbers_ineligible (Integer) —

    Numbers rejected before submission (e.g. cooldown).

  • phone_numbers_submitted (Integer) —

    Numbers accepted for remediation, i.e. not rejected as ineligible. Counts number

  • status (Symbol, Telnyx::Models::Enterprises::Reputation::RemediationStatus) —

    Customer-facing status of a remediation request.

  • updated_at (Time)
  • contact_email (String, nil) (defaults to: nil)
  • results (Telnyx::Models::Enterprises::Reputation::RemediationPerNumberResults, nil) (defaults to: nil) —

    Per-category buckets. Populated once results are available. Null while the reque

  • tier1_completed_at (Time, nil) (defaults to: nil)
  • tier2_completed_at (Time, nil) (defaults to: nil)
  • webhook_url (String, nil) (defaults to: nil) 



# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 81

Instance Attribute Details

#call_purpose ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 16

required :call_purpose, String

#contact_email ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


57
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 57

optional :contact_email, String, nil?: true

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


21
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 21

required :created_at, Time

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 11

required :id, String

#phone_numbers_count ⇒ Integer

Total phone numbers in this batch, including any later cancelled. May exceed the sum of the per-category result buckets, which omit cancelled numbers.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


28
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 28

required :phone_numbers_count, Integer

#phone_numbers_ineligible ⇒ Integer

Numbers rejected before submission (e.g. cooldown).

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


34
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 34

required :phone_numbers_ineligible, Integer

#phone_numbers_submitted ⇒ Integer

Numbers accepted for remediation, i.e. not rejected as ineligible. Counts numbers still queued (pending) as well as processed ones.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


41
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 41

required :phone_numbers_submitted, Integer

#results ⇒ Telnyx::Models::Enterprises::Reputation::RemediationPerNumberResults?

Per-category buckets. Populated once results are available. Null while the request is still pending.

Parameters:

  • value (Telnyx::Enterprises::Reputation::RemediationPerNumberResults, nil)

Returns:



64
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 64

optional :results, -> { Telnyx::Enterprises::Reputation::RemediationPerNumberResults }, nil?: true

#status ⇒ Symbol, Telnyx::Models::Enterprises::Reputation::RemediationStatus

Customer-facing status of a remediation request.

Parameters:

  • value (Telnyx::Models::Enterprises::Reputation::remediation_status)

Returns:



47
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 47

required :status, enum: -> { Telnyx::Enterprises::Reputation::RemediationStatus }

#tier1_completed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


69
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 69

optional :tier1_completed_at, Time, nil?: true

#tier2_completed_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


74
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 74

optional :tier2_completed_at, Time, nil?: true

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


52
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 52

required :updated_at, Time

#webhook_url ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


79
 
# File 'lib/telnyx/models/enterprises/reputation/remediation_request.rb', line 79

optional :webhook_url, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


65
 
# File 'sig/telnyx/models/enterprises/reputation/remediation_request.rbs', line 65

def to_hash: -> {