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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, call_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 SID of the Account that created this Notification resource.

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

    The SID of the Call resource to fetch.



239
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
 
# File 'lib/twilio-ruby/rest/api/v2010/account/call/notification.rb', line 239

def initialize(version, payload , account_sid: nil, call_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'],
        'request_variables' => payload['request_variables'],
        'response_body' => payload['response_body'],
        'response_headers' => payload['response_headers'],
        'sid' => payload['sid'],
        'uri' => payload['uri'],
    }

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Call Notification resource.

Returns:



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

def 
    @properties['account_sid']
end

#api_version ⇒ String

Returns The API version used to create the Call Notification resource.

Returns:

  • (String) —

    The API version used to create the Call Notification resource.



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

def api_version
    @properties['api_version']
end

#call_sid ⇒ String

Returns The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Call Notification resource is associated with.

Returns:



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

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:



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

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

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#error_code ⇒ String

Returns A unique error code for the error condition that is described in our [Error Dictionary](www.twilio.com/docs/api/errors).

Returns:



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

def error_code
    @properties['error_code']
end

#fetch ⇒ NotificationInstance

Fetch the NotificationInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#log ⇒ String

Returns An integer log level that corresponds to the type of notification: ‘0` is ERROR, `1` is WARNING.

Returns:

  • (String) —

    An integer log level that corresponds to the type of notification: ‘0` is ERROR, `1` is WARNING.



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

def log
    @properties['log']
end

#message_date ⇒ Time

Returns The date the notification was actually generated in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format. Message buffering can cause this value to differ from ‘date_created`.

Returns:

  • (Time) —

    The date the notification was actually generated in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format. Message buffering can cause this value to differ from ‘date_created`.



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

def message_date
    @properties['message_date']
end

#message_text ⇒ String

Returns The text of the notification.

Returns:

  • (String) —

    The text of the notification.



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

def message_text
    @properties['message_text']
end

#more_info ⇒ String

Returns The URL for more information about the error condition. This value is a page in our [Error Dictionary](www.twilio.com/docs/api/errors).

Returns:

  • (String) —

    The URL for more information about the error condition. This value is a page in our [Error Dictionary](www.twilio.com/docs/api/errors).



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

def more_info
    @properties['more_info']
end

#request_method ⇒ String

Returns The HTTP method used to generate the notification. If the notification was generated during a phone call, this is the HTTP Method used to request the resource on your server. If the notification was generated by your use of our REST API, this is the HTTP method used to call the resource on our servers.

Returns:

  • (String) —

    The HTTP method used to generate the notification. If the notification was generated during a phone call, this is the HTTP Method used to request the resource on your server. If the notification was generated by your use of our REST API, this is the HTTP method used to call the resource on our servers.



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

def request_method
    @properties['request_method']
end

#request_url ⇒ String

Returns The URL of the resource that generated the notification. If the notification was generated during a phone call, this is the URL of the resource on your server that caused the notification. If the notification was generated by your use of our REST API, this is the URL of the resource you called.

Returns:

  • (String) —

    The URL of the resource that generated the notification. If the notification was generated during a phone call, this is the URL of the resource on your server that caused the notification. If the notification was generated by your use of our REST API, this is the URL of the resource you called.



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

def request_url
    @properties['request_url']
end

#request_variables ⇒ String

Returns The HTTP GET or POST variables we sent to your server. However, if the notification was generated by our REST API, this contains the HTTP POST or PUT variables you sent to our API.

Returns:

  • (String) —

    The HTTP GET or POST variables we sent to your server. However, if the notification was generated by our REST API, this contains the HTTP POST or PUT variables you sent to our API.



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

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.



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

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.



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

def response_headers
    @properties['response_headers']
end

#sid ⇒ String

Returns The unique string that that we created to identify the Call Notification resource.

Returns:

  • (String) —

    The unique string that that we created to identify the Call Notification resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Api.V2010.NotificationInstance #{values}>"
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`.



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

def uri
    @properties['uri']
end