docs (Conversation/javadoc): Enhance javadoc

client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java

@@ -26,8 +26,9 @@ public interface ConversationService {
    *
    * <p>The Template Management API offers a way to manage templates that can be used together with
    * the Conversation API.
-   * <p>Note that you may also use the Message Composer tool on the Sinch
-   * Customer Dashboard to manage templates.
+   *
+   * <p>Note that you may also use the Message Composer tool on the Sinch Customer Dashboard to
+   * manage templates.
    *
    * @return Service instance for project
    * @see <a

client/src/main/com/sinch/sdk/domains/conversation/api/templates/package-info.java

@@ -1,7 +1,8 @@
 /**
  * Conversation API interface for templates management
  *
- * @see <a href="https://developers.sinch.com/docs/conversation/templates">Conversation Templates</a>
+ * @see <a href="https://developers.sinch.com/docs/conversation/templates">Conversation
+ *     Templates</a>
  * @since 1.3
  */
 package com.sinch.sdk.domains.conversation.api.templates;

client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java

@@ -7,7 +7,9 @@
  * Templates V1
  *
  * <p>Version 1 endpoints for managing message templates.
+ *
  * <p>Currently maintained for existing users.
+ *
  * <p>Version 2 is recommended.
  *
  * @see <a

client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/package-info.java

@@ -1,7 +1,8 @@
 /**
  * Conversation API interface for templates V1 management
  *
- * @see <a href="https://developers.sinch.com/docs/conversation/templates/#version-1">Conversation Templates V1</a>
+ * @see <a href="https://developers.sinch.com/docs/conversation/templates/#version-1">Conversation
+ *     Templates V1</a>
  * @since 1.3
  */
 package com.sinch.sdk.domains.conversation.api.templates.v1;

client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java

@@ -7,10 +7,16 @@
 
 /**
  * Templates V2
- * <p>
- * Version 2 endpoints for managing message templates.
- * <p></p>Recommended version for all users.
- * <p></p>Includes strongly typed <code>translations</code> 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).
+ *
+ * <p>Version 2 endpoints for managing message templates.
+ *
+ * <p>Recommended version for all users.
+ *
+ * <p>Includes strongly typed <code>translations</code> 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 <a
  *     href="https://developers.sinch.com/docs/conversation/api-reference/template/tag/Templates-V2">online
  *     documentation</a>

client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java

@@ -1,7 +1,8 @@
 /**
  * Conversation API interface for templates V2 management
  *
- * @see <a href="https://developers.sinch.com/docs/conversation/templates/#version-2">Conversation Templates V2</a>
+ * @see <a href="https://developers.sinch.com/docs/conversation/templates/#version-2">Conversation
+ *     Templates V2</a>
  * @since 1.3
  */
 package com.sinch.sdk.domains.conversation.api.templates.v2;

client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java

@@ -81,10 +81,11 @@ public interface AppService {
    * <p>Any specified field values will replace existing values.
    *
    * <p>Therefore, <b>if you'd like to add additional configurations to an existing Conversation API
-   * app, ensure that you include existing values AND new values in the call</b>.
-   * <br> For example, if you'd like to add new <code>channel_credentials</code>, you can get your existing Conversation API app, extract
-   * the existing <code>channel_credentials</code> list, append your new configuration to that list, and include
-   * the updated <code>channel_credentials</code> list in this update call.
+   * app, ensure that you include existing values AND new values in the call</b>. <br>
+   * For example, if you'd like to add new <code>channel_credentials</code>, you can get your
+   * existing Conversation API app, extract the existing <code>channel_credentials</code> list,
+   * append your new configuration to that list, and include the updated <code>channel_credentials
+   * </code> list in this update call.
    *
    * @param appId The unique ID of the app to be updated
    * @param parameters Fields to be updated. Only fields filled within the parameters will be

client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java

@@ -49,22 +49,85 @@ public interface MessagesService {
    */
   SendMessageResponse sendMessage(SendMessageRequest<? extends AppMessageBody> request);
 
+  /**
+   * Send a card message
+   *
+   * @param request CardMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendCardMessage(SendMessageRequest<CardMessage> request);
 
+  /**
+   * Send a carousel message
+   *
+   * @param request CarouselMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendCarouselMessage(SendMessageRequest<CarouselMessage> request);
 
+  /**
+   * Send a choice message
+   *
+   * @param request ChoiceMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendChoiceMessage(SendMessageRequest<ChoiceMessage> request);
 
+  /**
+   * Send a contact info message
+   *
+   * @param request ContactInfoMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendContactInfoMessage(SendMessageRequest<ContactInfoMessage> request);
 
+  /**
+   * Send a list message
+   *
+   * @param request ListMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendListMessage(SendMessageRequest<ListMessage> request);
 
+  /**
+   * Send a location message
+   *
+   * @param request LocationMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendLocationMessage(SendMessageRequest<LocationMessage> request);
 
+  /**
+   * Send a media message
+   *
+   * @param request MediaMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendMediaMessage(SendMessageRequest<MediaMessage> request);
 
+  /**
+   * Send a template message
+   *
+   * @param request TemplateMessage request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendTemplateMessage(SendMessageRequest<TemplateMessage> request);
 
+  /**
+   * Send a send message request message
+   *
+   * @param request request
+   * @return Response
+   * @see #sendMessage(SendMessageRequest)
+   */
   SendMessageResponse sendTextMessage(SendMessageRequest<TextMessage> request);
 
   /**

client/src/main/com/sinch/sdk/domains/conversation/models/v1/ChannelRecipientIdentities.java

@@ -7,6 +7,7 @@
 import java.util.Arrays;
 import java.util.Collection;
 
+/** Container for list of specific channel identities */
 @JsonDeserialize(builder = ChannelRecipientIdentities.Builder.class)
 public class ChannelRecipientIdentities extends ArrayList<ChannelRecipientIdentity>
     implements com.sinch.sdk.domains.conversation.models.v1.Recipient {
@@ -27,6 +28,7 @@ public static Builder builder() {
     return new Builder();
   }
 
+  /** Dedicated Builder */
   @JsonPOJOBuilder(withPrefix = "set")
   public static class Builder {
 

client/src/main/com/sinch/sdk/domains/conversation/models/v1/Recipient.java

@@ -1,3 +1,4 @@
 package com.sinch.sdk.domains.conversation.models.v1;
 
+/** Base class for all classes supported by Recipient */
 public interface Recipient {}

client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/package-info.java

@@ -0,0 +1,14 @@
+/**
+ * Conversation models for <code>App</code>
+ *
+ * <p>Apps are created and configured through the Sinch Dashboard, are tied to the API user and come
+ * with a set of <b>channel credentials</b> for each underlying connected channel.
+ *
+ * <p>The app has a list of <b>conversations</b> between itself and different <b>contacts</b> which
+ * share the same <b>project</b>.
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/App">App</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.app;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/request/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>App</code> request models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/App">App</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.app.request;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/response/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>App</code> response models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/App">App</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.app.response;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/package-info.java

@@ -0,0 +1,18 @@
+/**
+ * Conversation models for <code>Capability</code>
+ *
+ * <p>A capability query checks the options available for reaching the contact on the channels on
+ * which it has a channel identity.
+ *
+ * <p>Capability queries can only be executed for contacts that already exist in a project and app.
+ * For executing the request, either the contact ID or the channel recipient identities of the
+ * contact are required.
+ *
+ * <p>The request is executed asynchronously, therefore the service responds immediately. The result
+ * of the capability query is sent to the registered webhook for the <b>CAPABILITY</b> trigger.
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Capability">Capability</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.capability;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/request/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>Capability</code> request models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Capability">Capability</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.capability.request;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/response/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>Capability</code> responses models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Capability">Capability</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.capability.response;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/package-info.java

@@ -0,0 +1,15 @@
+/**
+ * Conversation models for <code>Contact</code>
+ *
+ * <p>A contact is a collection that groups together underlying connected <b>channel recipient
+ * identities</b>. It's tied to a specific <b>project</b> and is therefore considered public to all
+ * <b>apps</b> sharing the same <b>project</b>.
+ *
+ * <p>Most contact creation and maintenance is handled by the Conversation API's automatic contact
+ * management processes. However, you can also use API calls to manually manage your contacts.
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Capability">Capability</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.contact;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/request/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>Contact</code> request models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Contact">Contact</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.contact.request;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/response/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>Contact</code> response models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Contact">Contact</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.contact.response;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/package-info.java

@@ -0,0 +1,10 @@
+/**
+ * Conversation models for <code>Conversation</code>
+ *
+ * <p>APIS for working with the conversation log.
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Conversation">Conversation</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.conversation;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java

@@ -92,6 +92,11 @@ static Builder builder(ConversationsListRecentRequest parameters) {
     return new ConversationsListRecentRequestImpl.Builder(parameters);
   }
 
+  /**
+   * Dedicated builder
+   *
+   * @since 1.3
+   */
   interface Builder {
 
     /**

client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>Conversation</code> request models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Conversation">Conversation</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.conversation.request;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/package-info.java

@@ -0,0 +1,8 @@
+/**
+ * <code>Conversation</code> response models
+ *
+ * @see <a
+ *     href="https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Conversation">Conversation</a>
+ * @since 1.3
+ */
+package com.sinch.sdk.domains.conversation.models.v1.conversation.response;

client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ChannelCredentials.java

@@ -1,3 +1,4 @@
 package com.sinch.sdk.domains.conversation.models.v1.credentials;
 
+/** Base class for Credentials classes */
 public interface ChannelCredentials {}