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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Api::V2010::AccountContext::MessageInstance

Defined in:

lib/twilio-ruby/rest/api/v2010/account/message.rb

Instance Method Summary

• #account_sid ⇒ String

  The unique sid that identifies this account.

• #api_version ⇒ String

  The version of the Twilio API used to process the message.

• #body ⇒ String

  The text body of the message.

• #context ⇒ MessageContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The date this resource was created.

• #date_sent ⇒ Time

  The date the message was sent.

• #date_updated ⇒ Time

  The date this resource was last updated.

• #delete ⇒ Boolean

  Deletes the MessageInstance.

• #direction ⇒ message.Direction

  The direction of the message.

• #error_code ⇒ String

  The error code associated with the message.

• #error_message ⇒ String

  Human readable description of the ErrorCode.

• #feedback ⇒ feedback

  Access the feedback.

• #fetch ⇒ MessageInstance

  Fetch a MessageInstance.

• #from ⇒ String

  The phone number that initiated the message.

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

  Initialize the MessageInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #media ⇒ media

  Access the media.

• #messaging_service_sid ⇒ String

  The unique id of the Messaging Service used with the message.

• #num_media ⇒ String

  Number of media files associated with the message.

• #num_segments ⇒ String

  Indicates number of messages used to delivery the body.

• #price ⇒ String

  The amount billed for the message.

• #price_unit ⇒ String

  The currency in which Price is measured.

• #sid ⇒ String

  A string that uniquely identifies this message.

• #status ⇒ message.Status

  The status of this message.

• #subresource_uris ⇒ String

  The URI for any subresources.

• #to ⇒ String

  The phone number that received the message.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(body: nil) ⇒ MessageInstance

  Update the MessageInstance.

• #uri ⇒ String

  The URI for this resource.

Constructor Details

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

Initialize the MessageInstance

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

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'].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'].to_f,
      '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' => account_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

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

def account_sid
  @properties['account_sid']
end

#api_version ⇒ String

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

def api_version
  @properties['api_version']
end

#body ⇒ String

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

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

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

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

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_sent ⇒ Time

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

def date_sent
  @properties['date_sent']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the MessageInstance

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

def delete
  context.delete
end

#direction ⇒ message.Direction

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

def direction
  @properties['direction']
end

#error_code ⇒ String

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

def error_code
  @properties['error_code']
end

#error_message ⇒ String

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

def error_message
  @properties['error_message']
end

#feedback ⇒ feedback

Access the feedback

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

def feedback
  context.feedback
end

#fetch ⇒ MessageInstance

Fetch a MessageInstance

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

def fetch
  context.fetch
end

#from ⇒ String

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

def from
  @properties['from']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#media ⇒ media

Access the media

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

def media
  context.media
end

#messaging_service_sid ⇒ String

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

def messaging_service_sid
  @properties['messaging_service_sid']
end

#num_media ⇒ String

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

def num_media
  @properties['num_media']
end

#num_segments ⇒ String

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

def num_segments
  @properties['num_segments']
end

#price ⇒ String

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

def price
  @properties['price']
end

#price_unit ⇒ String

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

def price_unit
  @properties['price_unit']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#status ⇒ message.Status

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

def status
  @properties['status']
end

#subresource_uris ⇒ String

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

def subresource_uris
  @properties['subresource_uris']
end

#to ⇒ String

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

def to
  @properties['to']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#update(body: nil) ⇒ MessageInstance

Update the MessageInstance

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

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

#uri ⇒ String

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

def uri
  @properties['uri']
end