Class: Telnyx::Models::CustomerServiceRecord

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

Overview

See Also:

  • Telnyx::Resources::CustomerServiceRecords#list

Defined Under Namespace

Modules: Status Classes: Result

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(account_number: nil, authorized_person_name: nil, billing_phone_number: nil, name: nil) ⇒ Object

The admin of the customer service record.

Parameters:

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

    The account number of the customer service record.

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

    The authorized person name of the customer service record.

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

    The billing phone number of the customer service record.

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

    The name of the customer service record.




# File 'lib/telnyx/models/customer_service_record.rb', line 65

Instance Attribute Details

#created_at ⇒ Time? (readonly)

Returns the value of attribute created_at.

Returns:

  • (Time, nil) 


39
40
41
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 39

def created_at
  @created_at
end

#error_message ⇒ String?

The error message in case status is failed. This field would be null in case of pending or completed status.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


12
 
# File 'lib/telnyx/models/customer_service_record.rb', line 12

optional :error_message, String, nil?: true

#id ⇒ String? (readonly)

Returns the value of attribute id.

Returns:

  • (String, nil) 


35
36
37
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 35

def id
  @id
end

#phone_number ⇒ String?

The phone number of the customer service record.

Parameters:

  • (String)

Returns:

  • (String, nil) 


18
 
# File 'lib/telnyx/models/customer_service_record.rb', line 18

optional :phone_number, String

#record_type ⇒ String? (readonly)

Returns the value of attribute record_type.

Returns:

  • (String, nil) 


43
44
45
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 43

def record_type
  @record_type
end

#result ⇒ Telnyx::Models::CustomerServiceRecord::Result?

The result of the CSR request. This field would be null in case of pending or failed status.

Parameters:

  • value (Telnyx::CustomerServiceRecord::Result, nil)

Returns:



25
 
# File 'lib/telnyx/models/customer_service_record.rb', line 25

optional :result, -> { Telnyx::CustomerServiceRecord::Result }, nil?: true

#status ⇒ Symbol, ...

The status of the customer service record

Returns:



31
 
# File 'lib/telnyx/models/customer_service_record.rb', line 31

optional :status, enum: -> { Telnyx::CustomerServiceRecord::Status }

#updated_at ⇒ Time? (readonly)

Returns the value of attribute updated_at.

Returns:

  • (Time, nil) 


47
48
49
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 47

def updated_at
  @updated_at
end

#webhook_url ⇒ String?

Callback URL to receive webhook notifications.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :webhook_url, String

Instance Method Details

#created_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


41
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 41

def created_at=: (Time) -> Time

#id= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


37
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 37

def id=: (String) -> String

#record_type= ⇒ String (readonly)

Parameters:

  • (String)

Returns:

  • (String) 


45
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 45

def record_type=: (String) -> String

#to_hash ⇒ {

Returns:

  • ({) 


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

def to_hash: -> {

#updated_at= ⇒ Time (readonly)

Parameters:

  • (Time)

Returns:

  • (Time) 


49
 
# File 'sig/telnyx/models/customer_service_record.rbs', line 49

def updated_at=: (Time) -> Time