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.conversations;
017
018import com.fasterxml.jackson.annotation.JsonIgnore;
019import com.fasterxml.jackson.annotation.JsonProperty;
020import com.vonage.client.JsonableBaseObject;
021import com.vonage.client.common.HalPageResponse;
022import java.util.List;
023
024/**
025 * HAL response for {@link ConversationsClient#listUserConversations(String)}.
026 */
027public final class ListUserConversationsResponse extends HalPageResponse {
028        @JsonProperty("_embedded") private Embedded _embedded;
029
030        ListUserConversationsResponse() {
031        }
032
033        static final class Embedded extends JsonableBaseObject {
034                private List<UserConversation> conversations;
035
036                @JsonProperty("conversations")
037                public List<UserConversation> getConversations() {
038                        return conversations;
039                }
040        }
041
042        /**
043         * Gets the conversations contained in the {@code _embedded} response.
044         *
045         * @return The conversations for this page.
046         */
047        @JsonIgnore
048        public List<UserConversation> getConversations() {
049                return _embedded != null ? _embedded.getConversations() : null;
050        }
051}