Class: Twilio::REST::Chat::V2::ServiceContext::ChannelContext::WebhookList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Chat::V2::ServiceContext::ChannelContext::WebhookList
- Defined in:
- lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb
Instance Method Summary collapse
-
#create(type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset) ⇒ WebhookInstance
Create the WebhookInstance.
-
#each ⇒ Object
When passed a block, yields WebhookInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of WebhookInstance records from the API.
-
#initialize(version, service_sid: nil, channel_sid: nil) ⇒ WebhookList
constructor
Initialize the WebhookList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists WebhookInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of WebhookInstance records from the API.
-
#stream(limit: nil, page_size: nil) ⇒ Enumerable
Streams Instance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, service_sid: nil, channel_sid: nil) ⇒ WebhookList
Initialize the WebhookList
28 29 30 31 32 33 34 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 28 def initialize(version, service_sid: nil, channel_sid: nil) super(version) # Path Solution @solution = { service_sid: service_sid, channel_sid: channel_sid } @uri = "/Services/#{@solution[:service_sid]}/Channels/#{@solution[:channel_sid]}/Webhooks" end |
Instance Method Details
#create(type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset) ⇒ WebhookInstance
Create the WebhookInstance
45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 45 def create( type: nil, configuration_url: :unset, configuration_method: :unset, configuration_filters: :unset, configuration_triggers: :unset, configuration_flow_sid: :unset, configuration_retry_count: :unset ) data = Twilio::Values.of({ 'Type' => type, '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, }) payload = @version.create('POST', @uri, data: data) WebhookInstance.new( @version, payload, service_sid: @solution[:service_sid], channel_sid: @solution[:channel_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.
117 118 119 120 121 122 123 124 125 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 117 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.
152 153 154 155 156 157 158 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 152 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.
86 87 88 89 90 91 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 86 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.
134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 134 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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
104 105 106 107 108 109 110 111 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 104 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
163 164 165 |
# File 'lib/twilio-ruby/rest/chat/v2/service/channel/webhook.rb', line 163 def to_s '#<Twilio.Chat.V2.WebhookList>' end |