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.



170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 170

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:



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 186

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:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 206

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



354
355
356
357
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 354

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

#invites ⇒ InteractionChannelInviteList, InteractionChannelInviteContext

Access the invites

Returns:



299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 299

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) 


329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 329

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



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

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) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 310

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:



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 234

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:



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/twilio-ruby/rest/flex_api/v1/interaction/interaction_channel.rb', line 264

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