class Twilio::REST::Events::V1::SubscriptionInstance
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Public Class Methods
Initialize the SubscriptionInstance
@param [Version] version Version
that contains the resource @param [Hash] payload payload that contains response from Twilio
@param [String] sid A 34 character string that uniquely identifies this
Subscription.
@return [SubscriptionInstance] SubscriptionInstance
Twilio::REST::InstanceResource::new
# File lib/twilio-ruby/rest/events/v1/subscription.rb 269 def initialize(version, payload, sid: nil) 270 super(version) 271 272 # Marshaled Properties 273 @properties = { 274 'account_sid' => payload['account_sid'], 275 'sid' => payload['sid'], 276 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']), 277 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']), 278 'description' => payload['description'], 279 'sink_sid' => payload['sink_sid'], 280 'url' => payload['url'], 281 'links' => payload['links'], 282 } 283 284 # Context 285 @instance_context = nil 286 @params = {'sid' => sid || @properties['sid'], } 287 end
Public Instance Methods
@return [String] Account SID.
# File lib/twilio-ruby/rest/events/v1/subscription.rb 302 def account_sid 303 @properties['account_sid'] 304 end
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [SubscriptionContext] SubscriptionContext
for this SubscriptionInstance
# File lib/twilio-ruby/rest/events/v1/subscription.rb 293 def context 294 unless @instance_context 295 @instance_context = SubscriptionContext.new(@version, @params['sid'], ) 296 end 297 @instance_context 298 end
@return [Time] The date this Subscription was created
# File lib/twilio-ruby/rest/events/v1/subscription.rb 314 def date_created 315 @properties['date_created'] 316 end
@return [Time] The date this Subscription was updated
# File lib/twilio-ruby/rest/events/v1/subscription.rb 320 def date_updated 321 @properties['date_updated'] 322 end
Delete the SubscriptionInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/events/v1/subscription.rb 369 def delete 370 context.delete 371 end
@return [String] Subscription description
# File lib/twilio-ruby/rest/events/v1/subscription.rb 326 def description 327 @properties['description'] 328 end
Fetch the SubscriptionInstance
@return [SubscriptionInstance] Fetched SubscriptionInstance
# File lib/twilio-ruby/rest/events/v1/subscription.rb 351 def fetch 352 context.fetch 353 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/events/v1/subscription.rb 389 def inspect 390 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") 391 "<Twilio.Events.V1.SubscriptionInstance #{values}>" 392 end
@return [String] Nested resource URLs.
# File lib/twilio-ruby/rest/events/v1/subscription.rb 344 def links 345 @properties['links'] 346 end
@return [String] A string that uniquely identifies this Subscription.
# File lib/twilio-ruby/rest/events/v1/subscription.rb 308 def sid 309 @properties['sid'] 310 end
@return [String] Sink SID.
# File lib/twilio-ruby/rest/events/v1/subscription.rb 332 def sink_sid 333 @properties['sink_sid'] 334 end
Access the subscribed_events
@return [subscribed_events] subscribed_events
# File lib/twilio-ruby/rest/events/v1/subscription.rb 376 def subscribed_events 377 context.subscribed_events 378 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/events/v1/subscription.rb 382 def to_s 383 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") 384 "<Twilio.Events.V1.SubscriptionInstance #{values}>" 385 end
Update the SubscriptionInstance
@param [String] description A human readable description for the Subscription. @param [String] sink_sid
The SID of the sink that events selected by this
subscription should be sent to. Sink must be active for the subscription to be created.
@return [SubscriptionInstance] Updated SubscriptionInstance
# File lib/twilio-ruby/rest/events/v1/subscription.rb 362 def update(description: :unset, sink_sid: :unset) 363 context.update(description: description, sink_sid: sink_sid, ) 364 end
@return [String] The URL of this resource.
# File lib/twilio-ruby/rest/events/v1/subscription.rb 338 def url 339 @properties['url'] 340 end