Class: Twilio::REST::Api::V2010::AccountContext::MessageInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/message.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, sid: nil) ⇒ MessageInstance

Initialize the MessageInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) (defaults to: nil) —

    The SID of the [Account](www.twilio.com/docs/iam/api/account) that sent the message that created the resource.

  • sid (String) (defaults to: nil) —

    The Twilio-provided string that uniquely identifies the Message resource to fetch.



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 408

def initialize(version, payload, account_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'api_version' => payload['api_version'],
      'body' => payload['body'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'date_sent' => Twilio.deserialize_rfc2822(payload['date_sent']),
      'direction' => payload['direction'],
      'error_code' => payload['error_code'] == nil ? payload['error_code'] : payload['error_code'].to_i,
      'error_message' => payload['error_message'],
      'from' => payload['from'],
      'messaging_service_sid' => payload['messaging_service_sid'],
      'num_media' => payload['num_media'],
      'num_segments' => payload['num_segments'],
      'price' => payload['price'],
      'price_unit' => payload['price_unit'],
      'sid' => payload['sid'],
      'status' => payload['status'],
      'subresource_uris' => payload['subresource_uris'],
      'to' => payload['to'],
      'uri' => payload['uri'],
  }

  # Context
  @instance_context = nil
  @params = {'account_sid' => , 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



453
454
455
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 453

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to process the message.

Returns:

  • (String) —

    The API version used to process the message



459
460
461
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 459

def api_version
  @properties['api_version']
end

#body ⇒ String

Returns The message text.

Returns:

  • (String) —

    The message text



465
466
467
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 465

def body
  @properties['body']
end

#context ⇒ MessageContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



444
445
446
447
448
449
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 444

def context
  unless @instance_context
    @instance_context = MessageContext.new(@version, @params['account_sid'], @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created



471
472
473
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 471

def date_created
  @properties['date_created']
end

#date_sent ⇒ Time

Returns The RFC 2822 date and time in GMT when the message was sent.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the message was sent



483
484
485
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 483

def date_sent
  @properties['date_sent']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated



477
478
479
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 477

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



574
575
576
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 574

def delete
  context.delete
end

#direction ⇒ message.Direction

Returns The direction of the message.

Returns:

  • (message.Direction) —

    The direction of the message



489
490
491
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 489

def direction
  @properties['direction']
end

#error_code ⇒ String

Returns The error code associated with the message.

Returns:

  • (String) —

    The error code associated with the message



495
496
497
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 495

def error_code
  @properties['error_code']
end

#error_message ⇒ String

Returns The description of the error_code.

Returns:

  • (String) —

    The description of the error_code



501
502
503
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 501

def error_message
  @properties['error_message']
end

#feedback ⇒ feedback

Access the feedback

Returns:



604
605
606
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 604

def feedback
  context.feedback
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

Returns:



581
582
583
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 581

def fetch
  context.fetch
end

#from ⇒ String

Returns The phone number that initiated the message.

Returns:

  • (String) —

    The phone number that initiated the message



507
508
509
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 507

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



617
618
619
620
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 617

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.MessageInstance #{values}>"
end

#media ⇒ media

Access the media

Returns:



597
598
599
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 597

def media
  context.media
end

#messaging_service_sid ⇒ String

Returns The SID of the Messaging Service used with the message.

Returns:

  • (String) —

    The SID of the Messaging Service used with the message.



513
514
515
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 513

def messaging_service_sid
  @properties['messaging_service_sid']
end

#num_media ⇒ String

Returns The number of media files associated with the message.

Returns:

  • (String) —

    The number of media files associated with the message



519
520
521
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 519

def num_media
  @properties['num_media']
end

#num_segments ⇒ String

Returns The number of messages used to deliver the message body.

Returns:

  • (String) —

    The number of messages used to deliver the message body



525
526
527
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 525

def num_segments
  @properties['num_segments']
end

#price ⇒ String

Returns The amount billed for the message.

Returns:

  • (String) —

    The amount billed for the message



531
532
533
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 531

def price
  @properties['price']
end

#price_unit ⇒ String

Returns The currency in which price is measured.

Returns:

  • (String) —

    The currency in which price is measured



537
538
539
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 537

def price_unit
  @properties['price_unit']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



543
544
545
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 543

def sid
  @properties['sid']
end

#status ⇒ message.Status

Returns The status of the message.

Returns:

  • (message.Status) —

    The status of the message



549
550
551
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 549

def status
  @properties['status']
end

#subresource_uris ⇒ String

Returns A list of related resources identified by their relative URIs.

Returns:

  • (String) —

    A list of related resources identified by their relative URIs



555
556
557
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 555

def subresource_uris
  @properties['subresource_uris']
end

#to ⇒ String

Returns The phone number that received the message.

Returns:

  • (String) —

    The phone number that received the message



561
562
563
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 561

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



610
611
612
613
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 610

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Api.V2010.MessageInstance #{values}>"
end

#update(body: nil) ⇒ MessageInstance

Update the MessageInstance

Parameters:

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

    The text of the message you want to send. Can be up to 1,600 characters long.

Returns:



590
591
592
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 590

def update(body: nil)
  context.update(body: body, )
end

#uri ⇒ String

Returns The URI of the resource, relative to ‘api.twilio.com`.

Returns:

  • (String) —

    The URI of the resource, relative to ‘api.twilio.com`



567
568
569
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 567

def uri
  @properties['uri']
end