Class: Twilio::REST::Conversations::V1::ConversationContext::MessageContext

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

Defined Under Namespace

Classes: DeliveryReceiptContext, DeliveryReceiptInstance, DeliveryReceiptInstanceMetadata, DeliveryReceiptList, DeliveryReceiptListResponse, DeliveryReceiptPage, DeliveryReceiptPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid, sid) ⇒ MessageContext

Initialize the MessageContext

Parameters:



280
281
282
283
284
285
286
287
288
289
290
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 280

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

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

    # Dependents
    @delivery_receipts = nil
end

Instance Method Details

#delete(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstance

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 295

def delete(
    x_twilio_webhook_enabled: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata(x_twilio_webhook_enabled: :unset) ⇒ Boolean

Delete the MessageInstanceMetadata

Parameters:

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 311

def delete_with_metadata(
  x_twilio_webhook_enabled: :unset
)

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      message_instance = MessageInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      MessageInstanceMetadata.new(@version, message_instance, response.headers, response.status_code)
end

#delivery_receipts(sid = :unset) ⇒ DeliveryReceiptList, DeliveryReceiptContext

Access the delivery_receipts

Returns:

Raises:

  • (ArgumentError) 


473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 473

def delivery_receipts(sid=:unset)

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

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

    unless @delivery_receipts
        @delivery_receipts = DeliveryReceiptList.new(
            @version, conversation_sid: @solution[:conversation_sid], message_sid: @solution[:sid], )
    end

 @delivery_receipts
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 332

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    MessageInstance.new(
        @version,
        payload,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ MessageInstance

Fetch the MessageInstanceMetadata

Returns:



352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 352

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    message_instance = MessageInstance.new(
        @version,
        response.body,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
    MessageInstanceMetadata.new(
        @version,
        message_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



498
499
500
501
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 498

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

#to_s ⇒ Object

Provide a user friendly representation



491
492
493
494
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 491

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

#update(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, subject: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance

Update the MessageInstance

Parameters:

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

    The channel specific identifier of the message’s author. Defaults to system.

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

    The content of the message, can be up to 1,600 characters long.

  • 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. null if the message has not been edited.

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

    A 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.

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

    The subject of the message, can be up to 256 characters long.

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 385

def update(
    author: :unset, 
    body: :unset, 
    date_created: :unset, 
    date_updated: :unset, 
    attributes: :unset, 
    subject: :unset, 
    x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'Author' => author,
        'Body' => body,
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'Attributes' => attributes,
        'Subject' => subject,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    MessageInstance.new(
        @version,
        payload,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(author: :unset, body: :unset, date_created: :unset, date_updated: :unset, attributes: :unset, subject: :unset, x_twilio_webhook_enabled: :unset) ⇒ MessageInstance

Update the MessageInstanceMetadata

Parameters:

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

    The channel specific identifier of the message’s author. Defaults to system.

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

    The content of the message, can be up to 1,600 characters long.

  • 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. null if the message has not been edited.

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

    A 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.

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

    The subject of the message, can be up to 256 characters long.

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

    The X-Twilio-Webhook-Enabled HTTP request header

Returns:



429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
 
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/message.rb', line 429

def update_with_metadata(
  author: :unset, 
  body: :unset, 
  date_created: :unset, 
  date_updated: :unset, 
  attributes: :unset, 
  subject: :unset, 
  x_twilio_webhook_enabled: :unset
)

    data = Twilio::Values.of({
        'Author' => author,
        'Body' => body,
        'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
        'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
        'Attributes' => attributes,
        'Subject' => subject,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    message_instance = MessageInstance.new(
        @version,
        response.body,
        conversation_sid: @solution[:conversation_sid],
        sid: @solution[:sid],
    )
    MessageInstanceMetadata.new(
        @version,
        message_instance,
        response.headers,
        response.status_code
    )
end