Class: Twilio::REST::Conversations::V1::ConfigurationContext::WebhookInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ WebhookInstance

Initialize the WebhookInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Webhook resource.

  • sid (String) —

    The SID of the Call resource to fetch.



345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 345

def initialize(version, payload )
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'method' => payload['method'],
        'filters' => payload['filters'],
        'pre_webhook_url' => payload['pre_webhook_url'],
        'post_webhook_url' => payload['post_webhook_url'],
        'target' => payload['target'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = {  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this conversation.

Returns:



378
379
380
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 378

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



369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 369

def context
    unless @instance_context
        @instance_context = WebhookContext.new(@version )
    end
    @instance_context
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



421
422
423
424
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 421

def fetch

    context.fetch
end

#filters ⇒ Array<String>

Returns The list of webhook event triggers that are enabled for this Service: onMessageAdded, onMessageUpdated, onMessageRemoved, onMessageAdd, onMessageUpdate, onMessageRemove, onConversationUpdated, onConversationRemoved, onConversationAdd, onConversationAdded, onConversationRemove, onConversationUpdate, onConversationStateUpdated, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onParticipantAdd, onParticipantRemove, onParticipantUpdate, onDeliveryUpdated, onUserAdded, onUserUpdate, onUserUpdated.

Returns:

  • (Array<String>) —

    The list of webhook event triggers that are enabled for this Service: onMessageAdded, onMessageUpdated, onMessageRemoved, onMessageAdd, onMessageUpdate, onMessageRemove, onConversationUpdated, onConversationRemoved, onConversationAdd, onConversationAdded, onConversationRemove, onConversationUpdate, onConversationStateUpdated, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onParticipantAdd, onParticipantRemove, onParticipantUpdate, onDeliveryUpdated, onUserAdded, onUserUpdate, onUserUpdated



390
391
392
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 390

def filters
    @properties['filters']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



460
461
462
463
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 460

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

#method ⇒ Method

Returns:

  • (Method) 


384
385
386
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 384

def method
    @properties['method']
end

#post_webhook_url ⇒ String

Returns The absolute url the post-event webhook request should be sent to.

Returns:

  • (String) —

    The absolute url the post-event webhook request should be sent to.



402
403
404
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 402

def post_webhook_url
    @properties['post_webhook_url']
end

#pre_webhook_url ⇒ String

Returns The absolute url the pre-event webhook request should be sent to.

Returns:

  • (String) —

    The absolute url the pre-event webhook request should be sent to.



396
397
398
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 396

def pre_webhook_url
    @properties['pre_webhook_url']
end

#target ⇒ Target

Returns:

  • (Target) 


408
409
410
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 408

def target
    @properties['target']
end

#to_s ⇒ Object

Provide a user friendly representation



453
454
455
456
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 453

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

#update(method: :unset, filters: :unset, pre_webhook_url: :unset, post_webhook_url: :unset, target: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

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

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

  • filters (Array[String]) (defaults to: :unset) —

    The list of webhook event triggers that are enabled for this Service: onMessageAdded, onMessageUpdated, onMessageRemoved, onMessageAdd, onMessageUpdate, onMessageRemove, onConversationUpdated, onConversationRemoved, onConversationAdd, onConversationAdded, onConversationRemove, onConversationUpdate, onConversationStateUpdated, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onParticipantAdd, onParticipantRemove, onParticipantUpdate, onDeliveryUpdated, onUserAdded, onUserUpdate, onUserUpdated

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

    The absolute url the pre-event webhook request should be sent to.

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

    The absolute url the post-event webhook request should be sent to.

  • target (Target) (defaults to: :unset)

Returns:



434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 434

def update(
    method: :unset, 
    filters: :unset, 
    pre_webhook_url: :unset, 
    post_webhook_url: :unset, 
    target: :unset
)

    context.update(
        method: method, 
        filters: filters, 
        pre_webhook_url: pre_webhook_url, 
        post_webhook_url: post_webhook_url, 
        target: target, 
    )
end

#url ⇒ String

Returns An absolute API resource API resource URL for this webhook.

Returns:

  • (String) —

    An absolute API resource API resource URL for this webhook.



414
415
416
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb', line 414

def url
    @properties['url']
end