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.users;
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 * Paginated HAL response for {@link UsersClient#listUsers(ListUsersRequest)}.
026 */
027public class ListUsersResponse extends HalPageResponse {
028    @JsonProperty("_embedded") private Embedded embedded;
029
030    static class Embedded extends JsonableBaseObject {
031        @JsonProperty("users") List<BaseUser> users;
032    }
033
034    /**
035     * Retrieves the embedded resource contents. <br>
036     * <b>NOTE: The users returned from this method will only contain the name and ID, not the full record.</b>
037     *
038     * @return The list of users, or {@code null} if absent.
039     */
040    @JsonIgnore
041    public List<BaseUser> getUsers() {
042        return embedded != null ? embedded.users : null;
043    }
044}