Class: Twilio::REST::Messaging::V1::SessionContext::WebhookList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/session/webhook.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Instance Method Summary collapse

Constructor Details

#initialize(version, session_sid: nil) ⇒ WebhookList

Initialize the WebhookList

Parameters:



23
24
25
26
27
28
29
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 23

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

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

Instance Method Details

#create(target: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_replay_after: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :unset) ⇒ WebhookInstance

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

Parameters:

  • target (webhook.Target) (defaults to: nil) —

    The target of this webhook.

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

    The absolute url the webhook request should be sent to.

  • configuration_method (webhook.Method) (defaults to: :unset) —

    The HTTP method to be used when sending a webhook request.

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

    The list of events, firing webhook event for this Session.

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

    The list of keywords, firing webhook event for this Session.

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

    The studio flow sid, where the webhook should be sent to.

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

    The number of retries in case of webhook request failures. Maximum 3 retries are allowed, the default value is 0.

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

    The message index for which and it’s successors the webhook will be replayed. Not set by default

  • configuration_buffer_messages (Boolean) (defaults to: :unset) —

    The flag whether buffering should be applied to messages. Not set by default

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

    The period of buffering messages. Default is 3000 ms.

Returns:



136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 136

def create(target: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset, configuration_replay_after: :unset, configuration_buffer_messages: :unset, configuration_buffer_window: :unset)
  data = Twilio::Values.of({
      'Target' => target,
      'Configuration.Url' => configuration_url,
      'Configuration.Method' => configuration_method,
      'Configuration.Filters' => Twilio.serialize_list(configuration_filters) { |e| e },
      'Configuration.Triggers' => Twilio.serialize_list(configuration_triggers) { |e| e },
      'Configuration.FlowSid' => configuration_flow_sid,
      'Configuration.RetryCount' => configuration_retry_count,
      'Configuration.ReplayAfter' => configuration_replay_after,
      'Configuration.BufferMessages' => configuration_buffer_messages,
      'Configuration.BufferWindow' => configuration_buffer_window,
  })

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

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

#each ⇒ Object

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



69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 69

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



105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 105

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



42
43
44
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 42

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



86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 86

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



57
58
59
60
61
62
63
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 57

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_s ⇒ Object

Provide a user friendly representation



161
162
163
 
# File 'lib/twilio-ruby/rest/messaging/v1/session/webhook.rb', line 161

def to_s
  '#<Twilio.Messaging.V1.WebhookList>'
end