com.sinch.sdk.domains.conversation.api.templates.v1.TemplatesServiceV1 Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sinch-sdk-java Show documentation

SDK providing a Java API for the Sinch REST APIs.

There is a newer version: 1.4.0

package com.sinch.sdk.domains.conversation.api.templates.v1;

import com.sinch.sdk.domains.conversation.templates.models.v1.TemplateV1;
import java.util.Collection;

/**
 * Templates V1
 *
 * Version 1 endpoints for managing message templates.
 *
 * 
Currently maintained for existing users.
 *
 * Version 2 is recommended.
 *
 * @see online
 *     documentation
 * @since 1.3
 */
public interface TemplatesServiceV1 {

  /**
   * List all templates belonging to a project ID.
   *
   * @return List of templates
   * @since 1.3
   */
  Collection list();

  /**
   * Creates a template
   *
   * @param template Information for creation
   * @return Created template
   * @since 1.3
   */
  TemplateV1 create(TemplateV1 template);

  /***
   * Get a template
   * @param templateId  The ID of the template to fetch.
   * @return The template information
   * @since 1.3
   */
  TemplateV1 get(String templateId);

  /***
   * Delete a template
   * @param templateId  The ID of the template to delete.
   * @since 1.3
   */
  void delete(String templateId);

  /**
   * Updates a template
   *
   * @param template Information to be updated
   * @return Updated template
   * @since 1.3
   */
  TemplateV1 update(String templateId, TemplateV1 template);
}