com.sinch.sdk.domains.conversation.api.templates.v2.TemplatesServiceV2 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.v2;

import com.sinch.sdk.domains.conversation.templates.models.v2.TemplateTranslation;
import com.sinch.sdk.domains.conversation.templates.models.v2.TemplateV2;
import com.sinch.sdk.domains.conversation.templates.models.v2.request.TranslationListRequest;
import java.util.Collection;

/**
 * Templates V2
 *
 * Version 2 endpoints for managing message templates.
 *
 * 
Recommended version for all users.
 *
 * Includes strongly typed translations field (allowing for message definition using
 * JSON structures also used in the send message request of the Conversation API), improved
 * validation, and the ability to override omni-channel templates in favor of channel-specific
 * templates (where available).
 *
 * @see online
 *     documentation
 * @since 1.3
 */
public interface TemplatesServiceV2 {

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

  /**
   * List translations for a template
   *
   * @param templateId The ID of the template to fetch
   * @param request Parameters for request
   * @return The translations list
   * @since 1.3
   */
  Collection listTranslations(
      String templateId, TranslationListRequest request);

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

  /***
   * Get a template
   * @param templateId  The ID of the template to fetch.
   * @return The template information
   * @since 1.3
   */
  TemplateV2 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
   */
  TemplateV2 update(String templateId, TemplateV2 template);
}