Class: Twilio::REST::Verify::V2::ServiceContext::NewChallengeInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, service_sid: nil) ⇒ NewChallengeInstance

Initialize the NewChallengeInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this NewChallenge resource.

  • sid (String) —

    The SID of the Call resource to fetch.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 152

def initialize(version, payload , service_sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'options' => payload['options'],
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'entity_sid' => payload['entity_sid'],
        'identity' => payload['identity'],
        'factor_sid' => payload['factor_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'date_responded' => Twilio.deserialize_iso8601_datetime(payload['date_responded']),
        'expiration_date' => Twilio.deserialize_iso8601_datetime(payload['expiration_date']),
        'status' => payload['status'],
        'responded_reason' => payload['responded_reason'],
        'details' => payload['details'],
        'hidden_details' => payload['hidden_details'],
        'metadata' => payload['metadata'],
        'factor_type' => payload['factor_type'],
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'service_sid' => service_sid  || @properties['service_sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



208
209
210
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 208

def 
    @properties['account_sid']
end

#context ⇒ NewChallengeContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



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

def context
    unless @instance_context
        @instance_context = NewChallengeContext.new(@version , @params['service_sid'])
    end
    @instance_context
end

#create(create_passkeys_challenge_request: nil) ⇒ NewChallengeInstance

Create the NewChallengeInstance

Parameters:

  • create_passkeys_challenge_request (CreatePasskeysChallengeRequest) (defaults to: nil)

Returns:



312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 312

def create(create_passkeys_challenge_request: nil
)

    context.create(
    )
end

#date_created ⇒ Time

Returns The date that this Challenge was created, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



238
239
240
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 238

def date_created
    @properties['date_created']
end

#date_responded ⇒ Time

Returns The date that this Challenge was responded, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



250
251
252
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 250

def date_responded
    @properties['date_responded']
end

#date_updated ⇒ Time

Returns The date that this Challenge was updated, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



244
245
246
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 244

def date_updated
    @properties['date_updated']
end

#details ⇒ Hash

Returns Details provided to give context about the Challenge.

Returns:

  • (Hash) —

    Details provided to give context about the Challenge.



274
275
276
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 274

def details
    @properties['details']
end

#entity_sid ⇒ String

Returns The unique SID identifier of the Entity.

Returns:

  • (String) —

    The unique SID identifier of the Entity.



220
221
222
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 220

def entity_sid
    @properties['entity_sid']
end

#expiration_date ⇒ Time

Returns The date-time when this Challenge expires, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



256
257
258
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 256

def expiration_date
    @properties['expiration_date']
end

#factor_sid ⇒ String

Returns The unique SID identifier of the Factor.

Returns:

  • (String) —

    The unique SID identifier of the Factor.



232
233
234
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 232

def factor_sid
    @properties['factor_sid']
end

#factor_type ⇒ String

Returns The Factor Type of this Challenge. Currently ‘push` and `totp` are supported.

Returns:

  • (String) —

    The Factor Type of this Challenge. Currently ‘push` and `totp` are supported.



292
293
294
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 292

def factor_type
    @properties['factor_type']
end

#hidden_details ⇒ Hash

Returns Details provided to give context about the Challenge.

Returns:

  • (Hash) —

    Details provided to give context about the Challenge.



280
281
282
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 280

def hidden_details
    @properties['hidden_details']
end

#identity ⇒ String

Returns Customer unique identity for the Entity owner of the Challenge.

Returns:

  • (String) —

    Customer unique identity for the Entity owner of the Challenge.



226
227
228
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 226

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



328
329
330
331
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 328

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Verify.V2.NewChallengeInstance #{values}>"
end

#links ⇒ Hash

Returns Contains a dictionary of URL links to nested resources of this Challenge.

Returns:

  • (Hash) —

    Contains a dictionary of URL links to nested resources of this Challenge.



304
305
306
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 304

def links
    @properties['links']
end

#metadata ⇒ Hash

Returns Custom metadata associated with the challenge.

Returns:

  • (Hash) —

    Custom metadata associated with the challenge.



286
287
288
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 286

def metadata
    @properties['metadata']
end

#options ⇒ Hash

Returns An object that contains challenge options. Currently only used for ‘passkeys`.

Returns:

  • (Hash) —

    An object that contains challenge options. Currently only used for ‘passkeys`.



196
197
198
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 196

def options
    @properties['options']
end

#responded_reason ⇒ String

Returns Reason for the Challenge to be in certain ‘status`. One of `none`, `not_needed` or `not_requested`.

Returns:

  • (String) —

    Reason for the Challenge to be in certain ‘status`. One of `none`, `not_needed` or `not_requested`.



268
269
270
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 268

def responded_reason
    @properties['responded_reason']
end

#service_sid ⇒ String

Returns The unique SID identifier of the Service.

Returns:

  • (String) —

    The unique SID identifier of the Service.



214
215
216
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 214

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this Challenge.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this Challenge.



202
203
204
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 202

def sid
    @properties['sid']
end

#status ⇒ String

Returns The Status of this Challenge. One of ‘pending`, `expired`, `approved` or `denied`.

Returns:

  • (String) —

    The Status of this Challenge. One of ‘pending`, `expired`, `approved` or `denied`.



262
263
264
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 262

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



321
322
323
324
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 321

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Verify.V2.NewChallengeInstance #{values}>"
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



298
299
300
 
# File 'lib/twilio-ruby/rest/verify/v2/service/new_challenge.rb', line 298

def url
    @properties['url']
end