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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/verify/v2/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.



150
151
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
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 150

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.



206
207
208
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 206

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:



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

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:



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

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:



236
237
238
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 236

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:



248
249
250
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 248

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:



242
243
244
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 242

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.



272
273
274
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 272

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.



218
219
220
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 218

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:



254
255
256
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 254

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.



230
231
232
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 230

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.



290
291
292
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 290

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.



278
279
280
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 278

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.



224
225
226
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 224

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



326
327
328
329
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 326

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.



302
303
304
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 302

def links
    @properties['links']
end

#metadata ⇒ Hash

Returns Custom metadata associated with the challenge.

Returns:

  • (Hash) —

    Custom metadata associated with the challenge.



284
285
286
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 284

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`.



194
195
196
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 194

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`.



266
267
268
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 266

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.



212
213
214
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 212

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.



200
201
202
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 200

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`.



260
261
262
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 260

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



319
320
321
322
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 319

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.



296
297
298
 
# File 'lib/twilio-ruby/rest/verify/v2/new_challenge.rb', line 296

def url
    @properties['url']
end