Class: Twilio::REST::Conversations::V1::ServiceContext::ConversationContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service/conversation.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb

Defined Under Namespace

Classes: MessageContext, MessageInstance, MessageList, MessagePage, ParticipantContext, ParticipantInstance, ParticipantList, ParticipantPage, WebhookContext, WebhookInstance, WebhookList, WebhookPage

Instance Method Summary collapse

Constructor Details

#initialize(version, chat_service_sid, sid) ⇒ ConversationContext

Initialize the ConversationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • chat_service_sid (String) —

    The SID of the [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) the Conversation resource is associated with.

  • sid (String) —

    A 34 character string that uniquely identifies this resource. Can also be the ‘unique_name` of the Conversation.



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 208

def initialize(version, chat_service_sid, sid)
    super(version)

    # Path Solution
    @solution = { chat_service_sid: chat_service_sid, sid: sid,  }
    @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:sid]}"

    # Dependents
    @participants = nil
    @messages = nil
    @webhooks = nil
end

Instance Method Details

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the ConversationInstance

Parameters:

  • x_twilio_webhook_enabled (ServiceConversationEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 224

def delete(
    x_twilio_webhook_enabled: :unset
)

    
    headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    @version.delete('DELETE', @uri, headers: headers)
end

#fetch ⇒ ConversationInstance

Fetch the ConversationInstance

Returns:



236
237
238
239
240
241
242
243
244
245
246
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 236

def fetch

    
    payload = @version.fetch('GET', @uri)
    ConversationInstance.new(
        @version,
        payload,
        chat_service_sid: @solution[:chat_service_sid],
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



370
371
372
373
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 370

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Conversations.V1.ConversationContext #{context}>"
end

#messages(sid = :unset) ⇒ MessageList, MessageContext

Access the messages

Returns:

Raises:

  • (ArgumentError) 


326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 326

def messages(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return MessageContext.new(@version, @solution[:chat_service_sid], @solution[:sid],sid )
    end

    unless @messages
        @messages = MessageList.new(
            @version, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:sid], )
    end

 @messages
end

#participants(sid = :unset) ⇒ ParticipantList, ParticipantContext

Access the participants

Returns:

Raises:

  • (ArgumentError) 


307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 307

def participants(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return ParticipantContext.new(@version, @solution[:chat_service_sid], @solution[:sid],sid )
    end

    unless @participants
        @participants = ParticipantList.new(
            @version, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:sid], )
    end

 @participants
end

#to_s ⇒ Object

Provide a user friendly representation



363
364
365
366
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 363

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Conversations.V1.ConversationContext #{context}>"
end

#update(friendly_name: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, messaging_service_sid: :unset, state: :unset, timers_inactive: :unset, timers_closed: :unset, unique_name: :unset, bindings_email_address: :unset, bindings_email_name: :unset, x_twilio_webhook_enabled: :unset) ⇒ ConversationInstance

Update the ConversationInstance

Parameters:

  • friendly_name (String) (defaults to: :unset) —

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

  • date_created (Time) (defaults to: :unset) —

    The date that this resource was created.

  • date_updated (Time) (defaults to: :unset) —

    The date that this resource was last updated.

  • attributes (String) (defaults to: :unset) —

    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.

  • messaging_service_sid (String) (defaults to: :unset) —

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

  • state (State) (defaults to: :unset)
  • timers_inactive (String) (defaults to: :unset) —

    ISO8601 duration when conversation will be switched to ‘inactive` state. Minimum value for this timer is 1 minute.

  • timers_closed (String) (defaults to: :unset) —

    ISO8601 duration when conversation will be switched to ‘closed` state. Minimum value for this timer is 10 minutes.

  • unique_name (String) (defaults to: :unset) —

    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.

  • bindings_email_address (String) (defaults to: :unset) —

    The default email address that will be used when sending outbound emails in this conversation.

  • bindings_email_name (String) (defaults to: :unset) —

    The default name that will be used when sending outbound emails in this conversation.

  • x_twilio_webhook_enabled (ServiceConversationEnumWebhookEnabledType) (defaults to: :unset) —

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 263

def update(
    friendly_name: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    messaging_service_sid: :unset, 
    state: :unset, 
    timers_inactive: :unset, 
    timers_closed: :unset, 
    unique_name: :unset, 
    bindings_email_address: :unset, 
    bindings_email_name: :unset, 
    x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'Attributes' => attributes,
        'MessagingServiceSid' => messaging_service_sid,
        'State' => state,
        'Timers.Inactive' => timers_inactive,
        'Timers.Closed' => timers_closed,
        'UniqueName' => unique_name,
        'Bindings.Email.Address' => bindings_email_address,
        'Bindings.Email.Name' => bindings_email_name,
    })

    
    headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    payload = @version.update('POST', @uri, data: data, headers: headers)
    ConversationInstance.new(
        @version,
        payload,
        chat_service_sid: @solution[:chat_service_sid],
        sid: @solution[:sid],
    )
end

#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext

Access the webhooks

Returns:

Raises:

  • (ArgumentError) 


345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/twilio-ruby/rest/conversations/v1/service/conversation.rb', line 345

def webhooks(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return WebhookContext.new(@version, @solution[:chat_service_sid], @solution[:sid],sid )
    end

    unless @webhooks
        @webhooks = WebhookList.new(
            @version, chat_service_sid: @solution[:chat_service_sid], conversation_sid: @solution[:sid], )
    end

 @webhooks
end