Class: Twilio::REST::Verify::V2::ServiceContext::WebhookList

Inherits:
ListResource
  • Object
show all
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 collapse

Constructor Details

#initialize(version, service_sid: nil) ⇒ WebhookList

Initialize the WebhookList

Parameters:

  • version (Version)

    Version that contains the resource

  • service_sid (String) (defaults to: nil)

    The unique SID identifier of the Service.


22
23
24
25
26
27
28
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 22

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

  # Path Solution
  @solution = {service_sid: service_sid}
  @uri = "/Services/#{@solution[:service_sid]}/Webhooks"
end

Instance Method Details

#create(friendly_name: nil, event_types: nil, webhook_url: nil, status: :unset, version: :unset) ⇒ WebhookInstance

Create the WebhookInstance

Parameters:

  • friendly_name (String) (defaults to: nil)

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

  • event_types (Array[String]) (defaults to: nil)

    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: nil)

    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:


44
45
46
47
48
49
50
51
52
53
54
55
56
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 44

def create(friendly_name: nil, event_types: nil, webhook_url: nil, status: :unset, version: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'EventTypes' => Twilio.serialize_list(event_types) { |e| e },
      'WebhookUrl' => webhook_url,
      'Status' => status,
      'Version' => version,
  })

  payload = @version.create('POST', @uri, data: data)

  WebhookInstance.new(@version, payload, service_sid: @solution[:service_sid], )
end

#eachObject

When passed a block, yields WebhookInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.


96
97
98
99
100
101
102
103
104
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 96

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of WebhookInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String)

    API-generated URL for the requested results page

Returns:

  • (Page)

    Page of WebhookInstance


130
131
132
133
134
135
136
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 130

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  WebhookPage.new(@version, response, @solution)
end

#list(limit: nil, page_size: nil) ⇒ Array

Lists WebhookInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array)

    Array of up to limit results


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

def list(limit: nil, page_size: nil)
  self.stream(limit: limit, page_size: page_size).entries
end

#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of WebhookInstance records from the API. Request is executed immediately.

Parameters:

  • page_token (String) (defaults to: :unset)

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset)

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • (Page)

    Page of WebhookInstance


113
114
115
116
117
118
119
120
121
122
123
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 113

def page(page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })

  response = @version.page('GET', @uri, params: params)

  WebhookPage.new(@version, response, @solution)
end

#stream(limit: nil, page_size: nil) ⇒ Enumerable

Streams WebhookInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

  • limit (Integer) (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil)

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable)

    Enumerable that will yield up to limit results


84
85
86
87
88
89
90
# File 'lib/twilio-ruby/rest/verify/v2/service/webhook.rb', line 84

def stream(limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_sObject

Provide a user friendly representation


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

def to_s
  '#<Twilio.Verify.V2.WebhookList>'
end