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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ 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.



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation_with_participants.rb', line 136

def initialize(version, payload )
    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:



161
162
163
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation_with_participants.rb', line 161

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.



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

def attributes
    @properties['attributes']
end

#bindings ⇒ Hash

Returns:

  • (Hash) 


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

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:



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

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.



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

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.



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

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



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

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:



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

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.



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

def sid
    @properties['sid']
end

#state ⇒ State

Returns:

  • (State) 


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

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.



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

def timers
    @properties['timers']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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.



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

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.



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

def url
    @properties['url']
end