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.net.URI;
021import java.util.UUID;
022
023/**
024 * Metadata about an outbound verification request.
025 */
026public class VerificationResponse extends JsonableBaseObject {
027        protected UUID requestId;
028        protected URI checkUrl;
029
030        /**
031         * Protected to prevent users from explicitly creating this object.
032         */
033        protected VerificationResponse() {
034        }
035
036        /**
037         * Returns the UUID of the request that was sent.
038         *
039         * @return The unique request ID.
040         */
041        @JsonProperty("request_id")
042        public UUID getRequestId() {
043                return requestId;
044        }
045
046        /**
047         * URL for Silent Auth Verify workflow completion (only present if using Silent Auth).
048         *
049         * @return The URL to check for Silent Authentication, or {@code null} if not applicable.
050         *
051         * @since 7.10.0
052         */
053        @JsonProperty("check_url")
054        public URI getCheckUrl() {
055                return checkUrl;
056        }
057
058        /**
059         * Creates an instance of this class from a JSON payload.
060         *
061         * @param json The JSON string to parse.
062         * @return An instance of this class with the fields populated, if present.
063         */
064        public static VerificationResponse fromJson(String json) {
065                VerificationResponse response = new VerificationResponse();
066                response.updateFromJson(json);
067                return response;
068        }
069}