// Generated by delombok at Tue Dec 10 13:42:03 UTC 2024
/*
 * Copyright (c) 2010-2024 Mark Allen, Norbert Bartels.
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package com.restfb.types;

import static java.util.Collections.unmodifiableList;
import java.util.ArrayList;
import java.util.List;
import com.restfb.Facebook;
import com.restfb.JsonMapper;
import com.restfb.types.ads.AppLinks;
import com.restfb.types.features.HasCover;
import com.restfb.types.features.HasProfilePicture;

/**
 * Represents the <a href="https://developers.facebook.com/docs/places/fields">SearchPlace</a>
 */
public class SearchPlace extends NamedFacebookType implements HasProfilePicture, HasCover {
  /**
   * Information about the Place provided by the Page administrator.
   */
  @Facebook
  private String about;
  /**
   * AppLinks to the Place on various devices.
   */
  @Facebook("app_links")
  private AppLinks appLinks;
  @Facebook("category_list")
  private List<Category> categoryList = new ArrayList<>();
  /**
   * The number of checkins at this Place.
   */
  @Facebook
  private Long checkins;
  /**
   * Information about the cover photo.
   */
  @Facebook
  private CoverPhoto cover;
  /**
   * The description of the Place provided by the Page administrator.
   */
  @Facebook
  private String description;
  /**
   * The social sentence and the like count information for this Place. This is the same information used for the like
   * button.
   */
  @Facebook
  private Page.Engagement engagement;
  /**
   */
  @Facebook
  private String hours;
  /**
   * Indicates whether this Place is always open.
   */
  @Facebook("is_always_open")
  private Boolean isAlwaysOpen;
  /**
   * Indicates whether this Place is permanently closed.
   */
  @Facebook("is_permanently_closed")
  private Boolean isPermanentlyClosed;
  /**
   * Pages with a large number of followers can be manually verified by Facebook as having an authentic identity. This
   * field indicates whether the Page has been verified by this process.
   */
  @Facebook("is_verified")
  private Boolean isVerified;
  /**
   * The URL of the Facebook Page.
   */
  @Facebook
  private String link;
  /**
   * Location information about the Place. E.g., latitude and longitude, and address.
   */
  @Facebook
  private Location location;
  /**
   * The overall page rating, based on rating survey from users, on a scale of 1-5.
   *
   * This value is normalized, and is not guaranteed to be a strict average of user ratings.
   */
  @Facebook("overall_star_rating")
  private Double overallStarRating;
  /**
   * The Page node corresponding to the Place.
   */
  @Facebook
  private Page page;
  /**
   * Parking information about the Place.
   */
  @Facebook
  private Page.PageParking parking;
  /**
   * Payment options accepted by the Place. Applicable to restaurants and nightlife.
   */
  @Facebook("payment_options")
  private Page.PagePaymentOptions paymentOptions;
  /**
   * The Place's telephone number.
   */
  @Facebook
  private String phone;
  /**
   * The pages's profile picture, if provided.
   *
   * To force Facebook to fill the <code>picture</code> field you have to fetch the page with the
   * <code>fields=picture</code> parameter, otherwise the picture is <code>null</code>.
   */
  private ProfilePictureSource picture;
  @Facebook("picture")
  private transient String rawPicture;
  /**
   * Price range of the business.
   *
   * Applicable to Restaurants or Nightlife. Can be one of $ (0-10), $$ (10-30), $$$ (30-50), $$$$ (50+), or Unspecified
   */
  @Facebook("price_range")
  private String priceRange;
  /**
   * Number of ratings for the Place
   */
  @Facebook("rating_count")
  private Long ratingCount;
  /**
   * The services that the restaurant provides.
   */
  @Facebook("restaurant_services")
  private Page.PageRestaurantServices restaurantServices;
  /**
   * The restaurant's specialties.
   */
  @Facebook("restaurant_specialties")
  private Page.PageRestaurantSpecialties restaurantSpecialties;
  /**
   * The Place's complete postal address, on a single line.
   */
  @Facebook("single_line_address")
  private String singleLineAddress;
  /**
   * The URL of the Place's website.
   */
  @Facebook
  private String website;
  /**
   * Photos for the Place.
   *
   * By default, this edge returns the profile photos for the Place. You can also use an optional type parameter with
   * the value uploaded to get the photos uploaded by the Place.
   */
  @Facebook
  private List<Photo> photos = new ArrayList<>();
  /**
   * The native component workflows for this Place.
   *
   * Workflows allow people to perform actions like requesting appointments, buying tickets, and ordering from
   * restaurants on Facebook
   */
  @Facebook
  private List<PagesPlatformComponentFlowServiceConfig> workflows = new ArrayList<>();

