Class: Twilio::REST::Conversations::V1::ConversationContext::WebhookInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Conversations::V1::ConversationContext::WebhookInstance
- Defined in:
- lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The unique ID of the Account responsible for this conversation.
-
#configuration ⇒ Hash
The configuration of this webhook.
-
#context ⇒ WebhookContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#conversation_sid ⇒ String
The unique ID of the Conversation for this webhook.
-
#date_created ⇒ Time
The date that this resource was created.
-
#date_updated ⇒ Time
The date that this resource was last updated.
-
#delete ⇒ Boolean
Delete the WebhookInstance.
-
#fetch ⇒ WebhookInstance
Fetch the WebhookInstance.
-
#initialize(version, payload, conversation_sid: nil, sid: nil) ⇒ WebhookInstance
constructor
Initialize the WebhookInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#sid ⇒ String
A 34 character string that uniquely identifies this resource.
-
#target ⇒ String
The target of this 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) ⇒ WebhookInstance
Update the WebhookInstance.
-
#url ⇒ String
An absolute URL for this webhook.
Constructor Details
#initialize(version, payload, conversation_sid: nil, sid: nil) ⇒ WebhookInstance
Initialize the WebhookInstance
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 276 def initialize(version, payload, conversation_sid: nil, sid: nil) super(version) # Marshaled Properties @properties = { 'sid' => payload['sid'], 'account_sid' => payload['account_sid'], 'conversation_sid' => payload['conversation_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 = {'conversation_sid' => conversation_sid, 'sid' => sid || @properties['sid'], } end |
Instance Method Details
#account_sid ⇒ String
Returns The unique ID of the Account responsible for this conversation.
315 316 317 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 315 def account_sid @properties['account_sid'] end |
#configuration ⇒ Hash
Returns The configuration of this webhook.
339 340 341 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 339 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
300 301 302 303 304 305 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 300 def context unless @instance_context @instance_context = WebhookContext.new(@version, @params['conversation_sid'], @params['sid'], ) end @instance_context end |
#conversation_sid ⇒ String
Returns The unique ID of the Conversation for this webhook.
321 322 323 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 321 def conversation_sid @properties['conversation_sid'] end |
#date_created ⇒ Time
Returns The date that this resource was created.
345 346 347 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 345 def date_created @properties['date_created'] end |
#date_updated ⇒ Time
Returns The date that this resource was last updated.
351 352 353 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 351 def date_updated @properties['date_updated'] end |
#delete ⇒ Boolean
Delete the WebhookInstance
388 389 390 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 388 def delete context.delete end |
#fetch ⇒ WebhookInstance
Fetch the WebhookInstance
358 359 360 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 358 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
401 402 403 404 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 401 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.WebhookInstance #{values}>" end |
#sid ⇒ String
Returns A 34 character string that uniquely identifies this resource.
309 310 311 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 309 def sid @properties['sid'] end |
#target ⇒ String
Returns The target of this webhook.
327 328 329 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 327 def target @properties['target'] end |
#to_s ⇒ Object
Provide a user friendly representation
394 395 396 397 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 394 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Conversations.V1.WebhookInstance #{values}>" end |
#update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset) ⇒ WebhookInstance
Update the WebhookInstance
375 376 377 378 379 380 381 382 383 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 375 def update(configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :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, ) end |
#url ⇒ String
Returns An absolute URL for this webhook.
333 334 335 |
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 333 def url @properties['url'] end |