Class: Twilio::REST::Events::V1::SubscriptionContext::SubscribedEventInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Events::V1::SubscriptionContext::SubscribedEventInstance
- Defined in:
- lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique SID identifier of the Account.
-
#context ⇒ SubscribedEventContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#delete ⇒ Boolean
Delete the SubscribedEventInstance.
-
#fetch ⇒ SubscribedEventInstance
Fetch the SubscribedEventInstance.
-
#initialize(version, payload, subscription_sid: nil, type: nil) ⇒ SubscribedEventInstance
constructor
Initialize the SubscribedEventInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#schema_version ⇒ String
The schema version that the subscription should use.
-
#subscription_sid ⇒ String
The unique SID identifier of the Subscription.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#type ⇒ String
Type of event being subscribed to.
-
#update(schema_version: :unset) ⇒ SubscribedEventInstance
Update the SubscribedEventInstance.
-
#url ⇒ String
The URL of this resource.
Constructor Details
#initialize(version, payload, subscription_sid: nil, type: nil) ⇒ SubscribedEventInstance
Initialize the SubscribedEventInstance
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 267 def initialize(version, payload , subscription_sid: nil, type: nil) super(version) # Marshaled Properties @properties = { 'account_sid' => payload['account_sid'], 'type' => payload['type'], 'schema_version' => payload['schema_version'] == nil ? payload['schema_version'] : payload['schema_version'].to_i, 'subscription_sid' => payload['subscription_sid'], 'url' => payload['url'], } # Context @instance_context = nil @params = { 'subscription_sid' => subscription_sid || @properties['subscription_sid'] ,'type' => type || @properties['type'] , } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique SID identifier of the Account.
297 298 299 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 297 def account_sid @properties['account_sid'] end |
#context ⇒ SubscribedEventContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
288 289 290 291 292 293 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 288 def context unless @instance_context @instance_context = SubscribedEventContext.new(@version , @params['subscription_sid'], @params['type']) end @instance_context end |
#delete ⇒ Boolean
Delete the SubscribedEventInstance
328 329 330 331 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 328 def delete context.delete end |
#fetch ⇒ SubscribedEventInstance
Fetch the SubscribedEventInstance
336 337 338 339 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 336 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
363 364 365 366 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 363 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Events.V1.SubscribedEventInstance #{values}>" end |
#schema_version ⇒ String
Returns The schema version that the subscription should use.
309 310 311 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 309 def schema_version @properties['schema_version'] end |
#subscription_sid ⇒ String
Returns The unique SID identifier of the Subscription.
315 316 317 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 315 def subscription_sid @properties['subscription_sid'] end |
#to_s ⇒ Object
Provide a user friendly representation
356 357 358 359 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 356 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Events.V1.SubscribedEventInstance #{values}>" end |
#type ⇒ String
Returns Type of event being subscribed to.
303 304 305 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 303 def type @properties['type'] end |
#update(schema_version: :unset) ⇒ SubscribedEventInstance
Update the SubscribedEventInstance
345 346 347 348 349 350 351 352 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 345 def update( schema_version: :unset ) context.update( schema_version: schema_version, ) end |
#url ⇒ String
Returns The URL of this resource.
321 322 323 |
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 321 def url @properties['url'] end |