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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/webhook.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the WebhookInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • service_sid (String) (defaults to: nil) —

    The unique SID identifier of the Service.

  • sid (String) (defaults to: nil) —

    The Twilio-provided string that uniquely identifies the Webhook resource to fetch.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# 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'],
      'version' => payload['version'],
      '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

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

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:



284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 284

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

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#event_types ⇒ Array[String]

Returns The array of events that this Webhook is subscribed to.

Returns:

  • (Array[String]) —

    The array of events that this Webhook is subscribed to.



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

def event_types
  @properties['event_types']
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the webhook.

Returns:

  • (String) —

    The string that you assigned to describe the webhook



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



410
411
412
413
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 410

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

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#status ⇒ webhook.Status

Returns The webhook status.

Returns:

  • (webhook.Status) —

    The webhook status



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



403
404
405
406
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 403

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, version: :unset) ⇒ WebhookInstance

Update the WebhookInstance

Parameters:

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

    The string that you assigned to describe the webhook. **This value should not contain PII.**

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

    The array of events that this Webhook is subscribed to. Possible event types: ‘*, factor.deleted, factor.created, factor.verified, challenge.approved, challenge.denied`

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

    The URL associated with this Webhook.

  • status (webhook.Status) (defaults to: :unset) —

    The webhook status. Default value is ‘enabled`. One of: `enabled` or `disabled`

  • version (webhook.Version) (defaults to: :unset) —

    The webhook version. Default value is ‘v2` which includes all the latest fields. Version `v1` is legacy and may be removed in the future.

Returns:



377
378
379
380
381
382
383
384
385
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 377

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

#url ⇒ String

Returns The absolute URL of the Webhook resource.

Returns:

  • (String) —

    The absolute URL of the Webhook resource



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

def url
  @properties['url']
end

#version ⇒ webhook.Version

Returns The webhook version.

Returns:

  • (webhook.Version) —

    The webhook version



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

def version
  @properties['version']
end

#webhook_method ⇒ webhook.Methods

Returns The method used when calling the webhook’s URL.

Returns:

  • (webhook.Methods) —

    The method used when calling the webhook’s URL.



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

def webhook_method
  @properties['webhook_method']
end

#webhook_url ⇒ String

Returns The URL associated with this Webhook.

Returns:

  • (String) —

    The URL associated with this Webhook.



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

def webhook_url
  @properties['webhook_url']
end