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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Conversations::V1::ConfigurationInstance

Defined in:

lib/twilio-ruby/rest/conversations/v1/configuration.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account responsible for this configuration.

• #context ⇒ ConfigurationContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #default_chat_service_sid ⇒ String

  The SID of the default Conversation Service that every new conversation is associated with.

• #default_closed_timer ⇒ String

  Default ISO8601 duration when conversation will be switched to ‘closed` state.

• #default_inactive_timer ⇒ String

  Default ISO8601 duration when conversation will be switched to ‘inactive` state.

• #default_messaging_service_sid ⇒ String

  The SID of the default Messaging Service that every new conversation is associated with.

• #fetch ⇒ ConfigurationInstance

  Fetch the ConfigurationInstance.

• #initialize(version, payload) ⇒ ConfigurationInstance constructor

  Initialize the ConfigurationInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #links ⇒ String

  Absolute URLs to access the webhook and default service configurations.

• #to_s ⇒ Object

  Provide a user friendly representation.

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

  Update the ConfigurationInstance.

• #url ⇒ String

  An absolute URL for this global configuration.

Constructor Details

#initialize(version, payload) ⇒ ConfigurationInstance

Initialize the ConfigurationInstance

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

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

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

def account_sid
  @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

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

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

#default_chat_service_sid ⇒ String

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

def default_chat_service_sid
  @properties['default_chat_service_sid']
end

#default_closed_timer ⇒ String

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

def default_closed_timer
  @properties['default_closed_timer']
end

#default_inactive_timer ⇒ String

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

def default_inactive_timer
  @properties['default_inactive_timer']
end

#default_messaging_service_sid ⇒ String

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

def default_messaging_service_sid
  @properties['default_messaging_service_sid']
end

#fetch ⇒ ConfigurationInstance

Fetch the ConfigurationInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#links ⇒ String

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

def links
  @properties['links']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

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

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

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

def url
  @properties['url']
end