Class: Twilio::REST::Messaging::V1::SessionContext::WebhookInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Messaging::V1::SessionContext::WebhookInstance
- 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
-
#account_sid ⇒ String
The SID of the Account that created the resource.
-
#configuration ⇒ Hash
The configuration of the webhook.
-
#context ⇒ WebhookContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#date_created ⇒ Time
The ISO 8601 date and time in GMT when the resource was created.
-
#date_updated ⇒ Time
The ISO 8601 date and time in GMT when the resource was last updated.
-
#delete ⇒ Boolean
Deletes the WebhookInstance.
-
#fetch ⇒ WebhookInstance
Fetch a WebhookInstance.
-
#initialize(version, payload, session_sid: nil, sid: nil) ⇒ WebhookInstance
constructor
Initialize the WebhookInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#session_sid ⇒ String
The SID of the Session for the webhook.
-
#sid ⇒ String
The unique string that identifies the resource.
-
#target ⇒ String
The target of the webhook.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#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.
-
#url ⇒ String
The absolute URL of the webhook.
Constructor Details
#initialize(version, payload, session_sid: nil, sid: nil) ⇒ WebhookInstance
Initialize the WebhookInstance
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 301 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
340 341 342 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 340 def account_sid @properties['account_sid'] end |
#configuration ⇒ Hash
364 365 366 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 364 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
325 326 327 328 329 330 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 325 def context unless @instance_context @instance_context = WebhookContext.new(@version, @params['session_sid'], @params['sid'], ) end @instance_context end |
#date_created ⇒ Time
370 371 372 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 370 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
376 377 378 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 376 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Deletes the WebhookInstance
422 423 424 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 422 def delete context.delete end |
#fetch ⇒ WebhookInstance
Fetch a WebhookInstance
383 384 385 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 383 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
435 436 437 438 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 435 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Messaging.V1.WebhookInstance #{values}>" end |
#session_sid ⇒ String
346 347 348 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 346 def session_sid @properties['session_sid'] end |
#sid ⇒ String
334 335 336 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 334 def sid @properties['sid'] end |
#target ⇒ String
352 353 354 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 352 def target @properties['target'] end |
#to_s ⇒ Object
Provide a user friendly representation
428 429 430 431 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 428 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
406 407 408 409 410 411 412 413 414 415 416 417 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 406 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_window: configuration_buffer_window, ) end |
#url ⇒ String
358 359 360 |
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 358 def url @properties['url'] end |