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.verify;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.Jsonable;
020import com.vonage.client.JsonableBaseObject;
021
022public class ControlResponse extends JsonableBaseObject {
023    private String status;
024    private VerifyControlCommand command;
025    private String errorText;
026
027    private ControlResponse() {
028    }
029
030    public ControlResponse(String status, VerifyControlCommand command) {
031        this.status = status;
032        this.command = command;
033    }
034
035    @JsonProperty("status")
036    public String getStatus() {
037        return status;
038    }
039
040    @JsonProperty("command")
041    public VerifyControlCommand getCommand() {
042        return command;
043    }
044
045    /**
046     * If the status is non-zero, this explains the error encountered.
047     *
048     * @return The error description, or {@code null} if there was no error.
049     */
050    @JsonProperty("error_text")
051    public String getErrorText() {
052        return errorText;
053    }
054
055    public static ControlResponse fromJson(String json) {
056        return Jsonable.fromJson(json);
057    }
058}