// 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.List;
import com.restfb.Facebook;

/**
 * Represents the <a href="https://developers.facebook.com/docs/marketing-api/reference/custom-audience">Custom
 * Audience</a> Marketing API type
 */
public class CustomAudience extends NamedAdsObject {
  /**
   * Ad Account ID
   */
  @Facebook("account_id")
  private String accountId;
  /**
   * Approximate number of people in this audience
   */
  @Facebook("approximate_count")
  private Long approximateCount;
  /**
   * JSON dictionary of type, sub_type to indicate by which method the custom audience was created.
   */
  @Facebook("data_source")
  private CustomAudienceDataSource dataSource;
  /**
   * JSON dictionary of code and description.
   *
   * Indicates whether or not an audience can be used in ads. There are two situations that an audience will make ads
   * not deliverable. First, if the size is smaller than 20 people, the audience can't be delivered. Second, if for some
   * reason the audience is disabled (such as violation of policy, expired), validation will fail when it is used in
   * ads.
   */
  @Facebook("delivery_status")
  private CustomAudienceStatus deliveryStatus;
  /**
   * Custom audience description
   */
  @Facebook
  private String description;
  @Facebook("excluded_custom_audiences")
  private List<CustomAudience> excludedCustomAudiences = new ArrayList<>();
  /**
   * Read-only JSON dictionary with key id containing the pixel id whose traffic generated this custom audience
   */
  @Facebook("external_event_source")
  private AdsPixel externalEventSource;
  @Facebook("included_custom_audiences")
  private List<CustomAudience> includedCustomAudiences = new ArrayList<>();
  /**
   * last used time of this object by the current viewer
   */
  @Facebook("last_used_time")
  private String lastUsedTime;
  /**
   * The IDs of the lookalike audiences generated from this audience
   */
  @Facebook("lookalike_audience_ids")
  private List<String> lookalikeAudienceIds = new ArrayList<>();
  /**
   * Generated only when the subtype is LOOKALIKE.
   */
  @Facebook("lookalike_spec")
  private LookalikeSpec lookalikeSpec;
  /**
   * JSON dictionary of code to int value and description to a description string.
   *
   * The operation status represents the status of the last operation performed on an audience. In general, it will have
   * following states:
   * <ul>
   * <li>0: Status not available</li>
   * <li>200: Normal: there is no updating or issues found</li>
   * <li>400: Warning: there is some message we would like advertisers to know</li>
   * <li>410: No upload: no file has been uploaded</li>
   * <li>411: Low match rate: low rate of matched people</li>
   * <li>412: High invalid rate: high rate of invalid people</li>
   * <li>421: No pixel: Your Facebook pixel hasn't been installed on your website yet</li>
   * <li>422: Pixel not firing: Your Facebook pixel isn't firing</li>
   * <li>423: Invalid pixel: Your Facebook pixel is invalid</li>
   * <li>431: Lookalike Audience refresh failed</li>
   * <li>432: Lookalike Audience build failed</li>
   * <li>433: Lookalike Audience build failed</li>
   * <li>434: Lookalike Audience build retrying</li>
   * <li>500: Error: there is some error and advertisers need to take action items to fix the error</li>
   * </ul>
   */
  @Facebook("operation_status")
  private CustomAudienceStatus operationStatus;
  /**
   * Your opt-out URL so people can choose not to be targeted
   */
  @Facebook("opt_out_link")
  private String optOutLink;
  /**
   * The ID of origin Custom Audience. The origin audience you create must have a minimum size of 100.
   */
  @Facebook("origin_audience_id")
  private Long originAudienceId;
  /**
   * owner business of this object
   */
  @Facebook("owner_business")
  private Business ownerBusiness;
  /**
   * JSON dictionary of permissions (string) to boolean value if the custom audience has that permission
   */
  @Facebook("permission_for_actions")
  private CustomAudiencePermission permissionForActions;
  /**
   * ID of the pixel which is collecting events for this Website Custom audience
   */
  @Facebook("pixel_id")
  private String pixelId;
  /**
   * Number of days to keep the user in this cluster. You can use any value between 1 and 180 days. Defaults to 14 days
   * if not specified
   */
  @Facebook("retention_days")
  private Long retentionDays;
  /**
   * Audience rules to be applied on the referrer URL
   */
  @Facebook
  private String rule;
  /**
   * Type of custom audience, derived from original data source
   */
  @Facebook
  private String subtype;
  /**
   * Last update of people in this custom audience
   */
  @Facebook("time_content_updated")
  private Long timeContentUpdated;
  /**
   * Creation time
   */
  @Facebook("time_created")
  private Long timeCreated;
  /**
   * Last time this audience metadata was updated
   */
  @Facebook("time_updated")
  private Long timeUpdated;

