Class: Twilio::REST::Events::V1::SubscriptionContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/events/v1/subscription.rb,
lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Defined Under Namespace

Classes: SubscribedEventContext, SubscribedEventInstance, SubscribedEventList, SubscribedEventPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ SubscriptionContext

Initialize the SubscriptionContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this Subscription.



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 165

def initialize(version, sid)
    super(version)

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/Subscriptions/#{@solution[:sid]}"

    # Dependents
    @subscribed_events = nil
end

Instance Method Details

#delete ⇒ Boolean

Delete the SubscriptionInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



178
179
180
181
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 178

def delete

    @version.delete('DELETE', @uri)
end

#fetch ⇒ SubscriptionInstance

Fetch the SubscriptionInstance

Returns:



186
187
188
189
190
191
192
193
194
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 186

def fetch

    payload = @version.fetch('GET', @uri)
    SubscriptionInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



248
249
250
251
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 248

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Events.V1.SubscriptionContext #{context}>"
end

#subscribed_events(type = :unset) ⇒ SubscribedEventList, SubscribedEventContext

Access the subscribed_events

Returns:

Raises:

  • (ArgumentError) 


223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 223

def subscribed_events(type=:unset)

    raise ArgumentError, 'type cannot be nil' if type.nil?

    if type != :unset
        return SubscribedEventContext.new(@version, @solution[:sid],type )
    end

    unless @subscribed_events
        @subscribed_events = SubscribedEventList.new(
            @version, subscription_sid: @solution[:sid], )
    end

 @subscribed_events
end

#to_s ⇒ Object

Provide a user friendly representation



241
242
243
244
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 241

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Events.V1.SubscriptionContext #{context}>"
end

#update(description: :unset, sink_sid: :unset) ⇒ SubscriptionInstance

Update the SubscriptionInstance

Parameters:

  • description (String) (defaults to: :unset) —

    A human readable description for the Subscription.

  • sink_sid (String) (defaults to: :unset) —

    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.

Returns:



201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 201

def update(
    description: :unset, 
    sink_sid: :unset
)

    data = Twilio::Values.of({
        'Description' => description,
        'SinkSid' => sink_sid,
    })

    payload = @version.update('POST', @uri, data: data)
    SubscriptionInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end