Class: Twilio::REST::Verify::V2::ServiceContext::WebhookInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Verify::V2::ServiceContext::WebhookInstance

Defined in:

lib/twilio-ruby/rest/verify/v2/service/webhook.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #context ⇒ WebhookContext

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

• #date_created ⇒ Time

  The RFC 2822 date and time in GMT when the resource was created.

• #date_updated ⇒ Time

  The RFC 2822 date and time in GMT when the resource was last updated.

• #delete ⇒ Boolean

  Delete the WebhookInstance.

• #event_types ⇒ Array[String]

  The array of events that this Webhook is subscribed to.

• #fetch ⇒ WebhookInstance

  Fetch the WebhookInstance.

• #friendly_name ⇒ String

  The string that you assigned to describe the webhook.

• #initialize(version, payload, service_sid: nil, sid: nil) ⇒ WebhookInstance constructor

  Initialize the WebhookInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #service_sid ⇒ String

  Service Sid.

• #sid ⇒ String

  The unique string that identifies the resource.

• #status ⇒ webhook.Status

  The webhook status.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset) ⇒ WebhookInstance

  Update the WebhookInstance.

• #url ⇒ String

  The absolute URL of the Webhook resource.

• #webhook_method ⇒ webhook.Methods

  The method used when calling the webhook’s URL.

• #webhook_url ⇒ String

  The URL associated with this Webhook.

Constructor Details

#initialize(version, payload, service_sid: nil, sid: nil) ⇒ WebhookInstance

Initialize the WebhookInstance

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 256

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'service_sid' => payload['service_sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'event_types' => payload['event_types'],
      'status' => payload['status'],
      'webhook_url' => payload['webhook_url'],
      'webhook_method' => payload['webhook_method'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 304

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/verify/v2/service/webhook.rb', line 283

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 340

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 346

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 379

def delete
  context.delete
end

#event_types ⇒ Array[String]

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 316

def event_types
  @properties['event_types']
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 386

def fetch
  context.fetch
end

#friendly_name ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 310

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 399

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

#service_sid ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 298

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 292

def sid
  @properties['sid']
end

#status ⇒ webhook.Status

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 322

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 392

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

#update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset) ⇒ WebhookInstance

Update the WebhookInstance

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 367

def update(friendly_name: :unset, event_types: :unset, webhook_url: :unset, status: :unset)
  context.update(
      friendly_name: friendly_name,
      event_types: event_types,
      webhook_url: webhook_url,
      status: status,
  )
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 352

def url
  @properties['url']
end

#webhook_method ⇒ webhook.Methods

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 334

def webhook_method
  @properties['webhook_method']
end

#webhook_url ⇒ String

# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 328

def webhook_url
  @properties['webhook_url']
end