Class: Twilio::REST::FlexApi::V1::ChannelList

Inherits:
ListResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/channel.rb

Instance Method Summary collapse

Constructor Details

#initialize(version) ⇒ ChannelList

Initialize the ChannelList



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 18

def initialize(version)
  super(version)

  # Path Solution
  @solution = {}
  @uri = "/Channels"
end

Instance Method Details

#create(flex_flow_sid: nil, identity: nil, chat_user_friendly_name: nil, chat_friendly_name: nil, target: :unset, chat_unique_name: :unset, pre_engagement_data: :unset, task_sid: :unset, task_attributes: :unset, long_lived: :unset) ⇒ ChannelInstance

Create the ChannelInstance



123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 123

def create(flex_flow_sid: nil, identity: nil, chat_user_friendly_name: nil, chat_friendly_name: nil, target: :unset, chat_unique_name: :unset, pre_engagement_data: :unset, task_sid: :unset, task_attributes: :unset, long_lived: :unset)
  data = Twilio::Values.of({
      'FlexFlowSid' => flex_flow_sid,
      'Identity' => identity,
      'ChatUserFriendlyName' => chat_user_friendly_name,
      'ChatFriendlyName' => chat_friendly_name,
      'Target' => target,
      'ChatUniqueName' => chat_unique_name,
      'PreEngagementData' => pre_engagement_data,
      'TaskSid' => task_sid,
      'TaskAttributes' => task_attributes,
      'LongLived' => long_lived,
  })

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

  ChannelInstance.new(@version, payload, )
end

#each ⇒ Object

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



64
65
66
67
68
69
70
71
72
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 64

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 ChannelInstance records from the API. Request is executed immediately.



98
99
100
101
102
103
104
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 98

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

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

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



37
38
39
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 37

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 ChannelInstance records from the API. Request is executed immediately.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 81

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)

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

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

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



52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 52

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



144
145
146
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 144

def to_s
  '#<Twilio.FlexApi.V1.ChannelList>'
end