Class: SurgeAPI::Models::Message::Conversation

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SurgeAPI::Models::Message::Conversation

Defined in:

lib/surge_api/models/message.rb

Overview

See Also:

• #conversation

Defined Under Namespace

Classes: PhoneNumber

Instance Attribute Summary

• #contact ⇒ SurgeAPI::Models::Contact

  A contact who has consented to receive messages.

• #id ⇒ String

  Unique identifier for the object.

• #phone_number ⇒ SurgeAPI::Models::Message::Conversation::PhoneNumber^?

  This is the phone number tied to the Surge account.

Instance Method Summary

• #initialize(id:, contact:, phone_number: nil) ⇒ Object constructor

  A conversation with a Contact.

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:, contact:, phone_number: nil) ⇒ Object

A conversation with a Contact

Parameters:

• id (String) —

  Unique identifier for the object.

• contact (SurgeAPI::Models::Contact) —

  A contact who has consented to receive messages

• phone_number (SurgeAPI::Models::Message::Conversation::PhoneNumber) (defaults to: nil) —

  This is the phone number tied to the Surge account.

# File 'lib/surge_api/models/message.rb', line 110

Instance Attribute Details

#contact ⇒ SurgeAPI::Models::Contact

A contact who has consented to receive messages

Returns:

• (SurgeAPI::Models::Contact)

# File 'lib/surge_api/models/message.rb', line 102

required :contact, -> { SurgeAPI::Contact }

#id ⇒ String

Unique identifier for the object.

Returns:

• (String)

# File 'lib/surge_api/models/message.rb', line 96

required :id, String

#phone_number ⇒ SurgeAPI::Models::Message::Conversation::PhoneNumber^?

This is the phone number tied to the Surge account.

Returns:

• (SurgeAPI::Models::Message::Conversation::PhoneNumber, nil)

# File 'lib/surge_api/models/message.rb', line 108

optional :phone_number, -> { SurgeAPI::Message::Conversation::PhoneNumber }