  @JsonMapper.JsonMappingCompleted
  protected void fillProfilePicture(JsonMapper jsonMapper) {
    picture = convertPicture(jsonMapper, rawPicture);
  }

  /**
   * The Place's categories.
   *
   * @return The Place's categories.
   */
  public List<Category> getCategoryList() {
    return unmodifiableList(categoryList);
  }

  public boolean addCategory(Category category) {
    return categoryList.add(category);
  }

  public boolean removeCategory(Category category) {
    return categoryList.remove(category);
  }


  public static class PagesPlatformComponentFlowServiceConfig extends FacebookType {
    @Facebook
    private String deeplink;
    @Facebook
    private String label;
    @Facebook("flow_category")
    private String flowCategory;

    @java.lang.SuppressWarnings("all")
    public String getDeeplink() {
      return this.deeplink;
    }

    @java.lang.SuppressWarnings("all")
    public void setDeeplink(final String deeplink) {
      this.deeplink = deeplink;
    }

    @java.lang.SuppressWarnings("all")
    public String getLabel() {
      return this.label;
    }

    @java.lang.SuppressWarnings("all")
    public void setLabel(final String label) {
      this.label = label;
    }

    @java.lang.SuppressWarnings("all")
    public String getFlowCategory() {
      return this.flowCategory;
    }

    @java.lang.SuppressWarnings("all")
    public void setFlowCategory(final String flowCategory) {
      this.flowCategory = flowCategory;
    }
  }

  /**
   * Information about the Place provided by the Page administrator.
   *
   * @return Information about the Place provided by the Page administrator.
   */
  @java.lang.SuppressWarnings("all")
  public String getAbout() {
    return this.about;
  }

  /**
   * Information about the Place provided by the Page administrator.
   */
  @java.lang.SuppressWarnings("all")
  public void setAbout(final String about) {
    this.about = about;
  }

  /**
   * AppLinks to the Place on various devices.
   *
   * @return AppLinks to the Place on various devices.
   */
  @java.lang.SuppressWarnings("all")
  public AppLinks getAppLinks() {
    return this.appLinks;
  }

  /**
   * AppLinks to the Place on various devices.
   */
  @java.lang.SuppressWarnings("all")
  public void setAppLinks(final AppLinks appLinks) {
    this.appLinks = appLinks;
  }

  /**
   * The number of checkins at this Place.
   *
   * @return The number of checkins at this Place.
   */
  @java.lang.SuppressWarnings("all")
  public Long getCheckins() {
    return this.checkins;
  }

  /**
   * The number of checkins at this Place.
   */
  @java.lang.SuppressWarnings("all")
  public void setCheckins(final Long checkins) {
    this.checkins = checkins;
  }

  /**
   * Information about the cover photo.
   *
   * @return Information about the cover photo.
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public CoverPhoto getCover() {
    return this.cover;
  }

  /**
   * Information about the cover photo.
   */
  @java.lang.SuppressWarnings("all")
  public void setCover(final CoverPhoto cover) {
    this.cover = cover;
  }

  /**
   * The description of the Place provided by the Page administrator.
   *
   * @return The description of the Place provided by the Page administrator.
   */
  @java.lang.SuppressWarnings("all")
  public String getDescription() {
    return this.description;
  }

  /**
   * The description of the Place provided by the Page administrator.
   */
  @java.lang.SuppressWarnings("all")
  public void setDescription(final String description) {
    this.description = description;
  }

  /**
   * The social sentence and the like count information for this Place. This is the same information used for the like
   * button.
   *
   * @return The social sentence and the like count information for this Place.
   */
  @java.lang.SuppressWarnings("all")
  public Page.Engagement getEngagement() {
    return this.engagement;
  }

  /**
   * The social sentence and the like count information for this Place. This is the same information used for the like
   * button.
   */
  @java.lang.SuppressWarnings("all")
  public void setEngagement(final Page.Engagement engagement) {
    this.engagement = engagement;
  }

  /**
   */
  @java.lang.SuppressWarnings("all")
  public String getHours() {
    return this.hours;
  }

  /**
   */
  @java.lang.SuppressWarnings("all")
  public void setHours(final String hours) {
    this.hours = hours;
  }

  /**
   * Indicates whether this Place is always open.
   *
   * @return Indicates whether this Place is always open.
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getIsAlwaysOpen() {
    return this.isAlwaysOpen;
  }

  /**
   * Indicates whether this Place is always open.
   */
  @java.lang.SuppressWarnings("all")
  public void setIsAlwaysOpen(final Boolean isAlwaysOpen) {
    this.isAlwaysOpen = isAlwaysOpen;
  }

