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](www.twilio.com/docs/iam/api/account) that created the Notification resource.
-
#api_version ⇒ String
The API version used to generate the notification.
-
#call_sid ⇒ String
The SID of the [Call](www.twilio.com/docs/voice/api/call-resource) the Notification 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 date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#date_updated ⇒ Time
The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#error_code ⇒ String
A unique error code for the error condition that is described in our [Error Dictionary](www.twilio.com/docs/api/errors).
-
#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 that corresponds to the type of notification: ‘0` is ERROR, `1` is WARNING.
-
#message_date ⇒ Time
The date the notification was actually generated in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
-
#message_text ⇒ String
The text of the notification.
-
#more_info ⇒ String
The URL for more information about the error condition.
-
#request_method ⇒ String
The HTTP method used to generate the notification.
-
#request_url ⇒ String
The URL of the resource that generated the notification.
-
#request_variables ⇒ String
The HTTP GET or POST variables we sent to your 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 that we created to identify the Notification 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
236 237 238 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 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 236 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](www.twilio.com/docs/iam/api/account) that created the Notification resource.
278 279 280 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 278 def account_sid @properties['account_sid'] end |
#api_version ⇒ String
Returns The API version used to generate the notification. Can be empty for events that don’t have a specific API version, such as incoming phone calls.
284 285 286 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 284 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 Notification resource is associated with.
290 291 292 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 290 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
269 270 271 272 273 274 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 269 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 and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.
296 297 298 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 296 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.
302 303 304 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 302 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).
308 309 310 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 308 def error_code @properties['error_code'] end |
#fetch ⇒ NotificationInstance
Fetch the NotificationInstance
381 382 383 384 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 381 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
395 396 397 398 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 395 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.
314 315 316 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 314 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`.
320 321 322 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 320 def @properties['message_date'] end |
#message_text ⇒ String
Returns The text of the notification.
326 327 328 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 326 def @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).
332 333 334 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 332 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.
338 339 340 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 338 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.
344 345 346 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 344 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.
350 351 352 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 350 def request_variables @properties['request_variables'] end |
#response_body ⇒ String
Returns The HTTP body returned by your server.
356 357 358 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 356 def response_body @properties['response_body'] end |
#response_headers ⇒ String
Returns The HTTP headers returned by your server.
362 363 364 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 362 def response_headers @properties['response_headers'] end |
#sid ⇒ String
Returns The unique string that that we created to identify the Notification resource.
368 369 370 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 368 def sid @properties['sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
388 389 390 391 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 388 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`.
374 375 376 |
# File 'lib/twilio-ruby/rest/api/v2010/account/notification.rb', line 374 def uri @properties['uri'] end |