// 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.ads;

import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import com.restfb.Facebook;
import com.restfb.annotation.GraphAPI;
import com.restfb.types.features.HasCreatedTime;

/**
 * Represents the <a href="https://developers.facebook.com/docs/marketing-api/reference/ad-campaign-group">Campaign</a>
 * Marketing API type
 */
public class Campaign extends NamedAdsObject implements HasCreatedTime {
  /**
   * ID of the ad account that owns this campaign
   */
  @Facebook("account_id")
  private String accountId;
  /**
   * Ad Labels associated with this campaign
   */
  @Facebook("adlabels")
  private List<AdLabel> adlabels;
  /**
   * Bid strategy for this campaign
   */
  @Facebook("bid_strategy")
  private String bidStrategy;
  /**
   * The Boosted Object this campaign has associated, if any
   */
  @Facebook("boosted_object_id")
  private String boostedObjectId;
  /**
   * Automated Brand Lift V2 studies for this ad set.
   */
  @Facebook("brand_lift_studies")
  private List<AdStudy> brandLiftStudies = new ArrayList<>();
  /**
   * Whether to automatically rebalance budgets daily for all the adsets under this campaign.
   */
  @Facebook("budget_rebalance_flag")
  private Boolean budgetRebalanceFlag;
  /**
   * Remaining budget
   */
  @Facebook("budget_remaining")
  private String budgetRemaining;
  /**
   * Buying type, possible values are:
   * <ul>
   * <li>AUCTION: default</li>
   * <li>RESERVED: for reach and frequency ads</li>
   * </ul>
   */
  @Facebook("buying_type")
  private String buyingType;
  /**
   * If we can create a new automated brand lift study for the ad set.
   */
  @Facebook("can_create_brand_lift_study")
  private Boolean canCreateBrandLiftStudy;
  /**
   * Whether the campaign can set the spend cap
   */
  @Facebook("can_use_spend_cap")
  private Boolean canUseSpendCap;
  /**
   * If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status
   * CAMPAIGN_PAUSED. Prefer using 'status' instead of this.
   *
   * possible values: ACTIVE, PAUSED, DELETED, ARCHIVED
   */
  @Facebook("configured_status")
  private String configuredStatus;
  /**
   * Created Time
   */
  @Facebook("created_time")
  private Date createdTime;
  /**
   * The daily budget of the campaign
   */
  @Facebook("daily_budget")
  private String dailyBudget;
  /**
   * The effective status of this campaign.
   *
   * possible values: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO,
   * CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED
   */
  @Facebook("effective_status")
  private String effectiveStatus;
  /**
   * Issues for this campaign that prevented it from deliverying.
   */
  @Facebook("issues_info")
  @GraphAPI(since = "3.2")
  private List<AdCampaignIssuesInfo> issuesInfo = new ArrayList<>();
  /**
   * Last budget toggling time
   */
  @Facebook("last_budget_toggling_time")
  private Date lastBudgetTogglingTime;
  /**
   * The lifetime budget of the campaign
   */
  @Facebook("lifetime_budget")
  private String lifetimeBudget;
  /**
   * Campaign's objective
   */
  @Facebook
  private String objective;
  /**
   * If there are recommendations for this campaign, this field includes them.
   */
  @Facebook
  private List<AdRecommendation> recommendations = new ArrayList<>();
  /**
   * The source campaign that this campaign is copied from
   */
  @Facebook("source_campaign")
  private Campaign sourceCampaign;
  /**
   * The source campaign id that this campaign is copied from
   */
  @Facebook("source_campaign_id")
  private String sourceCampaignId;
  /**
   * The campaign's Special Ad Category. One of {@code HOUSING}, {@code EMPLOYMENT}, {@code CREDIT}, or {@code NONE}.
   */
  @Deprecated
  @GraphAPI(until = "7.0")
  @Facebook("special_ad_category")
  private String specialAdCategory;
  @GraphAPI(since = "7.0")
  @Facebook("special_ad_categories")
  private List<String> specialAdCategories = new ArrayList<>();
  /**
   * A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the
   * subunit in your currency.
   */
  @Facebook("spend_cap")
  private String spendCap;
  /**
   * Start Time
   */
  @Facebook("start_time")
  private Date startTime;
  /**
   * If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status
   * CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.
   */
  @Facebook
  private String status;
  /**
   * Stop Time
   */
  @Facebook("stop_time")
  private Date stopTime;
  /**
   * Topline ID
   */
  @Facebook("topline_id")
  private String toplineId;
  /**
   * Updated Time
   */
  @Facebook("updated_time")
  private Date updatedTime;

