Class: Twilio::REST::Conversations::V1::ServiceInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/conversations/v1/service.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Service resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 370

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'sid' => payload['sid'],
        'friendly_name' => payload['friendly_name'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique ID of the [Account](www.twilio.com/docs/iam/api/account) responsible for this service.

Returns:



402
403
404
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 402

def 
    @properties['account_sid']
end

#bindings ⇒ bindings

Access the bindings

Returns:



496
497
498
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 496

def bindings
    context.bindings
end

#configuration ⇒ configuration

Access the configuration

Returns:



475
476
477
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 475

def configuration
    context.configuration
end

#context ⇒ ServiceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



393
394
395
396
397
398
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 393

def context
    unless @instance_context
        @instance_context = ServiceContext.new(@version , @params['sid'])
    end
    @instance_context
end

#conversation_with_participants ⇒ conversation_with_participants

Access the conversation_with_participants

Returns:



468
469
470
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 468

def conversation_with_participants
    context.conversation_with_participants
end

#conversations ⇒ conversations

Access the conversations

Returns:



503
504
505
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 503

def conversations
    context.conversations
end

#date_created ⇒ Time

Returns The date that this resource was created.

Returns:

  • (Time) —

    The date that this resource was created.



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated.

Returns:

  • (Time) —

    The date that this resource was last updated.



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



445
446
447
448
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 445

def delete

    context.delete
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



453
454
455
456
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 453

def fetch

    context.fetch
end

#friendly_name ⇒ String

Returns The human-readable name of this service, limited to 256 characters. Optional.

Returns:

  • (String) —

    The human-readable name of this service, limited to 256 characters. Optional.



414
415
416
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 414

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



516
517
518
519
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 516

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Conversations.V1.ServiceInstance #{values}>"
end

#links ⇒ Hash

Returns Contains absolute API resource URLs to access conversations, users, roles, bindings and configuration of this service.

Returns:

  • (Hash) —

    Contains absolute API resource URLs to access conversations, users, roles, bindings and configuration of this service.



438
439
440
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 438

def links
    @properties['links']
end

#participant_conversations ⇒ participant_conversations

Access the participant_conversations

Returns:



461
462
463
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 461

def participant_conversations
    context.participant_conversations
end

#roles ⇒ roles

Access the roles

Returns:



489
490
491
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 489

def roles
    context.roles
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



408
409
410
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 408

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



509
510
511
512
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 509

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Conversations.V1.ServiceInstance #{values}>"
end

#url ⇒ String

Returns An absolute API resource URL for this service.

Returns:

  • (String) —

    An absolute API resource URL for this service.



432
433
434
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 432

def url
    @properties['url']
end

#users ⇒ users

Access the users

Returns:



482
483
484
 
# File 'lib/twilio-ruby/rest/conversations/v1/service.rb', line 482

def users
    context.users
end