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.auth.camara;
017
018import com.fasterxml.jackson.annotation.JsonProperty;
019import com.vonage.client.JsonableBaseObject;
020
021/**
022 * Represents the response from the first step in an OAuth2 three-legged workflow.
023 */
024public final class BackendAuthResponse extends JsonableBaseObject {
025    private String authReqId;
026    private Integer expiresIn, interval;
027
028    private BackendAuthResponse() {}
029
030    /**
031     * ID of the authentication request.
032     *
033     * @return The authentication request ID.
034     */
035    @JsonProperty("auth_req_id")
036    public String getAuthReqId() {
037        return authReqId;
038    }
039
040    /**
041     * Number of seconds until the authentication code expires.
042     *
043     * @return The auth code expiration time in seconds.
044     */
045    @JsonProperty("expires_in")
046    public Integer getExpiresIn() {
047        return expiresIn;
048    }
049
050    /**
051     * Number of seconds until the next request should be made.
052     *
053     * @return The request interval, or {@code null} if unknown / not applicable.
054     */
055    @JsonProperty("interval")
056    public Integer getInterval() {
057        return interval;
058    }
059}