Class: Twilio::REST::Api::V2010::AccountContext::NotificationInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the NotificationInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique id of the [Account](www.twilio.com/docs/iam/api/account) responsible for this notification.

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

    The notification Sid that uniquely identifies this resource



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 240

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'api_version' => payload['api_version'],
      'call_sid' => payload['call_sid'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'error_code' => payload['error_code'],
      'log' => payload['log'],
      'message_date' => Twilio.deserialize_rfc2822(payload['message_date']),
      'message_text' => payload['message_text'],
      'more_info' => payload['more_info'],
      'request_method' => payload['request_method'],
      'request_url' => payload['request_url'],
      'sid' => payload['sid'],
      'uri' => payload['uri'],
      'request_variables' => payload['request_variables'],
      'response_body' => payload['response_body'],
      'response_headers' => payload['response_headers'],
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The unique sid that identifies this account.

Returns:

  • (String) —

    The unique sid that identifies this account



282
283
284
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 282

def 
  @properties['account_sid']
end

#api_version ⇒ String

Returns The version of the Twilio API in use.

Returns:

  • (String) —

    The version of the Twilio API in use



288
289
290
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 288

def api_version
  @properties['api_version']
end

#call_sid ⇒ String

Returns The string that uniquely identifies the call.

Returns:

  • (String) —

    The string that uniquely identifies the call



294
295
296
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 294

def call_sid
  @properties['call_sid']
end

#context ⇒ NotificationContext

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

Returns:



273
274
275
276
277
278
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 273

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

#date_created ⇒ Time

Returns The date this resource was created.

Returns:

  • (Time) —

    The date this resource was created



300
301
302
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 300

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this resource was last updated.

Returns:

  • (Time) —

    The date this resource was last updated



306
307
308
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 306

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the NotificationInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#error_code ⇒ String

Returns A unique error code corresponding to the notification.

Returns:

  • (String) —

    A unique error code corresponding to the notification



312
313
314
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 312

def error_code
  @properties['error_code']
end

#fetch ⇒ NotificationInstance

Fetch a NotificationInstance

Returns:



385
386
387
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 385

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



405
406
407
408
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 405

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

#log ⇒ String

Returns An integer log level.

Returns:

  • (String) —

    An integer log level



318
319
320
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 318

def log
  @properties['log']
end

#message_date ⇒ Time

Returns The date the notification was generated.

Returns:

  • (Time) —

    The date the notification was generated



324
325
326
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 324

def message_date
  @properties['message_date']
end

#message_text ⇒ String

Returns The text of the notification.

Returns:

  • (String) —

    The text of the notification.



330
331
332
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 330

def message_text
  @properties['message_text']
end

#more_info ⇒ String

Returns A URL for more information about the error code.

Returns:

  • (String) —

    A URL for more information about the error code



336
337
338
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 336

def more_info
  @properties['more_info']
end

#request_method ⇒ String

Returns HTTP method used with the request url.

Returns:

  • (String) —

    HTTP method used with the request url



342
343
344
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 342

def request_method
  @properties['request_method']
end

#request_url ⇒ String

Returns URL of the resource that generated the notification.

Returns:

  • (String) —

    URL of the resource that generated the notification



348
349
350
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 348

def request_url
  @properties['request_url']
end

#request_variables ⇒ String

Returns Twilio-generated HTTP variables sent to the server.

Returns:

  • (String) —

    Twilio-generated HTTP variables sent to the server



354
355
356
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 354

def request_variables
  @properties['request_variables']
end

#response_body ⇒ String

Returns The HTTP body returned by your server.

Returns:

  • (String) —

    The HTTP body returned by your server.



360
361
362
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 360

def response_body
  @properties['response_body']
end

#response_headers ⇒ String

Returns The HTTP headers returned by your server.

Returns:

  • (String) —

    The HTTP headers returned by your server.



366
367
368
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 366

def response_headers
  @properties['response_headers']
end

#sid ⇒ String

Returns A string that uniquely identifies this notification.

Returns:

  • (String) —

    A string that uniquely identifies this notification



372
373
374
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 372

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



398
399
400
401
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 398

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

#uri ⇒ String

Returns The URI for this resource.

Returns:

  • (String) —

    The URI for this resource



378
379
380
 
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 378

def uri
  @properties['uri']
end