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 collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/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](www.twilio.com/docs/conversations/api/service-resource) used when creating a conversation.
-
#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](www.twilio.com/docs/messaging/api/service-resource) used when creating a conversation.
-
#fetch ⇒ ConfigurationInstance
Fetch the ConfigurationInstance.
-
#initialize(version, payload) ⇒ ConfigurationInstance
constructor
Initialize the ConfigurationInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#links ⇒ Hash
Contains absolute API resource 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 API resource URL for this global configuration.
-
#webhooks ⇒ webhooks
Access the webhooks.
Constructor Details
#initialize(version, payload) ⇒ ConfigurationInstance
Initialize the ConfigurationInstance
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 160 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.
192 193 194 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 192 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
183 184 185 186 187 188 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 183 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.
198 199 200 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 198 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.
216 217 218 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 216 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.
210 211 212 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 210 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.
204 205 206 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 204 def default_messaging_service_sid @properties['default_messaging_service_sid'] end |
#fetch ⇒ ConfigurationInstance
Fetch the ConfigurationInstance
235 236 237 238 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 235 def fetch context.fetch end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
278 279 280 281 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 278 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.
228 229 230 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 228 def links @properties['links'] end |
#to_s ⇒ Object
Provide a user friendly representation
271 272 273 274 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 271 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
247 248 249 250 251 252 253 254 255 256 257 258 259 260 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 247 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.
222 223 224 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 222 def url @properties['url'] end |
#webhooks ⇒ webhooks
Access the webhooks
265 266 267 |
# File 'lib/twilio-ruby/rest/conversations/v1/configuration.rb', line 265 def webhooks context.webhooks end |