lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb in twilio-ruby-5.39.2 vs lib/twilio-ruby/rest/verify/v2/service/entity/challenge.rb in twilio-ruby-5.39.3
- old
+ new
@@ -34,12 +34,20 @@
# Create the ChallengeInstance
# @param [String] factor_sid The unique SID identifier of the Factor.
# @param [Time] expiration_date The future date in which this Challenge will
# expire, given in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
# @param [String] details Details provided to give context about the Challenge.
- # Shown to the end user.
+ # Shown to the end user. It must be a stringified JSON with the following
+ # structure: {"message": "string", "fields": [ { "label": "string", "value":
+ # "string"}]}. `message` is required. If you send the `fields` property, each
+ # field has to include `label` and `value` properties. If you had set
+ # `include_date=true` in the `push` configuration of the
+ # [service](https://www.twilio.com/docs/verify/api/service), the response will
+ # also include the challenge's date created value as an additional field called
+ # `date`
# @param [String] hidden_details Details provided to give context about the
- # Challenge. Not shown to the end user.
+ # Challenge. Not shown to the end user. It must be a stringified JSON with only
+ # strings values eg. `{"ip": "172.168.1.234"}`
# @param [String] twilio_sandbox_mode The Twilio-Sandbox-Mode HTTP request header
# @return [ChallengeInstance] Created ChallengeInstance
def create(factor_sid: nil, expiration_date: :unset, details: :unset, hidden_details: :unset, twilio_sandbox_mode: :unset)
data = Twilio::Values.of({
'FactorSid' => factor_sid,
\ No newline at end of file