Class: Twilio::REST::Preview::AccSecurity::ServiceContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/acc_security/service.rb,
lib/twilio-ruby/rest/preview/acc_security/service/verification.rb,
lib/twilio-ruby/rest/preview/acc_security/service/verification_check.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: VerificationCheckInstance, VerificationCheckList, VerificationCheckPage, VerificationInstance, VerificationList, VerificationPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ ServiceContext

Initialize the ServiceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The unique SID identifier of Verification Service Instance.



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/preview/acc_security/service.rb', line 189

def initialize(version, sid)
  super(version)

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

  # Dependents
  @verifications = nil
  @verification_checks = nil
end

Instance Method Details

#fetch ⇒ ServiceInstance

Fetch a ServiceInstance

Returns:



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/twilio-ruby/rest/preview/acc_security/service.rb', line 206

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

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

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

#to_s ⇒ Object

Provide a user friendly representation



279
280
281
282
 
# File 'lib/twilio-ruby/rest/preview/acc_security/service.rb', line 279

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

#update(name: :unset, code_length: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    A 1-64 character string with friendly name of service

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

    The length of the verification code to be generated. Must be an integer value between 4-10

Returns:



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/twilio-ruby/rest/preview/acc_security/service.rb', line 228

def update(name: :unset, code_length: :unset)
  data = Twilio::Values.of({
      'Name' => name,
      'CodeLength' => code_length,
  })

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

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

#verification_checks ⇒ VerificationCheckList, VerificationCheckContext

Access the verification_checks

Returns:



266
267
268
269
270
271
272
273
274
275
 
# File 'lib/twilio-ruby/rest/preview/acc_security/service.rb', line 266

def verification_checks
  unless @verification_checks
    @verification_checks = VerificationCheckList.new(
        @version,
        service_sid: @solution[:sid],
    )
  end

  @verification_checks
end

#verifications ⇒ VerificationList, VerificationContext

Access the verifications

Returns:



251
252
253
254
255
256
257
258
259
260
 
# File 'lib/twilio-ruby/rest/preview/acc_security/service.rb', line 251

def verifications
  unless @verifications
    @verifications = VerificationList.new(
        @version,
        service_sid: @solution[:sid],
    )
  end

  @verifications
end