Class: Inttegro::Chime::RecipientDetail

Inherits:
T::Struct
  • Object
show all
Defined in:
lib/inttegro/chime/recipient_detail.rb

Overview

Recipient information in response

This generated model is immutable. Construct it with .new, or decode a string-keyed API payload with .from_hash. #serialize produces a string-keyed hash using the original wire field names and serialized enum values.

Instance Attribute Summary collapse

Instance Attribute Details

#email ⇒ Inttegro::Chime::RecipientDetailEmail? (readonly)

Value of the email field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: email.

Returns:



44
45
46
47
48
49
 
# File 'lib/inttegro/chime/recipient_detail.rb', line 44

class RecipientDetail < T::Struct
  const :type, Inttegro::Chime::RecipientType
  const :name, T.nilable(String), default: nil
  const :phone, T.nilable(Inttegro::Chime::RecipientDetailPhone), default: nil
  const :email, T.nilable(Inttegro::Chime::RecipientDetailEmail), default: nil
end

#name ⇒ String? (readonly)

Recipient name

Optional in the API payload; omitted values default to nil. Wire name: name.

Returns:

  • (String, nil) 


44
45
46
47
48
49
 
# File 'lib/inttegro/chime/recipient_detail.rb', line 44

class RecipientDetail < T::Struct
  const :type, Inttegro::Chime::RecipientType
  const :name, T.nilable(String), default: nil
  const :phone, T.nilable(Inttegro::Chime::RecipientDetailPhone), default: nil
  const :email, T.nilable(Inttegro::Chime::RecipientDetailEmail), default: nil
end

#phone ⇒ Inttegro::Chime::RecipientDetailPhone? (readonly)

Value of the phone field in the Inttegro API payload.

Optional in the API payload; omitted values default to nil. Wire name: phone.

Returns:



44
45
46
47
48
49
 
# File 'lib/inttegro/chime/recipient_detail.rb', line 44

class RecipientDetail < T::Struct
  const :type, Inttegro::Chime::RecipientType
  const :name, T.nilable(String), default: nil
  const :phone, T.nilable(Inttegro::Chime::RecipientDetailPhone), default: nil
  const :email, T.nilable(Inttegro::Chime::RecipientDetailEmail), default: nil
end

#type ⇒ Inttegro::Chime::RecipientType (readonly)

Contact type

Required in the API payload. Wire name: type.

Returns:



44
45
46
47
48
49
 
# File 'lib/inttegro/chime/recipient_detail.rb', line 44

class RecipientDetail < T::Struct
  const :type, Inttegro::Chime::RecipientType
  const :name, T.nilable(String), default: nil
  const :phone, T.nilable(Inttegro::Chime::RecipientDetailPhone), default: nil
  const :email, T.nilable(Inttegro::Chime::RecipientDetailEmail), default: nil
end