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.


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
439
440
441
442
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 412

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


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

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


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

def api_version
  @properties['api_version']
end

#body ⇒ String

Returns The message text.

Returns:

  • (String) —

    The message text


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

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:


448
449
450
451
452
453
 
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 448

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


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

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the MessageInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#direction ⇒ message.Direction

Returns The direction of the message.

Returns:

  • (message.Direction) —

    The direction of the message


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

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


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

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


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

def error_message
  @properties['error_message']
end

#feedback ⇒ feedback

Access the feedback

Returns:


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

def feedback
  context.feedback
end

#fetch ⇒ MessageInstance

Fetch the MessageInstance

Returns:


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

def fetch
  context.fetch
end

#from ⇒ String

Returns The phone number that initiated the message.

Returns:

  • (String) —

    The phone number that initiated the message


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

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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

#media ⇒ media

Access the media

Returns:


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

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.


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

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


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

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


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

def num_segments
  @properties['num_segments']
end

#price ⇒ String

Returns The amount billed for the message.

Returns:

  • (String) —

    The amount billed for the message


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

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


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

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


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

def sid
  @properties['sid']
end

#status ⇒ message.Status

Returns The status of the message.

Returns:

  • (message.Status) —

    The status of the message


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

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


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

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


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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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:


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

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:


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

def uri
  @properties['uri']
end