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

Parameters:

  • Version that contains the resource



26
27
28
29
30
31
32
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 26

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

Parameters:

  • (defaults to: nil)

    The SID of the Flex Flow.

  • (defaults to: nil)

    The ‘identity` value that uniquely identifies the new resource’s chat User.

  • (defaults to: nil)

    The chat participant’s friendly name.

  • (defaults to: nil)

    The chat channel’s friendly name.

  • (defaults to: :unset)

    The Target Contact Identity, for example the phone number of an SMS.

  • (defaults to: :unset)

    The chat channel’s unique name.

  • (defaults to: :unset)

    The pre-engagement data.

  • (defaults to: :unset)

    The SID of the TaskRouter Task. Only valid when integration type is ‘task`. `null` for integration types `studio` & `external`

  • (defaults to: :unset)

    The Task attributes to be added for the TaskRouter Task.

  • (defaults to: :unset)

    Whether to create the channel as long-lived.

Returns:

  • Created ChannelInstance



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
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 46

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

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    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.



128
129
130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 128

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.

Parameters:

  • API-generated URL for the requested results page

Returns:

  • Page of ChannelInstance



165
166
167
168
169
170
171
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 165

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.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 of up to limit results



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

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.

Parameters:

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of ChannelInstance



145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 145

def page(page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    ChannelPage.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.

Parameters:

  • (defaults to: nil)

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • (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 that will yield up to limit results



115
116
117
118
119
120
121
122
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 115

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



176
177
178
 
# File 'lib/twilio-ruby/rest/flex_api/v1/channel.rb', line 176

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