Class: Twilio::REST::FlexApi::V1::InteractionContext::InteractionChannelContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_transfer.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_invite.rb,
lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel/interaction_channel_participant.rb

Defined Under Namespace

Classes: InteractionChannelInviteInstance, InteractionChannelInviteList, InteractionChannelInviteListResponse, InteractionChannelInvitePage, InteractionChannelInvitePageMetadata, InteractionChannelParticipantContext, InteractionChannelParticipantInstance, InteractionChannelParticipantInstanceMetadata, InteractionChannelParticipantList, InteractionChannelParticipantListResponse, InteractionChannelParticipantPage, InteractionChannelParticipantPageMetadata, InteractionTransferContext, InteractionTransferInstance, InteractionTransferInstanceMetadata, InteractionTransferList, InteractionTransferListResponse, InteractionTransferPage, InteractionTransferPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, interaction_sid, sid) ⇒ InteractionChannelContext

Initialize the InteractionChannelContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • interaction_sid (String) —

    The unique string created by Twilio to identify an Interaction resource, prefixed with KD.

  • sid (String) —

    The unique string created by Twilio to identify an Interaction Channel resource, prefixed with UO.



162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 162

def initialize(version, interaction_sid, sid)
    super(version)
    

    # Path Solution
    @solution = { interaction_sid: interaction_sid, sid: sid,  }
    @uri = "/Interactions/#{@solution[:interaction_sid]}/Channels/#{@solution[:sid]}"

    # Dependents
    @invites = nil
    @transfers = nil
    @participants = nil
end

Instance Method Details

#fetch ⇒ InteractionChannelInstance

Fetch the InteractionChannelInstance

Returns:



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 178

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    InteractionChannelInstance.new(
        @version,
        payload,
        interaction_sid: @solution[:interaction_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ InteractionChannelInstance

Fetch the InteractionChannelInstanceMetadata

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 198

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    interaction_channel_instance = InteractionChannelInstance.new(
        @version,
        response.body,
        interaction_sid: @solution[:interaction_sid],
        sid: @solution[:sid],
    )
    InteractionChannelInstanceMetadata.new(
        @version,
        interaction_channel_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



346
347
348
349
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 346

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.FlexApi.V1.InteractionChannelContext #{context}>"
end

#invites ⇒ InteractionChannelInviteList, InteractionChannelInviteContext

Access the invites

Returns:



291
292
293
294
295
296
297
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 291

def invites
  unless @invites
    @invites = InteractionChannelInviteList.new(
            @version, interaction_sid: @solution[:interaction_sid], channel_sid: @solution[:sid], )
  end
  @invites
end

#participants(sid = :unset) ⇒ InteractionChannelParticipantList, InteractionChannelParticipantContext

Access the participants

Returns:

Raises:

  • (ArgumentError) 


321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 321

def participants(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return InteractionChannelParticipantContext.new(@version, @solution[:interaction_sid], @solution[:sid],sid )
    end

    unless @participants
        @participants = InteractionChannelParticipantList.new(
            @version, interaction_sid: @solution[:interaction_sid], channel_sid: @solution[:sid], )
    end

 @participants
end

#to_s ⇒ Object

Provide a user friendly representation



339
340
341
342
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 339

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.FlexApi.V1.InteractionChannelContext #{context}>"
end

#transfers(sid = :unset) ⇒ InteractionTransferList, InteractionTransferContext

Access the transfers

Returns:

Raises:

  • (ArgumentError) 


302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 302

def transfers(sid=:unset)

    raise ArgumentError, 'sid cannot be nil' if sid.nil?

    if sid != :unset
        return InteractionTransferContext.new(@version, @solution[:interaction_sid], @solution[:sid],sid )
    end

    unless @transfers
        @transfers = InteractionTransferList.new(
            @version, interaction_sid: @solution[:interaction_sid], channel_sid: @solution[:sid], )
    end

 @transfers
end

#update(status: nil, routing: :unset) ⇒ InteractionChannelInstance

Update the InteractionChannelInstance

Parameters:

  • status (UpdateChannelStatus) (defaults to: nil)
  • routing (Object) (defaults to: :unset) —

    It changes the state of associated tasks. Routing status is required, When the channel status is set to inactive. Allowed Value for routing status is closed. Otherwise Optional, if not specified, all tasks will be set to wrapping.

Returns:



226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 226

def update(
    status: nil, 
    routing: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'Routing' => Twilio.serialize_object(routing),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    InteractionChannelInstance.new(
        @version,
        payload,
        interaction_sid: @solution[:interaction_sid],
        sid: @solution[:sid],
    )
end

#update_with_metadata(status: nil, routing: :unset) ⇒ InteractionChannelInstance

Update the InteractionChannelInstanceMetadata

Parameters:

  • status (UpdateChannelStatus) (defaults to: nil)
  • routing (Object) (defaults to: :unset) —

    It changes the state of associated tasks. Routing status is required, When the channel status is set to inactive. Allowed Value for routing status is closed. Otherwise Optional, if not specified, all tasks will be set to wrapping.

Returns:



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 256

def update_with_metadata(
  status: nil, 
  routing: :unset
)

    data = Twilio::Values.of({
        'Status' => status,
        'Routing' => Twilio.serialize_object(routing),
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    interaction_channel_instance = InteractionChannelInstance.new(
        @version,
        response.body,
        interaction_sid: @solution[:interaction_sid],
        sid: @solution[:sid],
    )
    InteractionChannelInstanceMetadata.new(
        @version,
        interaction_channel_instance,
        response.headers,
        response.status_code
    )
end