Class: Twilio::REST::Messaging::V1::SessionContext::WebhookInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/session/webhook.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, session_sid: nil, sid: nil) ⇒ WebhookInstance

Initialize the WebhookInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The unique id of the [Session](www.twilio.com/docs/sessions/api/session) for this webhook.

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

    A 34 character string that uniquely identifies this resource.



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 305

def initialize(version, payload, session_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'session_sid' => payload['session_sid'],
      'target' => payload['target'],
      '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 = {'session_sid' => session_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for this session.

Returns:

  • (String) —

    The unique id of the Account responsible for this session.



344
345
346
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 344

def 
  @properties['account_sid']
end

#configuration ⇒ Hash

Returns The configuration of this webhook.

Returns:

  • (Hash) —

    The configuration of this webhook.



368
369
370
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 368

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:



329
330
331
332
333
334
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 329

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

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



374
375
376
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 374

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



380
381
382
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 380

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



426
427
428
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 426

def delete
  context.delete
end

#fetch ⇒ WebhookInstance

Fetch a WebhookInstance

Returns:



387
388
389
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 387

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



439
440
441
442
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 439

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

#session_sid ⇒ String

Returns The unique id of the Session for this webhook.

Returns:

  • (String) —

    The unique id of the Session for this webhook.



350
351
352
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 350

def session_sid
  @properties['session_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



338
339
340
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 338

def sid
  @properties['sid']
end

#target ⇒ String

Returns The target of this webhook.

Returns:

  • (String) —

    The target of this webhook.



356
357
358
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 356

def target
  @properties['target']
end

#to_s ⇒ Object

Provide a user friendly representation



432
433
434
435
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 432

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

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

Update the WebhookInstance

Parameters:

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

    The absolute url the webhook request should be sent to.

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

    The HTTP method to be used when sending a webhook request.

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

    The list of events, firing webhook event for this Session.

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

    The list of keywords, firing webhook event for this Session.

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

    The studio flow sid, where the webhook should be sent to.

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

    The number of retries in case of webhook request failures. Maximum 3 retries are allowed, the default value is 0.

  • configuration_buffer_messages (Boolean) (defaults to: :unset) —

    The flag whether buffering should be applied to messages. Not set by default

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

    The period of buffering messages. Default is 3000 ms.

Returns:



410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 410

def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :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,
      configuration_buffer_messages: configuration_buffer_messages,
      configuration_buffer_window: configuration_buffer_window,
  )
end

#url ⇒ String

Returns An absolute URL for this webhook.

Returns:

  • (String) —

    An absolute URL for this webhook.



362
363
364
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 362

def url
  @properties['url']
end