  /**
   * Indicates whether this Place is permanently closed.
   *
   * @return Indicates whether this Place is permanently closed.
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getIsPermanentlyClosed() {
    return this.isPermanentlyClosed;
  }

  /**
   * Indicates whether this Place is permanently closed.
   */
  @java.lang.SuppressWarnings("all")
  public void setIsPermanentlyClosed(final Boolean isPermanentlyClosed) {
    this.isPermanentlyClosed = isPermanentlyClosed;
  }

  /**
   * Pages with a large number of followers can be manually verified by Facebook as having an authentic identity. This
   * field indicates whether the Page has been verified by this process.
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getIsVerified() {
    return this.isVerified;
  }

  /**
   * Pages with a large number of followers can be manually verified by Facebook as having an authentic identity. This
   * field indicates whether the Page has been verified by this process.
   */
  @java.lang.SuppressWarnings("all")
  public void setIsVerified(final Boolean isVerified) {
    this.isVerified = isVerified;
  }

  /**
   * The URL of the Facebook Page.
   *
   * @return The URL of the Facebook Page.
   */
  @java.lang.SuppressWarnings("all")
  public String getLink() {
    return this.link;
  }

  /**
   * The URL of the Facebook Page.
   */
  @java.lang.SuppressWarnings("all")
  public void setLink(final String link) {
    this.link = link;
  }

  /**
   * Location information about the Place. E.g., latitude and longitude, and address.
   *
   * @return Location information about the Place. E.g., latitude and longitude, and address.
   */
  @java.lang.SuppressWarnings("all")
  public Location getLocation() {
    return this.location;
  }

  /**
   * Location information about the Place. E.g., latitude and longitude, and address.
   */
  @java.lang.SuppressWarnings("all")
  public void setLocation(final Location location) {
    this.location = location;
  }

  /**
   * The overall page rating, based on rating survey from users, on a scale of 1-5.
   *
   * This value is normalized, and is not guaranteed to be a strict average of user ratings.
   *
   * @return The overall page rating, based on rating survey from users, on a scale of 1-5.
   */
  @java.lang.SuppressWarnings("all")
  public Double getOverallStarRating() {
    return this.overallStarRating;
  }

  /**
   * The overall page rating, based on rating survey from users, on a scale of 1-5.
   *
   * This value is normalized, and is not guaranteed to be a strict average of user ratings.
   */
  @java.lang.SuppressWarnings("all")
  public void setOverallStarRating(final Double overallStarRating) {
    this.overallStarRating = overallStarRating;
  }

  /**
   * The Page node corresponding to the Place.
   *
   * @return The Page node corresponding to the Place.
   */
  @java.lang.SuppressWarnings("all")
  public Page getPage() {
    return this.page;
  }

  /**
   * The Page node corresponding to the Place.
   */
  @java.lang.SuppressWarnings("all")
  public void setPage(final Page page) {
    this.page = page;
  }

  /**
   * Parking information about the Place.
   *
   * @return Parking information about the Place.
   */
  @java.lang.SuppressWarnings("all")
  public Page.PageParking getParking() {
    return this.parking;
  }

  /**
   * Parking information about the Place.
   */
  @java.lang.SuppressWarnings("all")
  public void setParking(final Page.PageParking parking) {
    this.parking = parking;
  }

  /**
   * Payment options accepted by the Place. Applicable to restaurants and nightlife.
   *
   * @return Payment options accepted by the Place.
   */
  @java.lang.SuppressWarnings("all")
  public Page.PagePaymentOptions getPaymentOptions() {
    return this.paymentOptions;
  }

  /**
   * Payment options accepted by the Place. Applicable to restaurants and nightlife.
   */
  @java.lang.SuppressWarnings("all")
  public void setPaymentOptions(final Page.PagePaymentOptions paymentOptions) {
    this.paymentOptions = paymentOptions;
  }

  /**
   * The Place's telephone number.
   *
   * @return The Place's telephone number.
   */
  @java.lang.SuppressWarnings("all")
  public String getPhone() {
    return this.phone;
  }

  /**
   * The Place's telephone number.
   */
  @java.lang.SuppressWarnings("all")
  public void setPhone(final String phone) {
    this.phone = phone;
  }

  /**
   * The pages's profile picture, if provided.
   *
   * To force Facebook to fill the <code>picture</code> field you have to fetch the page with the
   * <code>fields=picture</code> parameter, otherwise the picture is <code>null</code>.
   *
   * @return the page's profile picture as ProfilePictureSource object
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public ProfilePictureSource getPicture() {
    return this.picture;
  }

  /**
   * The pages's profile picture, if provided.
   *
   * To force Facebook to fill the <code>picture</code> field you have to fetch the page with the
   * <code>fields=picture</code> parameter, otherwise the picture is <code>null</code>.
   */
  @java.lang.SuppressWarnings("all")
  public void setPicture(final ProfilePictureSource picture) {
    this.picture = picture;
  }

