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

  • account_sid (String) —

    The SID of the Account that created this Webhook resource.

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

    The SID of the Call resource to fetch.



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 578

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  || @properties['service_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Service resource.

Returns:



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

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:



607
608
609
610
611
612
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 607

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the WebhookInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



689
690
691
692
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 689

def delete

    context.delete
end

#event_types ⇒ Array<String>

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

Returns:

  • (Array<String>) —

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



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

def event_types
    @properties['event_types']
end

#fetch ⇒ WebhookInstance

Fetch the WebhookInstance

Returns:



697
698
699
700
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 697

def fetch

    context.fetch
end

#friendly_name ⇒ String

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

Returns:

  • (String) —

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



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



736
737
738
739
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 736

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

#service_sid ⇒ String

Returns The unique SID identifier of the Service.

Returns:

  • (String) —

    The unique SID identifier of the Service.



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

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the Webhook resource.

Returns:

  • (String) —

    The unique string that we created to identify the Webhook resource.



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

def sid
    @properties['sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



729
730
731
732
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 729

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 (Status) (defaults to: :unset)
  • version (Version) (defaults to: :unset)

Returns:



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 710

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.



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

def url
    @properties['url']
end

#version ⇒ Version

Returns:



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

def version
    @properties['version']
end

#webhook_method ⇒ Methods

Returns:

  • (Methods) 


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

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.



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

def webhook_url
    @properties['webhook_url']
end