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


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# 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

Returns The SID of the Account responsible for this configuration.

Returns:

  • (String) —

    The SID of the Account responsible for this configuration.


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

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:


164
165
166
167
168
169
 
# 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

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

Returns:

  • (String) —

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


179
180
181
 
# 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

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

Returns:

  • (String) —

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


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

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.

Returns:

  • (String) —

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


191
192
193
 
# 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

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

Returns:

  • (String) —

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


185
186
187
 
# 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

Returns:


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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


252
253
254
255
 
# 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

Returns Absolute URLs to access the webhook and default service configurations.

Returns:

  • (String) —

    Absolute URLs to access the webhook and default service configurations.


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

def links
  @properties['links']
end

#to_s ⇒ Object

Provide a user friendly representation


245
246
247
248
 
# 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

Parameters:

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

    The SID of the default Conversation Service to use when creating a conversation.

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

    The SID of the default Messaging Service 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:


234
235
236
237
238
239
240
241
 
# 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

Returns An absolute URL for this global configuration.

Returns:

  • (String) —

    An absolute URL for this global configuration.


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

def url
  @properties['url']
end