class Twilio::REST::Events::V1::SubscriptionContext
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Public Class Methods
Initialize the SubscriptionContext
@param [Version] version Version
that contains the resource @param [String] sid A 34 character string that uniquely identifies this
Subscription.
@return [SubscriptionContext] SubscriptionContext
Twilio::REST::InstanceContext::new
# File lib/twilio-ruby/rest/events/v1/subscription.rb 184 def initialize(version, sid) 185 super(version) 186 187 # Path Solution 188 @solution = {sid: sid, } 189 @uri = "/Subscriptions/#{@solution[:sid]}" 190 191 # Dependents 192 @subscribed_events = nil 193 end
Public Instance Methods
Delete the SubscriptionInstance
@return [Boolean] true if delete succeeds, false otherwise
# File lib/twilio-ruby/rest/events/v1/subscription.rb 222 def delete 223 @version.delete('DELETE', @uri) 224 end
Fetch the SubscriptionInstance
@return [SubscriptionInstance] Fetched SubscriptionInstance
# File lib/twilio-ruby/rest/events/v1/subscription.rb 198 def fetch 199 payload = @version.fetch('GET', @uri) 200 201 SubscriptionInstance.new(@version, payload, sid: @solution[:sid], ) 202 end
Provide a detailed, user friendly representation
# File lib/twilio-ruby/rest/events/v1/subscription.rb 253 def inspect 254 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 255 "#<Twilio.Events.V1.SubscriptionContext #{context}>" 256 end
Access the subscribed_events
@return [SubscribedEventList] @return [SubscribedEventContext] if type was passed.
# File lib/twilio-ruby/rest/events/v1/subscription.rb 230 def subscribed_events(type=:unset) 231 raise ArgumentError, 'type cannot be nil' if type.nil? 232 233 if type != :unset 234 return SubscribedEventContext.new(@version, @solution[:sid], type, ) 235 end 236 237 unless @subscribed_events 238 @subscribed_events = SubscribedEventList.new(@version, subscription_sid: @solution[:sid], ) 239 end 240 241 @subscribed_events 242 end
Provide a user friendly representation
# File lib/twilio-ruby/rest/events/v1/subscription.rb 246 def to_s 247 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',') 248 "#<Twilio.Events.V1.SubscriptionContext #{context}>" 249 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 211 def update(description: :unset, sink_sid: :unset) 212 data = Twilio::Values.of({'Description' => description, 'SinkSid' => sink_sid, }) 213 214 payload = @version.update('POST', @uri, data: data) 215 216 SubscriptionInstance.new(@version, payload, sid: @solution[:sid], ) 217 end