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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil, channel_sid: nil, sid: nil) ⇒ WebhookInstance

Initialize the WebhookInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The service_sid

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

    The channel_sid

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

    The sid



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 284

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'service_sid' => payload['service_sid'],
      'channel_sid' => payload['channel_sid'],
      'type' => payload['type'],
      'url' => payload['url'],
      'configuration' => payload['configuration'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
  }

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

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



333
334
335
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 333

def 
  @properties['account_sid']
end

#channel_sid ⇒ String

Returns The channel_sid.

Returns:

  • (String) —

    The channel_sid



345
346
347
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 345

def channel_sid
  @properties['channel_sid']
end

#configuration ⇒ Hash

Returns The configuration.

Returns:

  • (Hash) —

    The configuration



363
364
365
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 363

def configuration
  @properties['configuration']
end

#context ⇒ WebhookContext

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

Returns:



313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 313

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



369
370
371
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 369

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



375
376
377
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 375

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



409
410
411
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 409

def delete
  context.delete
end

#fetch ⇒ WebhookInstance

Fetch a WebhookInstance

Returns:



382
383
384
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 382

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



422
423
424
425
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 422

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

#service_sid ⇒ String

Returns The service_sid.

Returns:

  • (String) —

    The service_sid



339
340
341
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 339

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



327
328
329
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 327

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



415
416
417
418
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 415

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

#type ⇒ String

Returns The type.

Returns:

  • (String) —

    The type



351
352
353
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 351

def type
  @properties['type']
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:



395
396
397
398
399
400
401
402
403
404
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 395

def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset)
  context.update(
      configuration_url: configuration_url,
      configuration_method: configuration_method,
      configuration_filters: configuration_filters,
      configuration_triggers: configuration_triggers,
      configuration_flow_sid: configuration_flow_sid,
      configuration_retry_count: configuration_retry_count,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



357
358
359
 
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 357

def url
  @properties['url']
end