// Generated by delombok at Fri Feb 21 00:22:14 UTC 2025
/*
 * Copyright (c) 2010-2025 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.whatsapp;

import com.restfb.Facebook;
import com.restfb.types.AbstractFacebookType;
import java.util.ArrayList;
import java.util.List;

/**
 * Represents the
 * <a href="https://developers.facebook.com/docs/graph-api/reference/whats-app-business-hsm-whats-app-hsm-component-get/">
 * WhatsApp Business HSMWhats App HSMComponent Get</a>, based on
 * <a href="https://developers.facebook.com/docs/whatsapp/business-management-api/message-templates/components">
 * Template Components</a>
 */
public class WhatsAppMessageTemplateComponent extends AbstractFacebookType {
  private static final long serialVersionUID = 1L;
  /**
   * Component type.
   */
  @Facebook
  private Type type;
  /**
   * Indicates media asset type for the component type
   */
  @Facebook
  private Format format;
  /**
   * Component text. Required for components with type HEADER, BODY or FOOTER.
   */
  @Facebook
  private String text;
  /**
   * Whether a security recommendation is included in the body text.
   */
  @Facebook("add_security_recommendation")
  private Boolean addSecurityRecommendation;
  /**
   * The number of minutes that the authentication code will expire in. (minimum 1, maximum 90)
   */
  @Facebook("code_expiration_minutes")
  private Integer codeExpirationMinutes;
  /**
   * The illustrative sample text for the parameter.
   * Applies only if the component has parameters.
   */
  @Facebook
  private Example example;
  /**
   * Button components to be used in the template.
   */
  @Facebook
  private List<Button> buttons = new ArrayList<>();


  public enum Type {
    HEADER, BODY, FOOTER, BUTTONS;
  }


  public enum Format {
    TEXT, IMAGE, DOCUMENT, VIDEO, LOCATION;
  }


  public enum ButtonType {
    QUICK_REPLY, URL, PHONE_NUMBER, COPY_CODE, FLOW, MPM, SPM;
  }


  public static class Button {
    /**
     * Button type.
     */
    @Facebook
    private ButtonType type;
    /**
     * Button label text.
     */
    @Facebook
    private String text;
    /**
     * URL of website. Supports 1 variable.
     */
    @Facebook
    private String url;
    @Facebook("phone_number")
    private String phoneNumber;
    /**
     * Single element list with the strings to copy to the device's clipboard if the type is 'COPY_CODE',
     * or sample URL if the type is 'URL' and has a parameter.
     */
    @Facebook
    private List<String> example;
    /**
     * Unique identifier of the Flow provided by WhatsApp.
     * The Flow must be published.
     */
    @Facebook("flow_id")
    private String flowId;
    /**
     * The name of the Flow, supported in Cloud API only.
     * Cannot be used with flow_id or flow_json.
     */
    @Facebook("flow_name")
    private String flowName;
    /**
     * JSON string specifying the layout of the Flow.
     * Cannot be used with flow_id or flow_name.
     */
    @Facebook("flow_json")
    private String flowJson;
    /**
     * Action to define the Flow behavior.
     * Can be 'navigate' for predefined screens or 'data_exchange' for dynamic screens.
     */
    @Facebook("flow_action")
    private String flowAction;
    /**
     * ID of the entry screen in the Flow if flow_action is 'navigate'.
     * Optional. Default is 'FIRST_ENTRY_SCREEN'.
     */
    @Facebook("navigate_screen")
    private String navigateScreen;

    /**
     * Button type.
     */
    @java.lang.SuppressWarnings("all")
    public ButtonType getType() {
      return this.type;
    }

    /**
     * Button type.
     */
    @java.lang.SuppressWarnings("all")
    public void setType(final ButtonType type) {
      this.type = type;
    }

    /**
     * Button label text.
     */
    @java.lang.SuppressWarnings("all")
    public String getText() {
      return this.text;
    }

    /**
     * Button label text.
     */
    @java.lang.SuppressWarnings("all")
    public void setText(final String text) {
      this.text = text;
    }

    /**
     * URL of website. Supports 1 variable.
     */
    @java.lang.SuppressWarnings("all")
    public String getUrl() {
      return this.url;
    }

    /**
     * URL of website. Supports 1 variable.
     */
    @java.lang.SuppressWarnings("all")
    public void setUrl(final String url) {
      this.url = url;
    }

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

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

    /**
     * Single element list with the strings to copy to the device's clipboard if the type is 'COPY_CODE',
     * or sample URL if the type is 'URL' and has a parameter.
     */
    @java.lang.SuppressWarnings("all")
    public List<String> getExample() {
      return this.example;
    }

    /**
     * Single element list with the strings to copy to the device's clipboard if the type is 'COPY_CODE',
     * or sample URL if the type is 'URL' and has a parameter.
     */
    @java.lang.SuppressWarnings("all")
    public void setExample(final List<String> example) {
      this.example = example;
    }

    /**
     * Unique identifier of the Flow provided by WhatsApp.
     * The Flow must be published.
     */
    @java.lang.SuppressWarnings("all")
    public String getFlowId() {
      return this.flowId;
    }

    /**
     * Unique identifier of the Flow provided by WhatsApp.
     * The Flow must be published.
     */
    @java.lang.SuppressWarnings("all")
    public void setFlowId(final String flowId) {
      this.flowId = flowId;
    }

    /**
     * The name of the Flow, supported in Cloud API only.
     * Cannot be used with flow_id or flow_json.
     */
    @java.lang.SuppressWarnings("all")
    public String getFlowName() {
      return this.flowName;
    }

    /**
     * The name of the Flow, supported in Cloud API only.
     * Cannot be used with flow_id or flow_json.
     */
    @java.lang.SuppressWarnings("all")
    public void setFlowName(final String flowName) {
      this.flowName = flowName;
    }

