Class: Twilio::REST::Verify::V2::ServiceContext::VerificationContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/verify/v2/service/verification.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, service_sid, sid) ⇒ VerificationContext

Initialize the VerificationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • service_sid (String) —

    The SID of the verification [Service](www.twilio.com/docs/verify/api/service) to fetch the resource from.

  • sid (String) —

    The Twilio-provided string that uniquely identifies the Verification resource to fetch.



130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 130

def initialize(version, service_sid, sid)
  super(version)

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

Instance Method Details

#fetch ⇒ VerificationInstance

Fetch a VerificationInstance

Returns:



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 163

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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



189
190
191
192
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 189

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Verify.V2.VerificationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



182
183
184
185
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 182

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

#update(status: nil) ⇒ VerificationInstance

Update the VerificationInstance

Parameters:

  • status (verification.Status) (defaults to: nil) —

    The new status of the resource. Can be: ‘canceled` or `approved`.

Returns:



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/twilio-ruby/rest/verify/v2/service/verification.rb', line 143

def update(status: nil)
  data = Twilio::Values.of({'Status' => status, })

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

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