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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Conversations::V1::ConfigurationContext::WebhookInstance

Defined in:

lib/twilio-ruby/rest/conversations/v1/configuration/webhook.rb

Instance Method Summary

• #account_sid ⇒ String

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

• #context ⇒ WebhookContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #fetch ⇒ WebhookInstance

  Fetch the WebhookInstance.

• #filters ⇒ 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`.

• #initialize(version, payload) ⇒ WebhookInstance constructor

  Initialize the WebhookInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #method ⇒ Method
• #post_webhook_url ⇒ String

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

• #pre_webhook_url ⇒ String

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

• #target ⇒ Target
• #to_s ⇒ Object

  Provide a user friendly representation.

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

  Update the WebhookInstance.

• #url ⇒ String

  An absolute API resource API resource URL for this webhook.

Constructor Details

#initialize(version, payload) ⇒ WebhookInstance

Initialize the WebhookInstance

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

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

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

def account_sid
    @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

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

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

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

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

def fetch

    context.fetch
end

#filters ⇒ Array<String>

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

def filters
    @properties['filters']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#method ⇒ Method

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

def method
    @properties['method']
end

#post_webhook_url ⇒ String

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

def post_webhook_url
    @properties['post_webhook_url']
end

#pre_webhook_url ⇒ String

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

def pre_webhook_url
    @properties['pre_webhook_url']
end

#target ⇒ Target

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

def target
    @properties['target']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

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

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

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

def url
    @properties['url']
end