Class: Twilio::REST::Api::V2010::AccountContext::NotificationInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Api::V2010::AccountContext::NotificationInstance
- Defined in:
- lib/twilio-ruby/rest/api/v2010/account/notification.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#api_version ⇒ String
The API version used to generate the notification.
-
#call_sid ⇒ String
The SID of the Call the resource is associated with.
-
#context ⇒ NotificationContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The RFC 2822 date and time in GMT that the resource was created.
-
#date_updated ⇒ Time
The RFC 2822 date and time in GMT that the resource was last updated.
-
#error_code ⇒ String
A unique error code corresponding to the notification.
-
#fetch ⇒ NotificationInstance
Fetch the NotificationInstance.
-
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ NotificationInstance
constructor
Initialize the NotificationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#log ⇒ String
An integer log level.
-
#message_date ⇒ Time
The date the notification was generated.
-
#message_text ⇒ String
The text of the notification.
-
#more_info ⇒ String
A URL for more information about the error code.
-
#request_method ⇒ String
HTTP method used with the request url.
-
#request_url ⇒ String
URL of the resource that generated the notification.
-
#request_variables ⇒ String
Twilio-generated HTTP variables sent to the server.
-
#response_body ⇒ String
The HTTP body returned by your server.
-
#response_headers ⇒ String
The HTTP headers returned by your server.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#uri ⇒ String
The URI of the resource, relative to `api.twilio.com`.
Constructor Details
#initialize(version, payload, account_sid: nil, sid: nil) ⇒ NotificationInstance
Initialize the NotificationInstance
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/notification.rb', line 239 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'], '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' => account_sid, 'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The SID of the Account that created the resource.
281 282 283 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 281 def account_sid @properties['account_sid'] end |
#api_version ⇒ String
Returns The API version used to generate the notification.
287 288 289 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 287 def api_version @properties['api_version'] end |
#call_sid ⇒ String
Returns The SID of the Call the resource is associated with.
293 294 295 |
# File 'lib/twilio-ruby/rest/api/v2010/account/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
272 273 274 275 276 277 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 272 def context unless @instance_context @instance_context = NotificationContext.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.
299 300 301 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 299 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The RFC 2822 date and time in GMT that the resource was last updated.
305 306 307 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 305 def date_updated @properties['date_updated'] end |
#error_code ⇒ String
Returns A unique error code corresponding to the notification.
311 312 313 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 311 def error_code @properties['error_code'] end |
#fetch ⇒ NotificationInstance
Fetch the NotificationInstance
384 385 386 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 384 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
397 398 399 400 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 397 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Api.V2010.NotificationInstance #{values}>" end |
#log ⇒ String
Returns An integer log level.
317 318 319 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 317 def log @properties['log'] end |
#message_date ⇒ Time
Returns The date the notification was generated.
323 324 325 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 323 def @properties['message_date'] end |
#message_text ⇒ String
Returns The text of the notification.
329 330 331 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 329 def @properties['message_text'] end |
#more_info ⇒ String
Returns A URL for more information about the error code.
335 336 337 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 335 def more_info @properties['more_info'] end |
#request_method ⇒ String
Returns HTTP method used with the request url.
341 342 343 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 341 def request_method @properties['request_method'] end |
#request_url ⇒ String
Returns URL of the resource that generated the notification.
347 348 349 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 347 def request_url @properties['request_url'] end |
#request_variables ⇒ String
Returns Twilio-generated HTTP variables sent to the server.
353 354 355 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 353 def request_variables @properties['request_variables'] end |
#response_body ⇒ String
Returns The HTTP body returned by your server.
359 360 361 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 359 def response_body @properties['response_body'] end |
#response_headers ⇒ String
Returns The HTTP headers returned by your server.
365 366 367 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 365 def response_headers @properties['response_headers'] end |
#sid ⇒ String
Returns The unique string that identifies the resource.
371 372 373 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 371 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
390 391 392 393 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 390 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`.
377 378 379 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 377 def uri @properties['uri'] end |