Class: Twilio::REST::Preview::Proxy::ServiceContext

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/preview/proxy/service.rb,
lib/twilio-ruby/rest/preview/proxy/service/session.rb,
lib/twilio-ruby/rest/preview/proxy/service/short_code.rb,
lib/twilio-ruby/rest/preview/proxy/service/phone_number.rb,
lib/twilio-ruby/rest/preview/proxy/service/session/interaction.rb,
lib/twilio-ruby/rest/preview/proxy/service/session/participant.rb,
lib/twilio-ruby/rest/preview/proxy/service/session/participant/message_interaction.rb

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

Defined Under Namespace

Classes: PhoneNumberContext, PhoneNumberInstance, PhoneNumberList, PhoneNumberPage, SessionContext, SessionInstance, SessionList, SessionPage, ShortCodeContext, ShortCodeInstance, ShortCodeList, ShortCodePage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34 character string that uniquely identifies this Service.



193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 193

def initialize(version, sid)
  super(version)

  # Path Solution
  @solution = {
      sid: sid,
  }
  @uri = "/Services/#{@solution[:sid]}"

  # Dependents
  @sessions = nil
  @phone_numbers = nil
  @short_codes = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



230
231
232
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 230

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 211

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  ServiceInstance.new(
      @version,
      payload,
      sid: @solution[:sid],
  )
end

#phone_numbers(sid = :unset) ⇒ PhoneNumberList, PhoneNumberContext

Access the phone_numbers

Returns:

Raises:

  • (ArgumentError) 


292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 292

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

Returns:

Raises:

  • (ArgumentError) 


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 267

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

Returns:

Raises:

  • (ArgumentError) 


317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 317

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



340
341
342
343
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 340

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.Proxy.ServiceContext #{context}>"
end

#update(friendly_name: :unset, auto_create: :unset, callback_url: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    A human readable description of this resource, up to 64 characters.

  • auto_create (Boolean) (defaults to: :unset) —

    Boolean flag specifying whether to create threads when a user communticates out of band.

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

    The URL Twilio will request for callback notifications.

Returns:



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/twilio-ruby/rest/preview/proxy/service.rb', line 243

def update(friendly_name: :unset, auto_create: :unset, callback_url: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'AutoCreate' => auto_create,
      'CallbackUrl' => callback_url,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  ServiceInstance.new(
      @version,
      payload,
      sid: @solution[:sid],
  )
end