Class: Twilio::REST::Conversations::V1::ConversationContext::WebhookList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, conversation_sid: nil) ⇒ WebhookList

Initialize the WebhookList

Parameters:

  • version (Version)

    Version that contains the resource

  • conversation_sid (String) (defaults to: nil)

    The unique ID of the Conversation for this webhook.


22
23
24
25
26
27
28
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 22

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

  # Path Solution
  @solution = {conversation_sid: conversation_sid}
  @uri = "/Conversations/#{@solution[:conversation_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_replay_after: :unset) ⇒ WebhookInstance

Create the WebhookInstance

Parameters:

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

    The target of this webhook: `webhook`, `studio`, `trigger`

  • 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 (Array[String]) (defaults to: :unset)

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

  • configuration_triggers (Array[String]) (defaults to: :unset)

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

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

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

  • 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

Returns:


127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 127

def create(target: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_replay_after: :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.ReplayAfter' => configuration_replay_after,
  })

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

  WebhookInstance.new(@version, payload, conversation_sid: @solution[:conversation_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.


68
69
70
71
72
73
74
75
76
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 68

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


102
103
104
105
106
107
108
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 102

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


41
42
43
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 41

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


85
86
87
88
89
90
91
92
93
94
95
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 85

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


56
57
58
59
60
61
62
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 56

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


145
146
147
# File 'lib/twilio-ruby/rest/conversations/v1/conversation/webhook.rb', line 145

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