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

Inherits:
InstanceContext
  • 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, subscription_sid, type) ⇒ SubscribedEventContext

Initialize the SubscribedEventContext

Parameters:

  • version (Version)

    Version that contains the resource

  • subscription_sid (String)

    The unique SID identifier of the Subscription.

  • type (String)

    Type of event being subscribed to.


171
172
173
174
175
176
177
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 171

def initialize(version, subscription_sid, type)
  super(version)

  # Path Solution
  @solution = {subscription_sid: subscription_sid, type: type, }
  @uri = "/Subscriptions/#{@solution[:subscription_sid]}/SubscribedEvents/#{@solution[:type]}"
end

Instance Method Details

#deleteBoolean

Delete the SubscribedEventInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


214
215
216
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 214

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

#fetchSubscribedEventInstance

Fetch the SubscribedEventInstance

Returns:


182
183
184
185
186
187
188
189
190
191
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 182

def fetch
  payload = @version.fetch('GET', @uri)

  SubscribedEventInstance.new(
      @version,
      payload,
      subscription_sid: @solution[:subscription_sid],
      type: @solution[:type],
  )
end

#inspectObject

Provide a detailed, user friendly representation


227
228
229
230
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 227

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

#to_sObject

Provide a user friendly representation


220
221
222
223
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 220

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

#update(schema_version: :unset) ⇒ SubscribedEventInstance

Update the SubscribedEventInstance

Parameters:

  • schema_version (String) (defaults to: :unset)

    The schema version that the subscription should use.

Returns:


198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/twilio-ruby/rest/events/v1/subscription/subscribed_event.rb', line 198

def update(schema_version: :unset)
  data = Twilio::Values.of({'SchemaVersion' => schema_version, })

  payload = @version.update('POST', @uri, data: data)

  SubscribedEventInstance.new(
      @version,
      payload,
      subscription_sid: @solution[:subscription_sid],
      type: @solution[:type],
  )
end