Class: Twilio::REST::Conversations::V1::ConfigurationInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload) ⇒ ConfigurationInstance

Initialize the ConfigurationInstance

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 Configuration resource.

  • sid (String) —

    The SID of the Call resource to fetch.



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 347

def initialize(version, payload )
    super(version)
    
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'default_chat_service_sid' => payload['default_chat_service_sid'],
        'default_messaging_service_sid' => payload['default_messaging_service_sid'],
        'default_inactive_timer' => payload['default_inactive_timer'],
        'default_closed_timer' => payload['default_closed_timer'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = {  }
end

Instance Method Details

#account_sid ⇒ String

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

Returns:



380
381
382
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 380

def 
    @properties['account_sid']
end

#context ⇒ ConfigurationContext

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

Returns:



371
372
373
374
375
376
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 371

def context
    unless @instance_context
        @instance_context = ConfigurationContext.new(@version )
    end
    @instance_context
end

#default_chat_service_sid ⇒ String

Returns The SID of the default [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) used when creating a conversation.

Returns:



386
387
388
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 386

def default_chat_service_sid
    @properties['default_chat_service_sid']
end

#default_closed_timer ⇒ String

Returns Default ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.

Returns:

  • (String) —

    Default ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.



404
405
406
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 404

def default_closed_timer
    @properties['default_closed_timer']
end

#default_inactive_timer ⇒ String

Returns Default ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.

Returns:

  • (String) —

    Default ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.



398
399
400
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 398

def default_inactive_timer
    @properties['default_inactive_timer']
end

#default_messaging_service_sid ⇒ String

Returns The SID of the default [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation.

Returns:



392
393
394
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 392

def default_messaging_service_sid
    @properties['default_messaging_service_sid']
end

#fetch ⇒ ConfigurationInstance

Fetch the ConfigurationInstance

Returns:



423
424
425
426
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 423

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



466
467
468
469
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 466

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

#links ⇒ Hash

Returns Contains absolute API resource URLs to access the webhook and default service configurations.

Returns:

  • (Hash) —

    Contains absolute API resource URLs to access the webhook and default service configurations.



416
417
418
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 416

def links
    @properties['links']
end

#to_s ⇒ Object

Provide a user friendly representation



459
460
461
462
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 459

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

#update(default_chat_service_sid: :unset, default_messaging_service_sid: :unset, default_inactive_timer: :unset, default_closed_timer: :unset) ⇒ ConfigurationInstance

Update the ConfigurationInstance

Parameters:

  • default_chat_service_sid (String) (defaults to: :unset) —

    The SID of the default [Conversation Service](www.twilio.com/docs/conversations/api/service-resource) to use when creating a conversation.

  • default_messaging_service_sid (String) (defaults to: :unset) —

    The SID of the default [Messaging Service](www.twilio.com/docs/messaging/api/service-resource) to use when creating a conversation.

  • default_inactive_timer (String) (defaults to: :unset) —

    Default ISO8601 duration when conversation will be switched to inactive state. Minimum value for this timer is 1 minute.

  • default_closed_timer (String) (defaults to: :unset) —

    Default ISO8601 duration when conversation will be switched to closed state. Minimum value for this timer is 10 minutes.

Returns:



435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 435

def update(
    default_chat_service_sid: :unset, 
    default_messaging_service_sid: :unset, 
    default_inactive_timer: :unset, 
    default_closed_timer: :unset
)

    context.update(
        default_chat_service_sid: default_chat_service_sid, 
        default_messaging_service_sid: default_messaging_service_sid, 
        default_inactive_timer: default_inactive_timer, 
        default_closed_timer: default_closed_timer, 
    )
end

#url ⇒ String

Returns An absolute API resource URL for this global configuration.

Returns:

  • (String) —

    An absolute API resource URL for this global configuration.



410
411
412
 
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 410

def url
    @properties['url']
end

#webhooks ⇒ webhooks

Access the webhooks

Returns:



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

def webhooks
    context.webhooks
end