  /**
   * @return Ad Account ID
   */
  @java.lang.SuppressWarnings("all")
  public String getAccountId() {
    return this.accountId;
  }

  /**
   * Ad Account ID
   */
  @java.lang.SuppressWarnings("all")
  public void setAccountId(final String accountId) {
    this.accountId = accountId;
  }

  /**
   * @return Approximate number of people in this audience
   */
  @java.lang.SuppressWarnings("all")
  public Long getApproximateCount() {
    return this.approximateCount;
  }

  /**
   * Approximate number of people in this audience
   */
  @java.lang.SuppressWarnings("all")
  public void setApproximateCount(final Long approximateCount) {
    this.approximateCount = approximateCount;
  }

  /**
   * @return JSON dictionary of type, sub_type to indicate by which method the custom audience was created.
   */
  @java.lang.SuppressWarnings("all")
  public CustomAudienceDataSource getDataSource() {
    return this.dataSource;
  }

  /**
   * JSON dictionary of type, sub_type to indicate by which method the custom audience was created.
   */
  @java.lang.SuppressWarnings("all")
  public void setDataSource(final CustomAudienceDataSource dataSource) {
    this.dataSource = dataSource;
  }

  /**
   * @return dictionary of code and description
   */
  @java.lang.SuppressWarnings("all")
  public CustomAudienceStatus getDeliveryStatus() {
    return this.deliveryStatus;
  }

  /**
   * JSON dictionary of code and description.
   *
   * Indicates whether or not an audience can be used in ads. There are two situations that an audience will make ads
   * not deliverable. First, if the size is smaller than 20 people, the audience can't be delivered. Second, if for some
   * reason the audience is disabled (such as violation of policy, expired), validation will fail when it is used in
   * ads.
   */
  @java.lang.SuppressWarnings("all")
  public void setDeliveryStatus(final CustomAudienceStatus deliveryStatus) {
    this.deliveryStatus = deliveryStatus;
  }

  /**
   * @return Custom audience description
   */
  @java.lang.SuppressWarnings("all")
  public String getDescription() {
    return this.description;
  }

  /**
   * Custom audience description
   */
  @java.lang.SuppressWarnings("all")
  public void setDescription(final String description) {
    this.description = description;
  }

  @java.lang.SuppressWarnings("all")
  public List<CustomAudience> getExcludedCustomAudiences() {
    return this.excludedCustomAudiences;
  }

  @java.lang.SuppressWarnings("all")
  public void setExcludedCustomAudiences(final List<CustomAudience> excludedCustomAudiences) {
    this.excludedCustomAudiences = excludedCustomAudiences;
  }

  /**
   * @return Read-only JSON dictionary with key id containing the pixel id whose traffic generated this custom audience
   */
  @java.lang.SuppressWarnings("all")
  public AdsPixel getExternalEventSource() {
    return this.externalEventSource;
  }

  /**
   * Read-only JSON dictionary with key id containing the pixel id whose traffic generated this custom audience
   */
  @java.lang.SuppressWarnings("all")
  public void setExternalEventSource(final AdsPixel externalEventSource) {
    this.externalEventSource = externalEventSource;
  }