  /**
   * @return ID of the ad account that owns this campaign
   */
  @java.lang.SuppressWarnings("all")
  public String getAccountId() {
    return this.accountId;
  }

  /**
   * ID of the ad account that owns this campaign
   */
  @java.lang.SuppressWarnings("all")
  public void setAccountId(final String accountId) {
    this.accountId = accountId;
  }

  /**
   * @return Ad Labels associated with this campaign
   */
  @java.lang.SuppressWarnings("all")
  public List<AdLabel> getAdlabels() {
    return this.adlabels;
  }

  /**
   * Ad Labels associated with this campaign
   */
  @java.lang.SuppressWarnings("all")
  public void setAdlabels(final List<AdLabel> adlabels) {
    this.adlabels = adlabels;
  }

  /**
   * Bid strategy for this campaign
   */
  @java.lang.SuppressWarnings("all")
  public String getBidStrategy() {
    return this.bidStrategy;
  }

  /**
   * Bid strategy for this campaign
   */
  @java.lang.SuppressWarnings("all")
  public void setBidStrategy(final String bidStrategy) {
    this.bidStrategy = bidStrategy;
  }

  /**
   * The Boosted Object this campaign has associated, if any
   */
  @java.lang.SuppressWarnings("all")
  public String getBoostedObjectId() {
    return this.boostedObjectId;
  }

  /**
   * The Boosted Object this campaign has associated, if any
   */
  @java.lang.SuppressWarnings("all")
  public void setBoostedObjectId(final String boostedObjectId) {
    this.boostedObjectId = boostedObjectId;
  }

  /**
   * Automated Brand Lift V2 studies for this ad set.
   */
  @java.lang.SuppressWarnings("all")
  public List<AdStudy> getBrandLiftStudies() {
    return this.brandLiftStudies;
  }

  /**
   * Automated Brand Lift V2 studies for this ad set.
   */
  @java.lang.SuppressWarnings("all")
  public void setBrandLiftStudies(final List<AdStudy> brandLiftStudies) {
    this.brandLiftStudies = brandLiftStudies;
  }

  /**
   * Whether to automatically rebalance budgets daily for all the adsets under this campaign.
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getBudgetRebalanceFlag() {
    return this.budgetRebalanceFlag;
  }

  /**
   * Whether to automatically rebalance budgets daily for all the adsets under this campaign.
   */
  @java.lang.SuppressWarnings("all")
  public void setBudgetRebalanceFlag(final Boolean budgetRebalanceFlag) {
    this.budgetRebalanceFlag = budgetRebalanceFlag;
  }

  /**
   * Remaining budget
   */
  @java.lang.SuppressWarnings("all")
  public String getBudgetRemaining() {
    return this.budgetRemaining;
  }

  /**
   * Remaining budget
   */
  @java.lang.SuppressWarnings("all")
  public void setBudgetRemaining(final String budgetRemaining) {
    this.budgetRemaining = budgetRemaining;
  }

  /**
   * @return Buying type
   */
  @java.lang.SuppressWarnings("all")
  public String getBuyingType() {
    return this.buyingType;
  }

  /**
   * Buying type, possible values are:
   * <ul>
   * <li>AUCTION: default</li>
   * <li>RESERVED: for reach and frequency ads</li>
   * </ul>
   */
  @java.lang.SuppressWarnings("all")
  public void setBuyingType(final String buyingType) {
    this.buyingType = buyingType;
  }

  /**
   * If we can create a new automated brand lift study for the ad set.
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getCanCreateBrandLiftStudy() {
    return this.canCreateBrandLiftStudy;
  }

  /**
   * If we can create a new automated brand lift study for the ad set.
   */
  @java.lang.SuppressWarnings("all")
  public void setCanCreateBrandLiftStudy(final Boolean canCreateBrandLiftStudy) {
    this.canCreateBrandLiftStudy = canCreateBrandLiftStudy;
  }

