com.vonage.client.messages.whatsapp.WhatsappTemplateRequest Maven / Gradle / Ivy

Go to download
/*
 *   Copyright 2024 Vonage
 *
 *   Licensed under the Apache License, Version 2.0 (the "License");
 *   you may not use this file except in compliance with the License.
 *   You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 *   Unless required by applicable law or agreed to in writing, software
 *   distributed under the License is distributed on an "AS IS" BASIS,
 *   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *   See the License for the specific language governing permissions and
 *   limitations under the License.
 */
package com.vonage.client.messages.whatsapp;

import com.fasterxml.jackson.annotation.JsonProperty;
import com.vonage.client.messages.MessageType;
import java.util.List;

public final class WhatsappTemplateRequest extends WhatsappRequest {
	final Template template;
	final Whatsapp whatsapp;

	WhatsappTemplateRequest(Builder builder) {
		super(builder, MessageType.TEMPLATE);
		template = new Template(builder.name, builder.parameters);
		whatsapp = new Whatsapp(builder.policy, builder.locale);
	}

	@JsonProperty("template")
	public Template getTemplate() {
		return template;
	}

	@JsonProperty("whatsapp")
	public Whatsapp getWhatsapp() {
		return whatsapp;
	}

	public static Builder builder() {
		return new Builder();
	}

	public static final class Builder extends WhatsappRequest.Builder {
		String name;
		List parameters;
		Locale locale = Locale.ENGLISH;
		Policy policy;

		Builder() {}

		/**
		 * (REQUIRED)
		 * The name of the template. For WhatsApp use your WhatsApp namespace (available via Facebook Business Manager),
		 * followed by a colon : and the name of the template to use.
		 *
		 * @param name The template name.
		 * @return This builder.
		 */
		public Builder name(String name) {
			this.name = name;
			return this;
		}

		/**
		 * (OPTIONAL)
		 * The parameters are an array of strings, with the first being substituted for {{1}} in the template,
		 * the second being {{2}} etc. You can find the full list of supported parameters on WhatsApp's
		 * 
		 * messages parameters documentation.
		 *
		 * @param parameters The list of template parameters.
		 * @return This builder.
		 */
		public Builder parameters(List parameters) {
			this.parameters = parameters;
			return this;
		}

		/**
		 * (OPTIONAL)
		 * Policy for resolving what language template to use.
		 *
		 * @param policy The policy field.
		 * @return This builder.
		 */
		public Builder policy(Policy policy) {
			this.policy = policy;
			return this;
		}

		/**
		 * (REQUIRED)
		 * The BCP 47 language of the template. Defaults to {@linkplain Locale#ENGLISH} if not set.
		 * 
		 * @param locale The {@link Locale}.
		 * @return This builder.
		 */
		public Builder locale(Locale locale) {
			this.locale = locale;
			return this;
		}

		@Override
		public WhatsappTemplateRequest build() {
			return new WhatsappTemplateRequest(this);
		}
	}
}