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.JsonCreator;
019import com.fasterxml.jackson.annotation.JsonProperty;
020import com.vonage.client.VonageApiResponseException;
021import java.util.UUID;
022
023/**
024 * Response returned when verification fails (i.e. returns a non-2xx status code).
025 */
026public final class VerifyResponseException extends VonageApiResponseException {
027        UUID requestId;
028
029        void setStatusCode(int statusCode) {
030                this.statusCode = statusCode;
031        }
032
033        /**
034         * The request ID, if the status code is 409 for a failed outbound request.
035         *
036         * @return The request ID, or {@code null} if not applicable / available.
037         */
038        @JsonProperty("request_id")
039        public UUID getRequestId() {
040                return requestId;
041        }
042
043        /**
044         * Creates an instance of this class from a JSON payload.
045         *
046         * @param json The JSON string to parse.
047         * @return An instance of this class with all known fields populated from the JSON payload, if present.
048         */
049        @JsonCreator
050        public static VerifyResponseException fromJson(String json) {
051                return fromJson(VerifyResponseException.class, json);
052        }
053}