  @java.lang.SuppressWarnings("all")
  public List<CustomAudience> getIncludedCustomAudiences() {
    return this.includedCustomAudiences;
  }

  @java.lang.SuppressWarnings("all")
  public void setIncludedCustomAudiences(final List<CustomAudience> includedCustomAudiences) {
    this.includedCustomAudiences = includedCustomAudiences;
  }

  /**
   * @return last used time of this object by the current viewer
   */
  @java.lang.SuppressWarnings("all")
  public String getLastUsedTime() {
    return this.lastUsedTime;
  }

  /**
   * last used time of this object by the current viewer
   */
  @java.lang.SuppressWarnings("all")
  public void setLastUsedTime(final String lastUsedTime) {
    this.lastUsedTime = lastUsedTime;
  }

  /**
   * @return The IDs of the lookalike audiences generated from this audience
   */
  @java.lang.SuppressWarnings("all")
  public List<String> getLookalikeAudienceIds() {
    return this.lookalikeAudienceIds;
  }

  /**
   * The IDs of the lookalike audiences generated from this audience
   */
  @java.lang.SuppressWarnings("all")
  public void setLookalikeAudienceIds(final List<String> lookalikeAudienceIds) {
    this.lookalikeAudienceIds = lookalikeAudienceIds;
  }

  /**
   * @return Generated only when the subtype is LOOKALIKE.
   */
  @java.lang.SuppressWarnings("all")
  public LookalikeSpec getLookalikeSpec() {
    return this.lookalikeSpec;
  }

  /**
   * Generated only when the subtype is LOOKALIKE.
   */
  @java.lang.SuppressWarnings("all")
  public void setLookalikeSpec(final LookalikeSpec lookalikeSpec) {
    this.lookalikeSpec = lookalikeSpec;
  }

  /**
   * @return dictionary of code to int value and description to a description string
   */
  @java.lang.SuppressWarnings("all")
  public CustomAudienceStatus getOperationStatus() {
    return this.operationStatus;
  }

  /**
   * JSON dictionary of code to int value and description to a description string.
   *
   * The operation status represents the status of the last operation performed on an audience. In general, it will have
   * following states:
   * <ul>
   * <li>0: Status not available</li>
   * <li>200: Normal: there is no updating or issues found</li>
   * <li>400: Warning: there is some message we would like advertisers to know</li>
   * <li>410: No upload: no file has been uploaded</li>
   * <li>411: Low match rate: low rate of matched people</li>
   * <li>412: High invalid rate: high rate of invalid people</li>
   * <li>421: No pixel: Your Facebook pixel hasn't been installed on your website yet</li>
   * <li>422: Pixel not firing: Your Facebook pixel isn't firing</li>
   * <li>423: Invalid pixel: Your Facebook pixel is invalid</li>
   * <li>431: Lookalike Audience refresh failed</li>
   * <li>432: Lookalike Audience build failed</li>
   * <li>433: Lookalike Audience build failed</li>
   * <li>434: Lookalike Audience build retrying</li>
   * <li>500: Error: there is some error and advertisers need to take action items to fix the error</li>
   * </ul>
   */
  @java.lang.SuppressWarnings("all")
  public void setOperationStatus(final CustomAudienceStatus operationStatus) {
    this.operationStatus = operationStatus;
  }

  /**
   * @return Your opt-out URL so people can choose not to be targeted
   */
  @java.lang.SuppressWarnings("all")
  public String getOptOutLink() {
    return this.optOutLink;
  }

  /**
   * Your opt-out URL so people can choose not to be targeted
   */
  @java.lang.SuppressWarnings("all")
  public void setOptOutLink(final String optOutLink) {
    this.optOutLink = optOutLink;
  }

  /**
   * @return The ID of origin Custom Audience. The origin audience you create must have a minimum size of 100.
   */
  @java.lang.SuppressWarnings("all")
  public Long getOriginAudienceId() {
    return this.originAudienceId;
  }

