Class: Twilio::REST::Verify::V2::ServiceContext
- Inherits:
-
InstanceContext
- Object
- InstanceContext
- Twilio::REST::Verify::V2::ServiceContext
- Defined in:
- lib/twilio-ruby/rest/verify/v2/service.rb,
lib/twilio-ruby/rest/verify/v2/service/entity.rb,
lib/twilio-ruby/rest/verify/v2/service/webhook.rb,
lib/twilio-ruby/rest/verify/v2/service/rate_limit.rb,
lib/twilio-ruby/rest/verify/v2/service/access_token.rb,
lib/twilio-ruby/rest/verify/v2/service/verification.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/factor.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/new_factor.rb,
lib/twilio-ruby/rest/verify/v2/service/rate_limit/bucket.rb,
lib/twilio-ruby/rest/verify/v2/service/verification_check.rb,
lib/twilio-ruby/rest/verify/v2/service/messaging_configuration.rb,
lib/twilio-ruby/rest/verify/v2/service/entity/challenge/notification.rb
Defined Under Namespace
Classes: AccessTokenContext, AccessTokenInstance, AccessTokenList, AccessTokenPage, EntityContext, EntityInstance, EntityList, EntityPage, MessagingConfigurationContext, MessagingConfigurationInstance, MessagingConfigurationList, MessagingConfigurationPage, RateLimitContext, RateLimitInstance, RateLimitList, RateLimitPage, VerificationCheckInstance, VerificationCheckList, VerificationCheckPage, VerificationContext, VerificationInstance, VerificationList, VerificationPage, WebhookContext, WebhookInstance, WebhookList, WebhookPage
Instance Method Summary collapse
-
#access_tokens(sid = :unset) ⇒ AccessTokenList, AccessTokenContext
Access the access_tokens.
-
#delete ⇒ Boolean
Delete the ServiceInstance.
-
#entities(identity = :unset) ⇒ EntityList, EntityContext
Access the entities.
-
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance.
-
#initialize(version, sid) ⇒ ServiceContext
constructor
Initialize the ServiceContext.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#messaging_configurations(country = :unset) ⇒ MessagingConfigurationList, MessagingConfigurationContext
Access the messaging_configurations.
-
#rate_limits(sid = :unset) ⇒ RateLimitList, RateLimitContext
Access the rate_limits.
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset) ⇒ ServiceInstance
Update the ServiceInstance.
-
#verification_checks ⇒ VerificationCheckList, VerificationCheckContext
Access the verification_checks.
-
#verifications(sid = :unset) ⇒ VerificationList, VerificationContext
Access the verifications.
-
#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext
Access the webhooks.
Constructor Details
#initialize(version, sid) ⇒ ServiceContext
Initialize the ServiceContext
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 200 def initialize(version, sid) super(version) # Path Solution @solution = { sid: sid, } @uri = "/Services/#{@solution[:sid]}" # Dependents @verification_checks = nil @verifications = nil @access_tokens = nil @webhooks = nil @messaging_configurations = nil @entities = nil @rate_limits = nil end |
Instance Method Details
#access_tokens(sid = :unset) ⇒ AccessTokenList, AccessTokenContext
Access the access_tokens
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 339 def access_tokens(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return AccessTokenContext.new(@version, @solution[:sid],sid ) end unless @access_tokens @access_tokens = AccessTokenList.new( @version, service_sid: @solution[:sid], ) end @access_tokens end |
#delete ⇒ Boolean
Delete the ServiceInstance
219 220 221 222 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 219 def delete @version.delete('DELETE', @uri) end |
#entities(identity = :unset) ⇒ EntityList, EntityContext
Access the entities
396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 396 def entities(identity=:unset) raise ArgumentError, 'identity cannot be nil' if identity.nil? if identity != :unset return EntityContext.new(@version, @solution[:sid],identity ) end unless @entities @entities = EntityList.new( @version, service_sid: @solution[:sid], ) end @entities end |
#fetch ⇒ ServiceInstance
Fetch the ServiceInstance
227 228 229 230 231 232 233 234 235 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 227 def fetch payload = @version.fetch('GET', @uri) ServiceInstance.new( @version, payload, sid: @solution[:sid], ) end |
#inspect ⇒ Object
Provide a detailed, user friendly representation
440 441 442 443 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 440 def inspect context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Verify.V2.ServiceContext #{context}>" end |
#messaging_configurations(country = :unset) ⇒ MessagingConfigurationList, MessagingConfigurationContext
Access the messaging_configurations
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 377 def messaging_configurations(country=:unset) raise ArgumentError, 'country cannot be nil' if country.nil? if country != :unset return MessagingConfigurationContext.new(@version, @solution[:sid],country ) end unless @messaging_configurations @messaging_configurations = MessagingConfigurationList.new( @version, service_sid: @solution[:sid], ) end @messaging_configurations end |
#rate_limits(sid = :unset) ⇒ RateLimitList, RateLimitContext
Access the rate_limits
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 415 def rate_limits(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return RateLimitContext.new(@version, @solution[:sid],sid ) end unless @rate_limits @rate_limits = RateLimitList.new( @version, service_sid: @solution[:sid], ) end @rate_limits end |
#to_s ⇒ Object
Provide a user friendly representation
433 434 435 436 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 433 def to_s context = @solution.map{|k, v| "#{k}: #{v}"}.join(',') "#<Twilio.Verify.V2.ServiceContext #{context}>" end |
#update(friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset) ⇒ ServiceInstance
Update the ServiceInstance
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 257 def update( friendly_name: :unset, code_length: :unset, lookup_enabled: :unset, skip_sms_to_landlines: :unset, dtmf_input_required: :unset, tts_name: :unset, psd2_enabled: :unset, do_not_share_warning_enabled: :unset, custom_code_enabled: :unset, push_include_date: :unset, push_apn_credential_sid: :unset, push_fcm_credential_sid: :unset, totp_issuer: :unset, totp_time_step: :unset, totp_code_length: :unset, totp_skew: :unset, default_template_sid: :unset ) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'CodeLength' => code_length, 'LookupEnabled' => lookup_enabled, 'SkipSmsToLandlines' => skip_sms_to_landlines, 'DtmfInputRequired' => dtmf_input_required, 'TtsName' => tts_name, 'Psd2Enabled' => psd2_enabled, 'DoNotShareWarningEnabled' => do_not_share_warning_enabled, 'CustomCodeEnabled' => custom_code_enabled, 'Push.IncludeDate' => push_include_date, 'Push.ApnCredentialSid' => push_apn_credential_sid, 'Push.FcmCredentialSid' => push_fcm_credential_sid, 'Totp.Issuer' => totp_issuer, 'Totp.TimeStep' => totp_time_step, 'Totp.CodeLength' => totp_code_length, 'Totp.Skew' => totp_skew, 'DefaultTemplateSid' => default_template_sid, }) payload = @version.update('POST', @uri, data: data) ServiceInstance.new( @version, payload, sid: @solution[:sid], ) end |
#verification_checks ⇒ VerificationCheckList, VerificationCheckContext
Access the verification_checks
309 310 311 312 313 314 315 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 309 def verification_checks unless @verification_checks @verification_checks = VerificationCheckList.new( @version, service_sid: @solution[:sid], ) end @verification_checks end |
#verifications(sid = :unset) ⇒ VerificationList, VerificationContext
Access the verifications
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 320 def verifications(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return VerificationContext.new(@version, @solution[:sid],sid ) end unless @verifications @verifications = VerificationList.new( @version, service_sid: @solution[:sid], ) end @verifications end |
#webhooks(sid = :unset) ⇒ WebhookList, WebhookContext
Access the webhooks
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/twilio-ruby/rest/verify/v2/service.rb', line 358 def webhooks(sid=:unset) raise ArgumentError, 'sid cannot be nil' if sid.nil? if sid != :unset return WebhookContext.new(@version, @solution[:sid],sid ) end unless @webhooks @webhooks = WebhookList.new( @version, service_sid: @solution[:sid], ) end @webhooks end |