Class: Twilio::REST::FlexApi::V1::WebChannelList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::FlexApi::V1::WebChannelList
- Defined in:
- lib/twilio-ruby/rest/flex_api/v1/web_channel.rb
Instance Method Summary collapse
-
#create(flex_flow_sid: nil, identity: nil, customer_friendly_name: nil, chat_friendly_name: nil, chat_unique_name: :unset, pre_engagement_data: :unset) ⇒ WebChannelInstance
Create the WebChannelInstance.
-
#each ⇒ Object
When passed a block, yields WebChannelInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of WebChannelInstance records from the API.
-
#initialize(version) ⇒ WebChannelList
constructor
Initialize the WebChannelList.
-
#list(limit: nil, page_size: nil) ⇒ Array
Lists WebChannelInstance records from the API as a list.
-
#page(page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of WebChannelInstance 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) ⇒ WebChannelList
Initialize the WebChannelList
25 26 27 28 29 30 31 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 25 def initialize(version) super(version) # Path Solution @solution = { } @uri = "/WebChannels" end |
Instance Method Details
#create(flex_flow_sid: nil, identity: nil, customer_friendly_name: nil, chat_friendly_name: nil, chat_unique_name: :unset, pre_engagement_data: :unset) ⇒ WebChannelInstance
Create the WebChannelInstance
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 41 def create( flex_flow_sid: nil, identity: nil, customer_friendly_name: nil, chat_friendly_name: nil, chat_unique_name: :unset, pre_engagement_data: :unset ) data = Twilio::Values.of({ 'FlexFlowSid' => flex_flow_sid, 'Identity' => identity, 'CustomerFriendlyName' => customer_friendly_name, 'ChatFriendlyName' => chat_friendly_name, 'ChatUniqueName' => chat_unique_name, 'PreEngagementData' => pre_engagement_data, }) payload = @version.create('POST', @uri, data: data) WebChannelInstance.new( @version, payload, ) end |
#each ⇒ Object
When passed a block, yields WebChannelInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
109 110 111 112 113 114 115 116 117 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 109 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 WebChannelInstance records from the API. Request is executed immediately.
143 144 145 146 147 148 149 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 143 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) WebChannelPage.new(@version, response, @solution) end |
#list(limit: nil, page_size: nil) ⇒ Array
Lists WebChannelInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.
78 79 80 81 82 83 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 78 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 WebChannelInstance records from the API. Request is executed immediately.
126 127 128 129 130 131 132 133 134 135 136 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 126 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) WebChannelPage.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.
96 97 98 99 100 101 102 103 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 96 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
154 155 156 |
# File 'lib/twilio-ruby/rest/flex_api/v1/web_channel.rb', line 154 def to_s '#<Twilio.FlexApi.V1.WebChannelList>' end |