Class: Twilio::REST::Proxy::V1::ServiceContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Proxy::V1::ServiceContext
- Defined in:
- lib/twilio-ruby/rest/proxy/v1/service.rb,
lib/twilio-ruby/rest/proxy/v1/service/session.rb,
lib/twilio-ruby/rest/proxy/v1/service/short_code.rb,
lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb,
lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb,
lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb,
lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb
Overview
PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
Defined Under Namespace
Classes: PhoneNumberContext, PhoneNumberInstance, PhoneNumberList, PhoneNumberPage, SessionContext, SessionInstance, SessionList, SessionPage, ShortCodeContext, ShortCodeInstance, ShortCodeList, ShortCodePage
Instance Method Summary collapse
-
#delete ⇒ Boolean
Delete the ServiceInstance.
-
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance.
-
#initialize(version, sid) ⇒ ServiceContext
constructor
Initialize the ServiceContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#phone_numbers(sid = :unset) ⇒ PhoneNumberList, PhoneNumberContext
Access the phone_numbers.
-
#sessions(sid = :unset) ⇒ SessionList, SessionContext
Access the sessions.
-
#short_codes(sid = :unset) ⇒ ShortCodeList, ShortCodeContext
Access the short_codes.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset) ⇒ ServiceInstance
Update the ServiceInstance.
Constructor Details
#initialize(version, sid) ⇒ ServiceContext
Initialize the ServiceContext
175 176 177 178 179 180 181 182 183 184 185 186 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 175 def initialize(version, sid) super(version) # Path Solution @solution = { sid: sid, } @uri = "/Services/#{@solution[:sid]}" # Dependents @sessions = nil @short_codes = nil @phone_numbers = nil end |
Instance Method Details
#delete ⇒ Boolean
Delete the ServiceInstance
190 191 192 193 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 190 def delete @version.delete('DELETE', @uri) end |
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance
198 199 200 201 202 203 204 205 206 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 198 def fetch payload = @version.fetch('GET', @uri) ServiceInstance.new( @version, payload, sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
316 317 318 319 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 316 def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Proxy.V1.ServiceContext #{context}>" end |
#phone_numbers(sid = :unset) ⇒ PhoneNumberList, PhoneNumberContext
Access the phone_numbers
291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 291 def phone_numbers(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return PhoneNumberContext.new(@version, @solution[:sid],sid ) end unless @phone_numbers @phone_numbers = PhoneNumberList.new( @version, service_sid: @solution[:sid], ) end @phone_numbers end |
#sessions(sid = :unset) ⇒ SessionList, SessionContext
Access the sessions
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 253 def sessions(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return SessionContext.new(@version, @solution[:sid],sid ) end unless @sessions @sessions = SessionList.new( @version, service_sid: @solution[:sid], ) end @sessions end |
#short_codes(sid = :unset) ⇒ ShortCodeList, ShortCodeContext
Access the short_codes
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 272 def short_codes(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return ShortCodeContext.new(@version, @solution[:sid],sid ) end unless @short_codes @short_codes = ShortCodeList.new( @version, service_sid: @solution[:sid], ) end @short_codes end |
#to_s ⇒ Object
Provide a user friendly representation
309 310 311 312 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 309 def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Proxy.V1.ServiceContext #{context}>" end |
#update(unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset) ⇒ ServiceInstance
Update the ServiceInstance
219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 |
# File 'lib/twilio-ruby/rest/proxy/v1/service.rb', line 219 def update( unique_name: :unset, default_ttl: :unset, callback_url: :unset, geo_match_level: :unset, number_selection_behavior: :unset, intercept_callback_url: :unset, out_of_session_callback_url: :unset, chat_instance_sid: :unset ) data = Twilio::Values.of({ 'UniqueName' => unique_name, 'DefaultTtl' => default_ttl, 'CallbackUrl' => callback_url, 'GeoMatchLevel' => geo_match_level, 'NumberSelectionBehavior' => number_selection_behavior, 'InterceptCallbackUrl' => intercept_callback_url, 'OutOfSessionCallbackUrl' => out_of_session_callback_url, 'ChatInstanceSid' => chat_instance_sid, }) payload = @version.update('POST', @uri, data: data) ServiceInstance.new( @version, payload, sid: @solution[:sid], ) end |