  /**
   * @return Whether the campaign can set the spend cap
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getCanUseSpendCap() {
    return this.canUseSpendCap;
  }

  /**
   * Whether the campaign can set the spend cap
   */
  @java.lang.SuppressWarnings("all")
  public void setCanUseSpendCap(final Boolean canUseSpendCap) {
    this.canUseSpendCap = canUseSpendCap;
  }

  /**
   * @return the configured status
   */
  @java.lang.SuppressWarnings("all")
  public String getConfiguredStatus() {
    return this.configuredStatus;
  }

  /**
   * If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status
   * CAMPAIGN_PAUSED. Prefer using 'status' instead of this.
   *
   * possible values: ACTIVE, PAUSED, DELETED, ARCHIVED
   */
  @java.lang.SuppressWarnings("all")
  public void setConfiguredStatus(final String configuredStatus) {
    this.configuredStatus = configuredStatus;
  }

  /**
   * @return Created Time
   */
  @Override
  @java.lang.SuppressWarnings("all")
  public Date getCreatedTime() {
    return this.createdTime;
  }

  /**
   * Created Time
   */
  @java.lang.SuppressWarnings("all")
  public void setCreatedTime(final Date createdTime) {
    this.createdTime = createdTime;
  }

  /**
   * The daily budget of the campaign
   */
  @java.lang.SuppressWarnings("all")
  public String getDailyBudget() {
    return this.dailyBudget;
  }

  /**
   * The daily budget of the campaign
   */
  @java.lang.SuppressWarnings("all")
  public void setDailyBudget(final String dailyBudget) {
    this.dailyBudget = dailyBudget;
  }

  /**
   * @return The effective status of this campaign
   */
  @java.lang.SuppressWarnings("all")
  public String getEffectiveStatus() {
    return this.effectiveStatus;
  }

  /**
   * The effective status of this campaign.
   *
   * possible values: ACTIVE, PAUSED, DELETED, PENDING_REVIEW, DISAPPROVED, PREAPPROVED, PENDING_BILLING_INFO,
   * CAMPAIGN_PAUSED, ARCHIVED, ADSET_PAUSED
   */
  @java.lang.SuppressWarnings("all")
  public void setEffectiveStatus(final String effectiveStatus) {
    this.effectiveStatus = effectiveStatus;
  }

  /**
   * @return List of issues for this campaign that prevented it from deliverying.
   */
  @GraphAPI(since = "3.2")
  @java.lang.SuppressWarnings("all")
  public List<AdCampaignIssuesInfo> getIssuesInfo() {
    return this.issuesInfo;
  }

  /**
   * Issues for this campaign that prevented it from deliverying.
   */
  @java.lang.SuppressWarnings("all")
  public void setIssuesInfo(final List<AdCampaignIssuesInfo> issuesInfo) {
    this.issuesInfo = issuesInfo;
  }

  /**
   * Last budget toggling time
   */
  @java.lang.SuppressWarnings("all")
  public Date getLastBudgetTogglingTime() {
    return this.lastBudgetTogglingTime;
  }

  /**
   * Last budget toggling time
   */
  @java.lang.SuppressWarnings("all")
  public void setLastBudgetTogglingTime(final Date lastBudgetTogglingTime) {
    this.lastBudgetTogglingTime = lastBudgetTogglingTime;
  }

  /**
   * The lifetime budget of the campaign
   */
  @java.lang.SuppressWarnings("all")
  public String getLifetimeBudget() {
    return this.lifetimeBudget;
  }

  /**
   * The lifetime budget of the campaign
   */
  @java.lang.SuppressWarnings("all")
  public void setLifetimeBudget(final String lifetimeBudget) {
    this.lifetimeBudget = lifetimeBudget;
  }

  /**
   * @return Campaign's objective
   */
  @java.lang.SuppressWarnings("all")
  public String getObjective() {
    return this.objective;
  }

  /**
   * Campaign's objective
   */
  @java.lang.SuppressWarnings("all")
  public void setObjective(final String objective) {
    this.objective = objective;
  }

  /**
   * @return If there are recommendations for this campaign, this field includes them.
   */
  @java.lang.SuppressWarnings("all")
  public List<AdRecommendation> getRecommendations() {
    return this.recommendations;
  }

