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.


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 401

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#api_versionString

Returns The API version used to process the message.

Returns:

  • (String)

    The API version used to process the message


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

def api_version
  @properties['api_version']
end

#bodyString

Returns The message text.

Returns:

  • (String)

    The message text


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

def body
  @properties['body']
end

#contextMessageContext

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

Returns:


437
438
439
440
441
442
# File 'lib/twilio-ruby/rest/api/v2010/account/message.rb', line 437

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

#date_createdTime

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


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

def date_created
  @properties['date_created']
end

#date_sentTime

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


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

def date_sent
  @properties['date_sent']
end

#date_updatedTime

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


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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Delete the MessageInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#directionmessage.Direction

Returns The direction of the message.

Returns:

  • (message.Direction)

    The direction of the message


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

def direction
  @properties['direction']
end

#error_codeString

Returns The error code associated with the message.

Returns:

  • (String)

    The error code associated with the message


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

def error_code
  @properties['error_code']
end

#error_messageString

Returns The description of the error_code.

Returns:

  • (String)

    The description of the error_code


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

def error_message
  @properties['error_message']
end

#feedbackfeedback

Access the feedback

Returns:


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

def feedback
  context.feedback
end

#fetchMessageInstance

Fetch the MessageInstance

Returns:


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

def fetch
  context.fetch
end

#fromString

Returns The phone number that initiated the message.

Returns:

  • (String)

    The phone number that initiated the message


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

def from
  @properties['from']
end

#inspectObject

Provide a detailed, user friendly representation


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

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

#mediamedia

Access the media

Returns:


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

def media
  context.media
end

#messaging_service_sidString

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

Returns:

  • (String)

    The SID of the Messaging Service used with the message.


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

def messaging_service_sid
  @properties['messaging_service_sid']
end

#num_mediaString

Returns The number of media files associated with the message.

Returns:

  • (String)

    The number of media files associated with the message


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

def num_media
  @properties['num_media']
end

#num_segmentsString

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

Returns:

  • (String)

    The number of messages used to deliver the message body


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

def num_segments
  @properties['num_segments']
end

#priceString

Returns The amount billed for the message.

Returns:

  • (String)

    The amount billed for the message


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

def price
  @properties['price']
end

#price_unitString

Returns The currency in which price is measured.

Returns:

  • (String)

    The currency in which price is measured


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

def price_unit
  @properties['price_unit']
end

#sidString

Returns The unique string that identifies the resource.

Returns:

  • (String)

    The unique string that identifies the resource


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

def sid
  @properties['sid']
end

#statusmessage.Status

Returns The status of the message.

Returns:

  • (message.Status)

    The status of the message


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

def status
  @properties['status']
end

#subresource_urisString

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

Returns:

  • (String)

    A list of related resources identified by their relative URIs


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

def subresource_uris
  @properties['subresource_uris']
end

#toString

Returns The phone number that received the message.

Returns:

  • (String)

    The phone number that received the message


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

def to
  @properties['to']
end

#to_sObject

Provide a user friendly representation


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

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

#update(body: :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.

Returns:


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

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

#uriString

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

Returns:


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

def uri
  @properties['uri']
end