Class: Twilio::REST::Events::V1::SubscriptionInstance

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ SubscriptionInstance

Initialize the SubscriptionInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    A 34 character string that uniquely identifies this Subscription.



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 262

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'sid' => payload['sid'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'description' => payload['description'],
      'sink_sid' => payload['sink_sid'],
      'url' => payload['url'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns Account SID.

Returns:

  • (String) —

    Account SID.



295
296
297
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 295

def 
  @properties['account_sid']
end

#context ⇒ SubscriptionContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 286

def context
  unless @instance_context
    @instance_context = SubscriptionContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The date this Subscription was created.

Returns:

  • (Time) —

    The date this Subscription was created



307
308
309
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 307

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Subscription was updated.

Returns:

  • (Time) —

    The date this Subscription was updated



313
314
315
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 313

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SubscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



362
363
364
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 362

def delete
  context.delete
end

#description ⇒ String

Returns Subscription description.

Returns:

  • (String) —

    Subscription description



319
320
321
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 319

def description
  @properties['description']
end

#fetch ⇒ SubscriptionInstance

Fetch the SubscriptionInstance

Returns:



344
345
346
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 344

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



382
383
384
385
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 382

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Events.V1.SubscriptionInstance #{values}>"
end

#links ⇒ String

Returns Nested resource URLs.

Returns:

  • (String) —

    Nested resource URLs.



337
338
339
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 337

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Subscription.

Returns:

  • (String) —

    A string that uniquely identifies this Subscription.



301
302
303
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 301

def sid
  @properties['sid']
end

#sink_sid ⇒ String

Returns Sink SID.

Returns:

  • (String) —

    Sink SID.



325
326
327
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 325

def sink_sid
  @properties['sink_sid']
end

#subscribed_events ⇒ subscribed_events

Access the subscribed_events

Returns:



369
370
371
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 369

def subscribed_events
  context.subscribed_events
end

#to_s ⇒ Object

Provide a user friendly representation



375
376
377
378
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 375

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Events.V1.SubscriptionInstance #{values}>"
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:



355
356
357
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 355

def update(description: :unset, sink_sid: :unset)
  context.update(description: description, sink_sid: sink_sid, )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



331
332
333
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 331

def url
  @properties['url']
end