SearchCollectionsRequest.java

/*
 * tmdb-java-client - A client to access the TMDB API
 * Copyright © 2024-2025 Andy Miles (andy.miles@amilesend.com)
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
package com.amilesend.tmdb.client.model.search;

import com.amilesend.tmdb.client.model.QueryParameter;
import com.amilesend.tmdb.client.model.search.type.SearchRequestBase;
import lombok.EqualsAndHashCode;
import lombok.Getter;
import lombok.NonNull;
import lombok.ToString;
import lombok.experimental.SuperBuilder;
import okhttp3.HttpUrl;

import static com.amilesend.tmdb.client.model.QueryParameterBasedRequest.appendIfNotBlank;
import static com.amilesend.tmdb.client.model.QueryParameterBasedRequest.appendIfNotNull;

/**
 * The request to search for collections by their alternative, original, and translated names.
 *
 * @see SearchRequestBase
 */
@SuperBuilder
@EqualsAndHashCode(callSuper = true)
@Getter
@ToString(callSuper = true)
public class SearchCollectionsRequest extends SearchRequestBase {
    /** Flag to include adult-flagged resources in the search (optional). */
    @QueryParameter
    private final Boolean includeAdult;
    /** The language to filter on (optional). */
    @QueryParameter
    private final String language;
    /** The region to filter on (optional). */
    @QueryParameter
    private final String region;

    @Override
    public HttpUrl.Builder populateQueryParameters(@NonNull HttpUrl.Builder urlBuilder) {
        urlBuilder = super.populateQueryParameters(urlBuilder);
        appendIfNotNull(urlBuilder, "include_adult", includeAdult);
        appendIfNotBlank(urlBuilder, "language", language);
        appendIfNotBlank(urlBuilder, "region", region);
        return urlBuilder;
    }
}