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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 419

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

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

  # 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



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

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



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

def api_version
  @properties['api_version']
end

#body ⇒ String

Returns The message text.

Returns:

  • (String) —

    The message text



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

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:



455
456
457
458
459
460
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 455

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



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

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



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

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



585
586
587
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 585

def delete
  context.delete
end

#direction ⇒ message.Direction

Returns The direction of the message.

Returns:

  • (message.Direction) —

    The direction of the message



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

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



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

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



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

def error_message
  @properties['error_message']
end

#feedback ⇒ feedback

Access the feedback

Returns:



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

def feedback
  context.feedback
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:



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

def fetch
  context.fetch
end

#from ⇒ String

Returns The phone number that initiated the message.

Returns:

  • (String) —

    The phone number that initiated the message



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

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



630
631
632
633
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 630

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

#media ⇒ media

Access the media

Returns:



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

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.



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

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



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

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



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

def num_segments
  @properties['num_segments']
end

#price ⇒ String

Returns The amount billed for the message.

Returns:

  • (String) —

    The amount billed for the message



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

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



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

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



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

def sid
  @properties['sid']
end

#status ⇒ message.Status

Returns The status of the message.

Returns:

  • (message.Status) —

    The status of the message



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

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



578
579
580
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 578

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



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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation



623
624
625
626
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 623

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

#update(body: :unset, status: :unset) ⇒ MessageInstance

Update the MessageInstance

Parameters:

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

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

  • status (message.UpdateStatus) (defaults to: :unset) —

    When set as ‘canceled`, allows a message cancelation request if a message has not yet been sent.

Returns:



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

def update(body: :unset, status: :unset)
  context.update(body: body, status: status, )
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`



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

def uri
  @properties['uri']
end