Class: Telnyx::Resources::Verifications::Actions

Inherits:

Object

• Object
• Telnyx::Resources::Verifications::Actions

Defined in:

lib/telnyx/resources/verifications/actions.rb

Overview

Two factor authentication API

Instance Method Summary

• #initialize(client:) ⇒ Actions constructor private

  A new instance of Actions.

• #verify(verification_id, code: nil, status: nil, request_options: {}) ⇒ Telnyx::Models::Verifications::ByPhoneNumber::VerifyVerificationCodeResponse

  Some parameter documentations has been truncated, see Models::Verifications::ActionVerifyParams for more details.

Constructor Details

#initialize(client:) ⇒ Actions

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Actions.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/verifications/actions.rb', line 40

def initialize(client:)
  @client = client
end

Instance Method Details

#verify(verification_id, code: nil, status: nil, request_options: {}) ⇒ Telnyx::Models::Verifications::ByPhoneNumber::VerifyVerificationCodeResponse

Some parameter documentations has been truncated, see Models::Verifications::ActionVerifyParams for more details.

Verify verification code by ID

Parameters:

• verification_id (String) —

  The identifier of the verification to retrieve.

• code (String) —

  This is the code the user submits for verification.

• status (Symbol, Telnyx::Models::Verifications::ActionVerifyParams::Status) —

  Identifies if the verification code has been accepted or rejected. Only permitte

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Verifications::ByPhoneNumber::VerifyVerificationCodeResponse)

See Also:

• Models::Verifications::ActionVerifyParams

# File 'lib/telnyx/resources/verifications/actions.rb', line 26

def verify(verification_id, params = {})
  parsed, options = Telnyx::Verifications::ActionVerifyParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["verifications/%1$s/actions/verify", verification_id],
    body: parsed,
    model: Telnyx::Verifications::ByPhoneNumber::VerifyVerificationCodeResponse,
    options: options
  )
end