Class: Telnyx::Models::NumberReservation

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

Overview

See Also:

  • Telnyx::Resources::NumberReservations#list

Defined Under Namespace

Modules: Status

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: nil, created_at: nil, customer_reference: nil, errors: nil, phone_numbers: nil, record_type: nil, status: nil, updated_at: nil) ⇒ Object

Parameters:

  • id (String) (defaults to: nil)
  • created_at (Time) (defaults to: nil) —

    An ISO 8901 datetime string denoting when the numbers reservation was created.

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

    A customer reference string for customer look ups.

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

    Errors the reservation could happen upon

  • phone_numbers (Array<Telnyx::Models::ReservedPhoneNumber>) (defaults to: nil)
  • record_type (String) (defaults to: nil)
  • status (Symbol, Telnyx::Models::NumberReservation::Status) (defaults to: nil) —

    The status of the entire reservation.

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

    An ISO 8901 datetime string for when the number reservation was updated.




# File 'lib/telnyx/models/number_reservation.rb', line 54

Instance Attribute Details

#created_at ⇒ Time? (readonly)

Returns the value of attribute created_at.

Returns:

  • (Time, nil) 


30
31
32
 
# File 'sig/telnyx/models/number_reservation.rbs', line 30

def created_at
  @created_at
end

#customer_reference ⇒ String?

A customer reference string for customer look ups.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :customer_reference, String

#errors ⇒ String? (readonly)

Returns the value of attribute errors.

Returns:

  • (String, nil) 


34
35
36
 
# File 'sig/telnyx/models/number_reservation.rbs', line 34

def errors
  @errors
end

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


26
27
28
 
# File 'sig/telnyx/models/number_reservation.rbs', line 26

def id
  @id
end

#phone_numbers ⇒ Array<Telnyx::Models::ReservedPhoneNumber>?

Returns:



16
 
# File 'lib/telnyx/models/number_reservation.rb', line 16

optional :phone_numbers, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::ReservedPhoneNumber] }

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


38
39
40
 
# File 'sig/telnyx/models/number_reservation.rbs', line 38

def record_type
  @record_type
end

#status ⇒ Telnyx::Models::NumberReservation::status? (readonly)

Returns the value of attribute status.

Returns:

  • (Telnyx::Models::NumberReservation::status, nil) 


42
43
44
 
# File 'sig/telnyx/models/number_reservation.rbs', line 42

def status
  @status
end

#updated_at ⇒ Time? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (Time, nil) 


48
49
50
 
# File 'sig/telnyx/models/number_reservation.rbs', line 48

def updated_at
  @updated_at
end

Instance Method Details

#created_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


32
 
# File 'sig/telnyx/models/number_reservation.rbs', line 32

def created_at=: (Time) -> Time

#errors= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


36
 
# File 'sig/telnyx/models/number_reservation.rbs', line 36

def errors=: (String) -> String

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


28
 
# File 'sig/telnyx/models/number_reservation.rbs', line 28

def id=: (String) -> String

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


40
 
# File 'sig/telnyx/models/number_reservation.rbs', line 40

def record_type=: (String) -> String

#status= ⇒ Object (readonly) 



44
 
# File 'sig/telnyx/models/number_reservation.rbs', line 44

def status=: (

#to_hash ⇒ {

Returns:

  • ({) 


63
 
# File 'sig/telnyx/models/number_reservation.rbs', line 63

def to_hash: -> {

#updated_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


50
 
# File 'sig/telnyx/models/number_reservation.rbs', line 50

def updated_at=: (Time) -> Time