  /**
   * Price range of the business.
   *
   * Applicable to Restaurants or Nightlife. Can be one of $ (0-10), $$ (10-30), $$$ (30-50), $$$$ (50+), or Unspecified
   *
   * @return Price range of the business.
   */
  @java.lang.SuppressWarnings("all")
  public String getPriceRange() {
    return this.priceRange;
  }

  /**
   * Price range of the business.
   *
   * Applicable to Restaurants or Nightlife. Can be one of $ (0-10), $$ (10-30), $$$ (30-50), $$$$ (50+), or Unspecified
   */
  @java.lang.SuppressWarnings("all")
  public void setPriceRange(final String priceRange) {
    this.priceRange = priceRange;
  }

  /**
   * Number of ratings for the Place
   *
   * @return Number of ratings for the Place
   */
  @java.lang.SuppressWarnings("all")
  public Long getRatingCount() {
    return this.ratingCount;
  }

  /**
   * Number of ratings for the Place
   */
  @java.lang.SuppressWarnings("all")
  public void setRatingCount(final Long ratingCount) {
    this.ratingCount = ratingCount;
  }

  /**
   * The services that the restaurant provides.
   *
   * @return The services that the restaurant provides.
   */
  @java.lang.SuppressWarnings("all")
  public Page.PageRestaurantServices getRestaurantServices() {
    return this.restaurantServices;
  }

  /**
   * The services that the restaurant provides.
   */
  @java.lang.SuppressWarnings("all")
  public void setRestaurantServices(final Page.PageRestaurantServices restaurantServices) {
    this.restaurantServices = restaurantServices;
  }

  /**
   * The restaurant's specialties.
   *
   * @return The restaurant's specialties.
   */
  @java.lang.SuppressWarnings("all")
  public Page.PageRestaurantSpecialties getRestaurantSpecialties() {
    return this.restaurantSpecialties;
  }

  /**
   * The restaurant's specialties.
   */
  @java.lang.SuppressWarnings("all")
  public void setRestaurantSpecialties(final Page.PageRestaurantSpecialties restaurantSpecialties) {
    this.restaurantSpecialties = restaurantSpecialties;
  }

  /**
   * The Place's complete postal address, on a single line.
   *
   * @return The Place's complete postal address, on a single line.
   */
  @java.lang.SuppressWarnings("all")
  public String getSingleLineAddress() {
    return this.singleLineAddress;
  }

  /**
   * The Place's complete postal address, on a single line.
   */
  @java.lang.SuppressWarnings("all")
  public void setSingleLineAddress(final String singleLineAddress) {
    this.singleLineAddress = singleLineAddress;
  }

  /**
   * The URL of the Place's website.
   *
   * @return The URL of the Place's website.
   */
  @java.lang.SuppressWarnings("all")
  public String getWebsite() {
    return this.website;
  }

  /**
   * The URL of the Place's website.
   */
  @java.lang.SuppressWarnings("all")
  public void setWebsite(final String website) {
    this.website = website;
  }

  /**
   * Photos for the Place.
   *
   * By default, this edge returns the profile photos for the Place. You can also use an optional type parameter with
   * the value uploaded to get the photos uploaded by the Place.
   */
  @java.lang.SuppressWarnings("all")
  public List<Photo> getPhotos() {
    return this.photos;
  }

  /**
   * Photos for the Place.
   *
   * By default, this edge returns the profile photos for the Place. You can also use an optional type parameter with
   * the value uploaded to get the photos uploaded by the Place.
   */
  @java.lang.SuppressWarnings("all")
  public void setPhotos(final List<Photo> photos) {
    this.photos = photos;
  }

  /**
   * The native component workflows for this Place.
   *
   * Workflows allow people to perform actions like requesting appointments, buying tickets, and ordering from
   * restaurants on Facebook
   */
  @java.lang.SuppressWarnings("all")
  public List<PagesPlatformComponentFlowServiceConfig> getWorkflows() {
    return this.workflows;
  }

  /**
   * The native component workflows for this Place.
   *
   * Workflows allow people to perform actions like requesting appointments, buying tickets, and ordering from
   * restaurants on Facebook
   */
  @java.lang.SuppressWarnings("all")
  public void setWorkflows(final List<PagesPlatformComponentFlowServiceConfig> workflows) {
    this.workflows = workflows;
  }
}