Class: Twilio::REST::Conversations::V1::ServiceContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service.rb,
lib/twilio-ruby/rest/conversations/v1/service/role.rb,
lib/twilio-ruby/rest/conversations/v1/service/user.rb,
lib/twilio-ruby/rest/conversations/v1/service/binding.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation.rb,
lib/twilio-ruby/rest/conversations/v1/service/configuration.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/message.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/webhook.rb,
lib/twilio-ruby/rest/conversations/v1/service/configuration/webhook.rb,
lib/twilio-ruby/rest/conversations/v1/service/user/user_conversation.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb,
lib/twilio-ruby/rest/conversations/v1/service/participant_conversation.rb,
lib/twilio-ruby/rest/conversations/v1/service/configuration/notification.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation_with_participants.rb,
lib/twilio-ruby/rest/conversations/v1/service/conversation/message/delivery_receipt.rb

Defined Under Namespace

Classes: BindingContext, BindingInstance, BindingInstanceMetadata, BindingList, BindingListResponse, BindingPage, BindingPageMetadata, ConfigurationContext, ConfigurationInstance, ConfigurationInstanceMetadata, ConfigurationList, ConfigurationListResponse, ConfigurationPage, ConfigurationPageMetadata, ConversationContext, ConversationInstance, ConversationInstanceMetadata, ConversationList, ConversationListResponse, ConversationPage, ConversationPageMetadata, ConversationWithParticipantsInstance, ConversationWithParticipantsList, ConversationWithParticipantsListResponse, ConversationWithParticipantsPage, ConversationWithParticipantsPageMetadata, ParticipantConversationInstance, ParticipantConversationList, ParticipantConversationListResponse, ParticipantConversationPage, ParticipantConversationPageMetadata, RoleContext, RoleInstance, RoleInstanceMetadata, RoleList, RoleListResponse, RolePage, RolePageMetadata, UserContext, UserInstance, UserInstanceMetadata, UserList, UserListResponse, UserPage, UserPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this resource.



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 215

def initialize(version, sid)
    super(version)
    

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

    # Dependents
    @participant_conversations = nil
    @conversation_with_participants = nil
    @configuration = nil
    @users = nil
    @roles = nil
    @bindings = nil
    @conversations = nil
end

Instance Method Details

#bindings(sid = :unset) ⇒ BindingList, BindingContext

Access the bindings

Returns:

Raises:

  • (ArgumentError) 


382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 382

def bindings(sid=:unset)

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

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

    unless @bindings
        @bindings = BindingList.new(
            @version, chat_service_sid: @solution[:sid], )
    end

 @bindings
end

#configuration ⇒ ConfigurationList, ConfigurationContext

Access the configuration

Returns:



334
335
336
337
338
339
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 334

def configuration
    ConfigurationContext.new(
            @version,
            @solution[:sid]
            )
end

#conversation_with_participants ⇒ ConversationWithParticipantsList, ConversationWithParticipantsContext

Access the conversation_with_participants

Returns:



323
324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 323

def conversation_with_participants
  unless @conversation_with_participants
    @conversation_with_participants = ConversationWithParticipantsList.new(
            @version, chat_service_sid: @solution[:sid], )
  end
  @conversation_with_participants
end

#conversations(sid = :unset) ⇒ ConversationList, ConversationContext

Access the conversations

Returns:

Raises:

  • (ArgumentError) 


401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 401

def conversations(sid=:unset)

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

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

    unless @conversations
        @conversations = ConversationList.new(
            @version, chat_service_sid: @solution[:sid], )
    end

 @conversations
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 235

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the ServiceInstanceMetadata

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 248

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      service_instance = ServiceInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      ServiceInstanceMetadata.new(@version, service_instance, response.headers, response.status_code)
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 267

def fetch

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

#fetch_with_metadata ⇒ ServiceInstance

Fetch the ServiceInstanceMetadata

Returns:



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 286

def fetch_with_metadata

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



426
427
428
429
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 426

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

#participant_conversations ⇒ ParticipantConversationList, ParticipantConversationContext

Access the participant_conversations

Returns:



312
313
314
315
316
317
318
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 312

def participant_conversations
  unless @participant_conversations
    @participant_conversations = ParticipantConversationList.new(
            @version, chat_service_sid: @solution[:sid], )
  end
  @participant_conversations
end

#roles(sid = :unset) ⇒ RoleList, RoleContext

Access the roles

Returns:

Raises:

  • (ArgumentError) 


363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 363

def roles(sid=:unset)

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

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

    unless @roles
        @roles = RoleList.new(
            @version, chat_service_sid: @solution[:sid], )
    end

 @roles
end

#to_s ⇒ Object

Provide a user friendly representation



419
420
421
422
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 419

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

#users(sid = :unset) ⇒ UserList, UserContext

Access the users

Returns:

Raises:

  • (ArgumentError) 


344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 344

def users(sid=:unset)

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

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

    unless @users
        @users = UserList.new(
            @version, chat_service_sid: @solution[:sid], )
    end

 @users
end