  /**
   * The ID of origin Custom Audience. The origin audience you create must have a minimum size of 100.
   */
  @java.lang.SuppressWarnings("all")
  public void setOriginAudienceId(final Long originAudienceId) {
    this.originAudienceId = originAudienceId;
  }

  /**
   * @return owner business of this object
   */
  @java.lang.SuppressWarnings("all")
  public Business getOwnerBusiness() {
    return this.ownerBusiness;
  }

  /**
   * owner business of this object
   */
  @java.lang.SuppressWarnings("all")
  public void setOwnerBusiness(final Business ownerBusiness) {
    this.ownerBusiness = ownerBusiness;
  }

  /**
   * @return JSON dictionary of permissions (string) to boolean value if the custom audience has that permission
   */
  @java.lang.SuppressWarnings("all")
  public CustomAudiencePermission getPermissionForActions() {
    return this.permissionForActions;
  }

  /**
   * JSON dictionary of permissions (string) to boolean value if the custom audience has that permission
   */
  @java.lang.SuppressWarnings("all")
  public void setPermissionForActions(final CustomAudiencePermission permissionForActions) {
    this.permissionForActions = permissionForActions;
  }

  /**
   * @return ID of the pixel which is collecting events for this Website Custom audience
   */
  @java.lang.SuppressWarnings("all")
  public String getPixelId() {
    return this.pixelId;
  }

  /**
   * ID of the pixel which is collecting events for this Website Custom audience
   */
  @java.lang.SuppressWarnings("all")
  public void setPixelId(final String pixelId) {
    this.pixelId = pixelId;
  }

  /**
   * @return Number of days to keep the user in this cluster.
   */
  @java.lang.SuppressWarnings("all")
  public Long getRetentionDays() {
    return this.retentionDays;
  }

  /**
   * Number of days to keep the user in this cluster. You can use any value between 1 and 180 days. Defaults to 14 days
   * if not specified
   */
  @java.lang.SuppressWarnings("all")
  public void setRetentionDays(final Long retentionDays) {
    this.retentionDays = retentionDays;
  }

  /**
   * @return Audience rules to be applied on the referrer URL
   */
  @java.lang.SuppressWarnings("all")
  public String getRule() {
    return this.rule;
  }

  /**
   * Audience rules to be applied on the referrer URL
   */
  @java.lang.SuppressWarnings("all")
  public void setRule(final String rule) {
    this.rule = rule;
  }

  /**
   * @return Type of custom audience, derived from original data source
   */
  @java.lang.SuppressWarnings("all")
  public String getSubtype() {
    return this.subtype;
  }

  /**
   * Type of custom audience, derived from original data source
   */
  @java.lang.SuppressWarnings("all")
  public void setSubtype(final String subtype) {
    this.subtype = subtype;
  }

  /**
   * @return Last update of people in this custom audience
   */
  @java.lang.SuppressWarnings("all")
  public Long getTimeContentUpdated() {
    return this.timeContentUpdated;
  }

  /**
   * Last update of people in this custom audience
   */
  @java.lang.SuppressWarnings("all")
  public void setTimeContentUpdated(final Long timeContentUpdated) {
    this.timeContentUpdated = timeContentUpdated;
  }

  /**
   * @return Creation time
   */
  @java.lang.SuppressWarnings("all")
  public Long getTimeCreated() {
    return this.timeCreated;
  }

  /**
   * Creation time
   */
  @java.lang.SuppressWarnings("all")
  public void setTimeCreated(final Long timeCreated) {
    this.timeCreated = timeCreated;
  }

  /**
   * @return Last time this audience metadata was updated
   */
  @java.lang.SuppressWarnings("all")
  public Long getTimeUpdated() {
    return this.timeUpdated;
  }

  /**
   * Last time this audience metadata was updated
   */
  @java.lang.SuppressWarnings("all")
  public void setTimeUpdated(final Long timeUpdated) {
    this.timeUpdated = timeUpdated;
  }
}