    /**
     * JSON string specifying the layout of the Flow.
     * Cannot be used with flow_id or flow_name.
     */
    @java.lang.SuppressWarnings("all")
    public String getFlowJson() {
      return this.flowJson;
    }

    /**
     * JSON string specifying the layout of the Flow.
     * Cannot be used with flow_id or flow_name.
     */
    @java.lang.SuppressWarnings("all")
    public void setFlowJson(final String flowJson) {
      this.flowJson = flowJson;
    }

    /**
     * Action to define the Flow behavior.
     * Can be 'navigate' for predefined screens or 'data_exchange' for dynamic screens.
     */
    @java.lang.SuppressWarnings("all")
    public String getFlowAction() {
      return this.flowAction;
    }

    /**
     * Action to define the Flow behavior.
     * Can be 'navigate' for predefined screens or 'data_exchange' for dynamic screens.
     */
    @java.lang.SuppressWarnings("all")
    public void setFlowAction(final String flowAction) {
      this.flowAction = flowAction;
    }

    /**
     * ID of the entry screen in the Flow if flow_action is 'navigate'.
     * Optional. Default is 'FIRST_ENTRY_SCREEN'.
     */
    @java.lang.SuppressWarnings("all")
    public String getNavigateScreen() {
      return this.navigateScreen;
    }

    /**
     * ID of the entry screen in the Flow if flow_action is 'navigate'.
     * Optional. Default is 'FIRST_ENTRY_SCREEN'.
     */
    @java.lang.SuppressWarnings("all")
    public void setNavigateScreen(final String navigateScreen) {
      this.navigateScreen = navigateScreen;
    }
  }


  public static class Example {
    @Facebook("header_text")
    private List<String> headerText = new ArrayList<>();
    @Facebook("header_handle")
    private List<String> headerHandle = new ArrayList<>();
    @Facebook("body_text_named_params")
    private List<NamedParam> bodyTextNamedParams = new ArrayList<>();
    @Facebook("header_text_named_params")
    private List<NamedParam> headerTextNamedParams = new ArrayList<>();

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

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

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

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

    @java.lang.SuppressWarnings("all")
    public List<NamedParam> getBodyTextNamedParams() {
      return this.bodyTextNamedParams;
    }

    @java.lang.SuppressWarnings("all")
    public void setBodyTextNamedParams(final List<NamedParam> bodyTextNamedParams) {
      this.bodyTextNamedParams = bodyTextNamedParams;
    }

    @java.lang.SuppressWarnings("all")
    public List<NamedParam> getHeaderTextNamedParams() {
      return this.headerTextNamedParams;
    }

    @java.lang.SuppressWarnings("all")
    public void setHeaderTextNamedParams(final List<NamedParam> headerTextNamedParams) {
      this.headerTextNamedParams = headerTextNamedParams;
    }
  }


  public static class NamedParam {
    @Facebook("param_name")
    private String paramName;
    @Facebook
    private String example;

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

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

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

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

  /**
   * Component type.
   */
  @java.lang.SuppressWarnings("all")
  public Type getType() {
    return this.type;
  }

  /**
   * Component type.
   */
  @java.lang.SuppressWarnings("all")
  public void setType(final Type type) {
    this.type = type;
  }

  /**
   * Indicates media asset type for the component type
   */
  @java.lang.SuppressWarnings("all")
  public Format getFormat() {
    return this.format;
  }

  /**
   * Indicates media asset type for the component type
   */
  @java.lang.SuppressWarnings("all")
  public void setFormat(final Format format) {
    this.format = format;
  }

  /**
   * Component text. Required for components with type HEADER, BODY or FOOTER.
   */
  @java.lang.SuppressWarnings("all")
  public String getText() {
    return this.text;
  }

  /**
   * Component text. Required for components with type HEADER, BODY or FOOTER.
   */
  @java.lang.SuppressWarnings("all")
  public void setText(final String text) {
    this.text = text;
  }

  /**
   * Whether a security recommendation is included in the body text.
   */
  @java.lang.SuppressWarnings("all")
  public Boolean getAddSecurityRecommendation() {
    return this.addSecurityRecommendation;
  }

  /**
   * Whether a security recommendation is included in the body text.
   */
  @java.lang.SuppressWarnings("all")
  public void setAddSecurityRecommendation(final Boolean addSecurityRecommendation) {
    this.addSecurityRecommendation = addSecurityRecommendation;
  }

  /**
   * The number of minutes that the authentication code will expire in. (minimum 1, maximum 90)
   */
  @java.lang.SuppressWarnings("all")
  public Integer getCodeExpirationMinutes() {
    return this.codeExpirationMinutes;
  }

  /**
   * The number of minutes that the authentication code will expire in. (minimum 1, maximum 90)
   */
  @java.lang.SuppressWarnings("all")
  public void setCodeExpirationMinutes(final Integer codeExpirationMinutes) {
    this.codeExpirationMinutes = codeExpirationMinutes;
  }

  /**
   * The illustrative sample text for the parameter.
   * Applies only if the component has parameters.
   */
  @java.lang.SuppressWarnings("all")
  public Example getExample() {
    return this.example;
  }

  /**
   * The illustrative sample text for the parameter.
   * Applies only if the component has parameters.
   */
  @java.lang.SuppressWarnings("all")
  public void setExample(final Example example) {
    this.example = example;
  }

  /**
   * Button components to be used in the template.
   */
  @java.lang.SuppressWarnings("all")
  public List<Button> getButtons() {
    return this.buttons;
  }

  /**
   * Button components to be used in the template.
   */
  @java.lang.SuppressWarnings("all")
  public void setButtons(final List<Button> buttons) {
    this.buttons = buttons;
  }
}