Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::WebhookContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, channel_sid, sid) ⇒ WebhookContext

Initialize the WebhookContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The service_sid

  • channel_sid (String) —

    The channel_sid

  • sid (String) —

    The sid



197
198
199
200
201
202
203
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 197

def initialize(version, service_sid, channel_sid, sid)
  super(version)

  # Path Solution
  @solution = {service_sid: service_sid, channel_sid: channel_sid, sid: sid, }
  @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



263
264
265
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 263

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

#fetch ⇒ WebhookInstance

Fetch a WebhookInstance

Returns:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 208

def fetch
  params = Twilio::Values.of({})

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

  WebhookInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      channel_sid: @solution[:channel_sid],
      sid: @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



269
270
271
272
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 269

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

#update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

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

    The configuration.url

  • configuration_method (webhook.Method) (defaults to: :unset) —

    The configuration.method

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

    The configuration.filters

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

    The configuration.triggers

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

    The configuration.flow_sid

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

    The configuration.retry_count

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 235

def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
  data = Twilio::Values.of({
      'Configuration.Url' => configuration_url,
      'Configuration.Method' => configuration_method,
      'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
      'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
      'Configuration.FlowSid' => configuration_flow_sid,
      'Configuration.RetryCount' => configuration_retry_count,
  })

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

  WebhookInstance.new(
      @version,
      payload,
      service_sid: @solution[:service_sid],
      channel_sid: @solution[:channel_sid],
      sid: @solution[:sid],
  )
end