Class: Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/enterprises/reputation/number_refresh_response.rb,
sig/telnyx/models/enterprises/reputation/number_refresh_response.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(phone_number:, success:, error: nil) ⇒ Object

Parameters:

  • phone_number (String)
  • success (Boolean)
  • error (String, nil) (defaults to: nil) —

    null when success is true; carries an error message otherwise.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/telnyx/models/enterprises/reputation/number_refresh_response.rb', line 50

class Result < Telnyx::Internal::Type::BaseModel
  # @!attribute phone_number
  #
  #   @return [String]
  required :phone_number, String

  # @!attribute success
  #
  #   @return [Boolean]
  required :success, Telnyx::Internal::Type::Boolean

  # @!attribute error
  #   `null` when `success` is `true`; carries an error message otherwise.
  #
  #   @return [String, nil]
  optional :error, String, nil?: true

  # @!method initialize(phone_number:, success:, error: nil)
  #   @param phone_number [String]
  #
  #   @param success [Boolean]
  #
  #   @param error [String, nil] `null` when `success` is `true`; carries an error message otherwise.
end

Instance Attribute Details

#error ⇒ String?

null when success is true; carries an error message otherwise.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


65
 
# File 'lib/telnyx/models/enterprises/reputation/number_refresh_response.rb', line 65

optional :error, String, nil?: true

#phone_number ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


54
 
# File 'lib/telnyx/models/enterprises/reputation/number_refresh_response.rb', line 54

required :phone_number, String

#success ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


59
 
# File 'lib/telnyx/models/enterprises/reputation/number_refresh_response.rb', line 59

required :success, Telnyx::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


68
 
# File 'sig/telnyx/models/enterprises/reputation/number_refresh_response.rbs', line 68

def to_hash: -> {