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

Inherits:
InstanceResource
  • Object
show all
Defined in:
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.

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, subscription_sid: nil, type: nil) ⇒ SubscribedEventInstance

Initialize the SubscribedEventInstance



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

def initialize(version, payload, subscription_sid: nil, type: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'type' => payload['type'],
      'schema_version' => payload['schema_version'].to_i,
      'subscription_sid' => payload['subscription_sid'],
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String 



277
278
279
 
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 277

def 
  @properties['account_sid']
end

#context ⇒ SubscribedEventContext

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



264
265
266
267
268
269
270
271
272
273
 
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 264

def context
  unless @instance_context
    @instance_context = SubscribedEventContext.new(
        @version,
        @params['subscription_sid'],
        @params['type'],
    )
  end
  @instance_context
end

#delete ⇒ Boolean

Delete the SubscribedEventInstance



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

def delete
  context.delete
end

#fetch ⇒ SubscribedEventInstance

Fetch the SubscribedEventInstance



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#schema_version ⇒ String 



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

def schema_version
  @properties['schema_version']
end

#subscription_sid ⇒ String 



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

def subscription_sid
  @properties['subscription_sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#type ⇒ String 



283
284
285
 
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 283

def type
  @properties['type']
end

#update(schema_version: :unset) ⇒ SubscribedEventInstance

Update the SubscribedEventInstance



317
318
319
 
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 317

def update(schema_version: :unset)
  context.update(schema_version: schema_version, )
end

#url ⇒ String 



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

def url
  @properties['url']
end