  /**
   * If there are recommendations for this campaign, this field includes them.
   */
  @java.lang.SuppressWarnings("all")
  public void setRecommendations(final List<AdRecommendation> recommendations) {
    this.recommendations = recommendations;
  }

  /**
   * The source campaign that this campaign is copied from
   */
  @java.lang.SuppressWarnings("all")
  public Campaign getSourceCampaign() {
    return this.sourceCampaign;
  }

  /**
   * The source campaign that this campaign is copied from
   */
  @java.lang.SuppressWarnings("all")
  public void setSourceCampaign(final Campaign sourceCampaign) {
    this.sourceCampaign = sourceCampaign;
  }

  /**
   * The source campaign id that this campaign is copied from
   */
  @java.lang.SuppressWarnings("all")
  public String getSourceCampaignId() {
    return this.sourceCampaignId;
  }

  /**
   * The source campaign id that this campaign is copied from
   */
  @java.lang.SuppressWarnings("all")
  public void setSourceCampaignId(final String sourceCampaignId) {
    this.sourceCampaignId = sourceCampaignId;
  }

  /**
   * The campaign's Special Ad Category. One of {@code HOUSING}, {@code EMPLOYMENT}, {@code CREDIT}, or {@code NONE}.
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public String getSpecialAdCategory() {
    return this.specialAdCategory;
  }

  /**
   * The campaign's Special Ad Category. One of {@code HOUSING}, {@code EMPLOYMENT}, {@code CREDIT}, or {@code NONE}.
   */
  @java.lang.Deprecated
  @java.lang.SuppressWarnings("all")
  public void setSpecialAdCategory(final String specialAdCategory) {
    this.specialAdCategory = specialAdCategory;
  }

  @java.lang.SuppressWarnings("all")
  public List<String> getSpecialAdCategories() {
    return this.specialAdCategories;
  }

  @java.lang.SuppressWarnings("all")
  public void setSpecialAdCategories(final List<String> specialAdCategories) {
    this.specialAdCategories = specialAdCategories;
  }

  /**
   * @return A spend cap for the campaign, such that it will not spend more than this cap.
   */
  @java.lang.SuppressWarnings("all")
  public String getSpendCap() {
    return this.spendCap;
  }

  /**
   * A spend cap for the campaign, such that it will not spend more than this cap. Expressed as integer value of the
   * subunit in your currency.
   */
  @java.lang.SuppressWarnings("all")
  public void setSpendCap(final String spendCap) {
    this.spendCap = spendCap;
  }

  /**
   * @return Start Time
   */
  @java.lang.SuppressWarnings("all")
  public Date getStartTime() {
    return this.startTime;
  }

  /**
   * Start Time
   */
  @java.lang.SuppressWarnings("all")
  public void setStartTime(final Date startTime) {
    this.startTime = startTime;
  }

  /**
   * @return the status
   */
  @java.lang.SuppressWarnings("all")
  public String getStatus() {
    return this.status;
  }

  /**
   * If this status is PAUSED, all its active ad sets and ads will be paused and have an effective status
   * CAMPAIGN_PAUSED. The field returns the same value as 'configured_status', and is the suggested one to use.
   */
  @java.lang.SuppressWarnings("all")
  public void setStatus(final String status) {
    this.status = status;
  }

  /**
   * @return Stop Time
   */
  @java.lang.SuppressWarnings("all")
  public Date getStopTime() {
    return this.stopTime;
  }

  /**
   * Stop Time
   */
  @java.lang.SuppressWarnings("all")
  public void setStopTime(final Date stopTime) {
    this.stopTime = stopTime;
  }

  /**
   * Topline ID
   */
  @java.lang.SuppressWarnings("all")
  public String getToplineId() {
    return this.toplineId;
  }

  /**
   * Topline ID
   */
  @java.lang.SuppressWarnings("all")
  public void setToplineId(final String toplineId) {
    this.toplineId = toplineId;
  }

  /**
   * @return Updated Time
   */
  @java.lang.SuppressWarnings("all")
  public Date getUpdatedTime() {
    return this.updatedTime;
  }

  /**
   * Updated Time
   */
  @java.lang.SuppressWarnings("all")
  public void setUpdatedTime(final Date updatedTime) {
    this.updatedTime = updatedTime;
  }
}