001/*
002 *   Copyright 2024 Vonage
003 *
004 *   Licensed under the Apache License, Version 2.0 (the "License");
005 *   you may not use this file except in compliance with the License.
006 *   You may obtain a copy of the License at
007 *
008 *        http://www.apache.org/licenses/LICENSE-2.0
009 *
010 *   Unless required by applicable law or agreed to in writing, software
011 *   distributed under the License is distributed on an "AS IS" BASIS,
012 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 *   See the License for the specific language governing permissions and
014 *   limitations under the License.
015 */
016package com.vonage.client.verify2;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.JsonableBaseObject;
020import java.util.UUID;
021
022/**
023 * Represents the response from {@link Verify2Client#checkVerificationCode(UUID, String)}.
024 *
025 * @since 8.9.2
026 */
027public final class VerifyCodeResponse extends JsonableBaseObject {
028    private UUID requestId;
029    private VerificationStatus status;
030
031    private VerifyCodeResponse() {}
032
033    /**
034     * ID of the verify request.
035     *
036     * @return The verify request ID.
037     */
038    @JsonProperty("request_id")
039    public UUID getRequestId() {
040        return requestId;
041    }
042
043    /**
044     * Status of the verification workflow.
045     *
046     * @return The status as an enum.
047     */
048    @JsonProperty("status")
049    public VerificationStatus getStatus() {
050        return status;
051    }
052}