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.



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 246

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.



279
280
281
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 279

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:



270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 270

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



291
292
293
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 291

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the SubscriptionInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#description ⇒ String

Returns Subscription description.

Returns:

  • (String) —

    Subscription description



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

def description
  @properties['description']
end

#fetch ⇒ SubscriptionInstance

Fetch the SubscriptionInstance

Returns:



328
329
330
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 328

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def links
  @properties['links']
end

#sid ⇒ String

Returns A string that uniquely identifies this Subscription.

Returns:

  • (String) —

    A string that uniquely identifies this Subscription.



285
286
287
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 285

def sid
  @properties['sid']
end

#sink_sid ⇒ String

Returns Sink SID.

Returns:

  • (String) —

    Sink SID.



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

def sink_sid
  @properties['sink_sid']
end

#subscribed_events ⇒ subscribed_events

Access the subscribed_events

Returns:



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

def subscribed_events
  context.subscribed_events
end

#to_s ⇒ Object

Provide a user friendly representation



348
349
350
351
 
# File 'lib/twilio-ruby/rest/events/v1/subscription.rb', line 348

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

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end