Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationWithParticipantsInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, chat_service_sid: nil) ⇒ ConversationWithParticipantsInstance

Initialize the ConversationWithParticipantsInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this ConversationWithParticipants resource.

  • sid (String) —

    The SID of the Call resource to fetch.



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 143

def initialize(version, payload , chat_service_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'chat_service_sid' => payload['chat_service_sid'],
        'messaging_service_sid' => payload['messaging_service_sid'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'unique_name' => payload['unique_name'],
        'attributes' => payload['attributes'],
        'state' => payload['state'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'timers' => payload['timers'],
        'links' => payload['links'],
        'bindings' => payload['bindings'],
        'url' => payload['url'],
    }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this conversation.

Returns:



168
169
170
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 168

def 
    @properties['account_sid']
end

#attributes ⇒ String

Returns An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.

Returns:

  • (String) —

    An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified. Note that if the attributes are not set "{}" will be returned.



204
205
206
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 204

def attributes
    @properties['attributes']
end

#bindings ⇒ Hash

Returns:

  • (Hash) 


240
241
242
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 240

def bindings
    @properties['bindings']
end

#chat_service_sid ⇒ String

Returns The unique ID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) this conversation belongs to.

Returns:



174
175
176
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 174

def chat_service_sid
    @properties['chat_service_sid']
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



216
217
218
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 216

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



222
223
224
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 222

def date_updated
    @properties['date_updated']
end

#friendly_name ⇒ String

Returns The human-readable name of this conversation, limited to 256 characters. Optional.

Returns:

  • (String) —

    The human-readable name of this conversation, limited to 256 characters. Optional.



192
193
194
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 192

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



258
259
260
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 258

def inspect
    "<Twilio.Conversations.V1.ConversationWithParticipantsInstance>"
end

#links ⇒ Hash

Returns Contains absolute URLs to access the [participants](www.twilio.com/docs/conversations/api/conversation-participant-resource), [messages](www.twilio.com/docs/conversations/api/conversation-message-resource) and [webhooks](www.twilio.com/docs/conversations/api/conversation-scoped-webhook-resource) of this conversation.

Returns:



234
235
236
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 234

def links
    @properties['links']
end

#messaging_service_sid ⇒ String

Returns The unique ID of the [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) this conversation belongs to.

Returns:



180
181
182
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 180

def messaging_service_sid
    @properties['messaging_service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



186
187
188
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 186

def sid
    @properties['sid']
end

#state ⇒ State

Returns:

  • (State) 


210
211
212
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 210

def state
    @properties['state']
end

#timers ⇒ Hash

Returns Timer date values representing state update for this conversation.

Returns:

  • (Hash) —

    Timer date values representing state update for this conversation.



228
229
230
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 228

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



252
253
254
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 252

def to_s
    "<Twilio.Conversations.V1.ConversationWithParticipantsInstance>"
end

#unique_name ⇒ String

Returns An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL.

Returns:

  • (String) —

    An application-defined string that uniquely identifies the resource. It can be used to address the resource in place of the resource’s ‘sid` in the URL.



198
199
200
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 198

def unique_name
    @properties['unique_name']
end

#url ⇒ String

Returns An absolute API resource URL for this conversation.

Returns:

  • (String) —

    An absolute API resource URL for this conversation.



246
247
248
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb', line 246

def url
    @properties['url']
end