Package africa.sendbyte.templates

Class Templates

java.lang.Object

africa.sendbyte.templates.Templates

public final class Templates
extends Object

The Templates resource: manage reusable server-side Handlebars/MJML templates and preview their rendered output.

Obtain an instance via client.templates(). Every method has a blocking form and an ...Async form returning a CompletableFuture. Send with a saved template by passing its id or name as templateId on a send request.

Constructor Summary

Constructors

Constructor	Description
Templates(RequestExecutor executor)

Method Summary

Modifier and Type	Method	Description
Template	create(TemplateRequest request)	Create a new template.
CompletableFuture<Template>	createAsync(TemplateRequest request)	Asynchronous create(TemplateRequest).
void	delete(String id)	Permanently delete a template.
CompletableFuture<Void>	deleteAsync(String id)	Asynchronous delete(String).
Template	get(String id)	Retrieve a template by id, including its stored HTML and MJML source.
CompletableFuture<Template>	getAsync(String id)	Asynchronous get(String).
TemplateList	list()	List all templates in the project.
CompletableFuture<TemplateList>	listAsync()	Asynchronous list().
RenderedTemplate	preview(String id, Map<String,Object> variables)	Render a previously saved template against a set of variables, without sending.
CompletableFuture<RenderedTemplate>	previewAsync(String id, Map<String,Object> variables)	Asynchronous preview(String, Map).
RenderedTemplate	render(RenderRequest request)	Render a template body with variables inline, without saving anything.
CompletableFuture<RenderedTemplate>	renderAsync(RenderRequest request)	Asynchronous render(RenderRequest).
Template	update(String id, TemplateRequest request)	Replace a template's definition, bumping its version.
CompletableFuture<Template>	updateAsync(String id, TemplateRequest request)	Asynchronous update(String, TemplateRequest).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Templates

public Templates(RequestExecutor executor)

Method Details

create

public Template create(TemplateRequest request)

Create a new template. Invalid Handlebars/MJML is rejected at save time.

createAsync

public CompletableFuture<Template> createAsync(TemplateRequest request)

Asynchronous create(TemplateRequest).

get

public Template get(String id)

Retrieve a template by id, including its stored HTML and MJML source.

getAsync

public CompletableFuture<Template> getAsync(String id)

Asynchronous get(String).

list

public TemplateList list()

List all templates in the project.

listAsync

public CompletableFuture<TemplateList> listAsync()

Asynchronous list().

update

public Template update(String id,
 TemplateRequest request)

Replace a template's definition, bumping its version. Already-sent emails are unaffected.

updateAsync

public CompletableFuture<Template> updateAsync(String id,
 TemplateRequest request)

Asynchronous update(String, TemplateRequest).

delete

public void delete(String id)

Permanently delete a template. Future sends referencing it will fail with not_found.

deleteAsync

public CompletableFuture<Void> deleteAsync(String id)

Asynchronous delete(String).

render

public RenderedTemplate render(RenderRequest request)

Render a template body with variables inline, without saving anything.

renderAsync

public CompletableFuture<RenderedTemplate> renderAsync(RenderRequest request)

Asynchronous render(RenderRequest).

preview

public RenderedTemplate preview(String id,
 Map<String,Object> variables)

Render a previously saved template against a set of variables, without sending.

previewAsync

public CompletableFuture<RenderedTemplate> previewAsync(String id,
 Map<String,Object> variables)

Asynchronous preview(String, Map).