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

Defined Under Namespace

Classes: SubscribedEventContext, SubscribedEventInstance, SubscribedEventInstanceMetadata, SubscribedEventList, SubscribedEventListResponse, SubscribedEventPage, SubscribedEventPageMetadata

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.



243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 243

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



257
258
259
260
261
262
263
264
265
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 257

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

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

#delete_with_metadata ⇒ Boolean

Delete the SubscriptionInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 270

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      subscription_instance = SubscriptionInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      SubscriptionInstanceMetadata.new(@version, subscription_instance, response.headers, response.status_code)
end

#fetch ⇒ SubscriptionInstance

Fetch the SubscriptionInstance

Returns:



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 289

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    SubscriptionInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ SubscriptionInstance

Fetch the SubscriptionInstanceMetadata

Returns:



308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 308

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    subscription_instance = SubscriptionInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    SubscriptionInstanceMetadata.new(
        @version,
        subscription_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



417
418
419
420
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 417

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) 


392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 392

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



410
411
412
413
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 410

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

#update(description: :unset) ⇒ SubscriptionInstance

Update the SubscriptionInstance

Parameters:

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

    A human readable description for the Subscription.

Returns:



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 334

def update(
  description: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    SubscriptionInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#update_with_metadata(description: :unset) ⇒ SubscriptionInstance

Update the SubscriptionInstanceMetadata

Parameters:

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

    A human readable description for the Subscription.

Returns:



360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 360

def update_with_metadata(
  description: :unset
)

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    subscription_instance = SubscriptionInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    SubscriptionInstanceMetadata.new(
        @version,
        subscription_instance,
        response.headers,
        response.status_code
    )
end