From 10c739a0f354354a1b7240f614f0edfbb3e08665 Mon Sep 17 00:00:00 2001 From: Jean-Pierre Portier Date: Tue, 24 Sep 2024 12:01:38 +0200 Subject: [PATCH 1/4] docs (Conversation/javadoc): Bump to next version: '1.3' --- .../conversation/ConversationService.java | 6 +++--- .../api/templates/TemplatesService.java | 6 +++--- .../api/templates/v1/TemplatesServiceV1.java | 14 ++++++------- .../api/templates/v2/TemplatesServiceV2.java | 14 ++++++------- .../conversation/api/v1/AppService.java | 12 +++++------ .../api/v1/CapabilityService.java | 4 ++-- .../conversation/api/v1/ContactService.java | 18 ++++++++--------- .../api/v1/ConversationService.java | 18 ++++++++--------- .../api/v1/ConversationsService.java | 20 +++++++++---------- .../conversation/api/v1/EventsService.java | 10 +++++----- .../conversation/api/v1/MessagesService.java | 6 +++--- .../api/v1/TranscodingService.java | 4 ++-- .../conversation/api/v1/WebHooksService.java | 16 +++++++-------- .../conversation/api/v1/package-info.java | 2 +- .../ConversationsListRecentRequest.java | 2 +- .../request/ConversationsListRequest.java | 2 +- .../ConversationsListRecentResponse.java | 2 +- .../response/ConversationsListResponse.java | 2 +- .../v1/events/request/EventsListRequest.java | 2 +- .../events/response/EventsListResponse.java | 2 +- .../models/v1/messages/AppMessage.java | 2 +- .../models/v1/messages/ContactMessage.java | 2 +- .../messages/request/MessagesListRequest.java | 2 +- .../response/MessagesListResponse.java | 2 +- .../domains/conversation/package-info.java | 2 +- .../v2/request/TranslationListRequest.java | 2 +- 26 files changed, 87 insertions(+), 87 deletions(-) diff --git a/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java b/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java index 309c50cc..c1d98f5e 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java @@ -7,7 +7,7 @@ * * @see https://developers.sinch.com/docs/conversation/ - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface ConversationService { @@ -17,7 +17,7 @@ public interface ConversationService { * @return V1 service instance for project * @see Documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ com.sinch.sdk.domains.conversation.api.v1.ConversationService v1(); @@ -31,7 +31,7 @@ public interface ConversationService { * @return Service instance for project * @see Documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplatesService templates(); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java index 11a98d20..809aadf8 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java @@ -9,7 +9,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface TemplatesService { @@ -17,7 +17,7 @@ public interface TemplatesService { * Service for working with templates V1 * * @return Templates V1 service - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplatesServiceV1 v1(); @@ -25,7 +25,7 @@ public interface TemplatesService { * Service for working with templates V2 * * @return Templates V2 service - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplatesServiceV2 v2(); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java index 19ed4524..b49e7629 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java @@ -12,15 +12,15 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface TemplatesServiceV1 { /** * List all templates belonging to a project ID. * - * @return List of templates * @since _NEXT_VERSION_ - * @since _NEXT_VERSION_ + * @return List of templates + * @since 1.3 */ Collection list(); @@ -29,7 +29,7 @@ public interface TemplatesServiceV1 { * * @param template Information for creation * @return Created template - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplateV1 create(TemplateV1 template); @@ -37,14 +37,14 @@ public interface TemplatesServiceV1 { * Get a template * @param templateId The ID of the template to fetch. * @return The template information - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplateV1 get(String templateId); /*** * Delete a template * @param templateId The ID of the template to delete. - * @since _NEXT_VERSION_ + * @since 1.3 */ void delete(String templateId); @@ -53,7 +53,7 @@ public interface TemplatesServiceV1 { * * @param template Information to be updated * @return Updated template - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplateV1 update(String templateId, TemplateV1 template); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java index 8ea15f60..0c5e1182 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java @@ -11,7 +11,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface TemplatesServiceV2 { @@ -19,7 +19,7 @@ public interface TemplatesServiceV2 { * List all templates belonging to a project ID. * * @return List of templates - * @since _NEXT_VERSION_ + * @since 1.3 */ Collection list(); @@ -29,7 +29,7 @@ public interface TemplatesServiceV2 { * @param templateId The ID of the template to fetch * @param request Parameters for request * @return The translations list - * @since _NEXT_VERSION_ + * @since 1.3 */ Collection listTranslations( String templateId, TranslationListRequest request); @@ -39,7 +39,7 @@ Collection listTranslations( * * @param template Information for creation * @return Created template - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplateV2 create(TemplateV2 template); @@ -47,14 +47,14 @@ Collection listTranslations( * Get a template * @param templateId The ID of the template to fetch. * @return The template information - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplateV2 get(String templateId); /*** * Delete a template * @param templateId The ID of the template to delete. - * @since _NEXT_VERSION_ + * @since 1.3 */ void delete(String templateId); @@ -63,7 +63,7 @@ Collection listTranslations( * * @param template Information to be updated * @return Updated template - * @since _NEXT_VERSION_ + * @since 1.3 */ TemplateV2 update(String templateId, TemplateV2 template); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java index d277fd29..ed6bc9e1 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java @@ -20,7 +20,7 @@ * * @see https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/App/ - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface AppService { @@ -31,7 +31,7 @@ public interface AppService { * * @return List of apps related to configured region (from {@link * com.sinch.sdk.models.Configuration.Builder#setConversationRegion(ConversationRegion)}) - * @since _NEXT_VERSION_ + * @since 1.3 */ Collection list(); @@ -42,7 +42,7 @@ public interface AppService { * * @param appId The application identifier * @return App information details - * @since _NEXT_VERSION_ + * @since 1.3 */ AppResponse get(String appId); @@ -56,7 +56,7 @@ public interface AppService { * deleted). * * @param appId The application identifier - * @since _NEXT_VERSION_ + * @since 1.3 */ void delete(String appId); @@ -69,7 +69,7 @@ public interface AppService { * * @param parameters Creation parameters * @return Created application - * @since _NEXT_VERSION_ + * @since 1.3 */ AppResponse create(AppCreateRequest parameters); @@ -90,7 +90,7 @@ public interface AppService { * @param parameters Fields to be updated. Only fields filled within the parameters will be * updated * @return Updated application - * @since _NEXT_VERSION_ + * @since 1.3 */ AppResponse update(String appId, AppUpdateRequest parameters); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/CapabilityService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/CapabilityService.java index da643f63..3b51613a 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/CapabilityService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/CapabilityService.java @@ -19,7 +19,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface CapabilityService { @@ -33,7 +33,7 @@ public interface CapabilityService { * * @param request The request parameters to lookup capability * @return The capability response - * @since _NEXT_VERSION_ + * @since 1.3 */ QueryCapabilityResponse lookup(QueryCapabilityRequest request); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ContactService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ContactService.java index f0d70a7d..27cc7870 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ContactService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ContactService.java @@ -25,7 +25,7 @@ * * @see https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Contact - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface ContactService { @@ -39,7 +39,7 @@ public interface ContactService { * * @param parameters Filtering parameters * @return List of contacts according to search criteria - * @since _NEXT_VERSION_ + * @since 1.3 */ ContactListResponse list(ContactListRequest parameters); @@ -53,7 +53,7 @@ public interface ContactService { * * @param contactId Contact's Id * @return Contact information - * @since _NEXT_VERSION_ + * @since 1.3 */ Contact get(String contactId); @@ -67,7 +67,7 @@ public interface ContactService { * * @param contact Contact information to be used for creation * @return Contact information - * @since _NEXT_VERSION_ + * @since 1.3 */ Contact create(ContactCreateRequest contact); @@ -75,7 +75,7 @@ public interface ContactService { * Delete a contact as specified by the contact ID. * * @param contactId Contact's Id - * @since _NEXT_VERSION_ + * @since 1.3 */ void delete(String contactId); @@ -85,7 +85,7 @@ public interface ContactService { * @param contactId Contact ID to be updated * @param contact Contact information to be updated * @return Updated contact information - * @since _NEXT_VERSION_ + * @since 1.3 */ Contact update(String contactId, Contact contact); @@ -110,7 +110,7 @@ public interface ContactService { * contacts. * @param sourceId The ID of the contact that should be removed * @return The merged contact details - * @since _NEXT_VERSION_ + * @since 1.3 */ Contact mergeContact(String destinationId, String sourceId); @@ -128,7 +128,7 @@ public interface ContactService { * * @param parameters The ID of the contact to be used to check profile information * @return The profile name - * @since _NEXT_VERSION_ + * @since 1.3 */ String getChannelProfileByContactId(ContactGetChannelProfileByContactIdRequest parameters); @@ -147,7 +147,7 @@ public interface ContactService { * @param parameters The identity as specified by the channel to be used to check profile * information * @return The profile name - * @since _NEXT_VERSION_ + * @since 1.3 */ String getChannelProfileByChannelIdentity( ContactGetChannelProfileByChannelIdentityRequest parameters); diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java index a33c3d33..695f77be 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java @@ -5,7 +5,7 @@ * * @see https://developers.sinch.com/docs/conversation/ - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface ConversationService { @@ -13,7 +13,7 @@ public interface ConversationService { * Applications Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ AppService app(); @@ -21,7 +21,7 @@ public interface ConversationService { * Contact Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ ContactService contact(); @@ -29,7 +29,7 @@ public interface ConversationService { * Messages Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ MessagesService messages(); @@ -37,7 +37,7 @@ public interface ConversationService { * Conversations Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ ConversationsService conversations(); @@ -45,7 +45,7 @@ public interface ConversationService { * Events Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ EventsService events(); @@ -53,7 +53,7 @@ public interface ConversationService { * Transcoding Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ TranscodingService transcoding(); @@ -61,7 +61,7 @@ public interface ConversationService { * Capability Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ CapabilityService capability(); @@ -69,7 +69,7 @@ public interface ConversationService { * WebHooksService Service instance * * @return service instance for project - * @since _NEXT_VERSION_ + * @since 1.3 */ WebHooksService webhooks(); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationsService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationsService.java index 6bceb5a0..c07daade 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationsService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationsService.java @@ -17,7 +17,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface ConversationsService { @@ -34,7 +34,7 @@ public interface ConversationsService { * * @param request Conversation request for creation * @return Created conversation - * @since _NEXT_VERSION_ + * @since 1.3 */ Conversation create(CreateConversationRequest request); @@ -44,7 +44,7 @@ public interface ConversationsService { * * @param conversationId The unique ID of the conversation. * @return Conversation details - * @since _NEXT_VERSION_ + * @since 1.3 */ Conversation get(String conversationId); @@ -52,7 +52,7 @@ public interface ConversationsService { * This operation lists all conversations that are associated with an app and/or a contact. * * @param request Request parameters - * @since _NEXT_VERSION_ + * @since 1.3 */ ConversationsListResponse list(ConversationsListRequest request); @@ -61,7 +61,7 @@ public interface ConversationsService { * recent message was sent for that conversation. * * @param request Request parameters - * @since _NEXT_VERSION_ + * @since 1.3 */ ConversationsListRecentResponse listRecent(ConversationsListRecentRequest request); @@ -72,7 +72,7 @@ public interface ConversationsService { * that was part of the stopped conversation. * * @param conversationId The unique ID of the conversation. - * @since _NEXT_VERSION_ + * @since 1.3 */ void stopActive(String conversationId); @@ -80,7 +80,7 @@ public interface ConversationsService { * Deletes a conversation together with all the messages sent as part of the conversation. * * @param conversationId The unique ID of the conversation. - * @since _NEXT_VERSION_ + * @since 1.3 */ void delete(String conversationId); @@ -90,7 +90,7 @@ public interface ConversationsService { * * @param request Conversation instance with fields to be updated * @return Update conversation - * @since _NEXT_VERSION_ + * @since 1.3 */ Conversation update( String conversationId, MetadataUpdateStrategy updateStrategy, Conversation request); @@ -100,7 +100,7 @@ Conversation update( * * @param conversationId The ID of the conversation. * @param request Request parameters to inject message - * @since _NEXT_VERSION_ + * @since 1.3 */ void injectMessage(String conversationId, InjectMessageRequest request); @@ -109,7 +109,7 @@ Conversation update( * * @param conversationId The ID of the conversation. * @param request Request parameters to inject event - * @since _NEXT_VERSION_ + * @since 1.3 */ InjectEventResponse injectEvent(String conversationId, InjectEventRequest request); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/EventsService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/EventsService.java index 4944573b..b419746a 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/EventsService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/EventsService.java @@ -12,7 +12,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface EventsService { @@ -26,7 +26,7 @@ public interface EventsService { * * @param request Send event request parameters * @return Response related to event enqueued - * @since _NEXT_VERSION_ + * @since 1.3 */ SendEventResponse send(SendEventRequest request); @@ -35,7 +35,7 @@ public interface EventsService { * * @param eventId The unique ID of the event * @return Conversation event - * @since _NEXT_VERSION_ + * @since 1.3 */ ConversationEvent get(String eventId); @@ -43,7 +43,7 @@ public interface EventsService { * Delete a specific event by its ID * * @param eventId The unique ID of the event - * @since _NEXT_VERSION_ + * @since 1.3 */ void delete(String eventId); @@ -52,7 +52,7 @@ public interface EventsService { * * @param request Request parameters * @return List of events - * @since _NEXT_VERSION_ + * @since 1.3 */ EventsListResponse list(EventsListRequest request); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java index 26b37efb..de578298 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java @@ -28,7 +28,7 @@ * * @see https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Messages - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface MessagesService { @@ -45,7 +45,7 @@ public interface MessagesService { * * @return Response related to messages sent (from {@link * com.sinch.sdk.domains.conversation.models.v1.messages.response.SendMessageResponse}) - * @since _NEXT_VERSION_ + * @since 1.3 */ SendMessageResponse sendMessage(SendMessageRequest request); @@ -106,7 +106,7 @@ public interface MessagesService { * * @param request Request parameters * @return List of messages - * @since _NEXT_VERSION_ + * @since 1.3 */ MessagesListResponse list(MessagesListRequest request); diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/TranscodingService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/TranscodingService.java index f7d05707..ca52e36b 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/TranscodingService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/TranscodingService.java @@ -9,7 +9,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface TranscodingService { @@ -22,7 +22,7 @@ public interface TranscodingService { * @param request The message to be transcoded, and the app and channels for which the message is * to be transcoded * @return Transcoded message - * @since _NEXT_VERSION_ + * @since 1.3 */ TranscodeMessageResponse transcodeMessage(TranscodeMessageRequest request); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/WebHooksService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/WebHooksService.java index 8d6ca819..b42dc165 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/WebHooksService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/WebHooksService.java @@ -15,7 +15,7 @@ *

see online * documentation * - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface WebHooksService { @@ -35,7 +35,7 @@ public interface WebHooksService { *

see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ boolean validateAuthenticationHeader( String secret, Map headers, String jsonPayload); @@ -49,7 +49,7 @@ boolean validateAuthenticationHeader( *

see triggered * events - * @since _NEXT_VERSION_ + * @since 1.3 */ ConversationWebhookEvent parseEvent(String jsonPayload) throws ApiMappingException; @@ -58,7 +58,7 @@ boolean validateAuthenticationHeader( * * @param appId The unique ID of the app * @return List of defined webhooks - * @since _NEXT_VERSION_ + * @since 1.3 */ Collection list(String appId); @@ -67,7 +67,7 @@ boolean validateAuthenticationHeader( * * @param webhookId The unique ID of the webhook. * @return Webhook definition - * @since _NEXT_VERSION_ + * @since 1.3 */ Webhook get(String webhookId); @@ -76,7 +76,7 @@ boolean validateAuthenticationHeader( * * @param webhook Webhook parameter for creation * @return Created webhook - * @since _NEXT_VERSION_ + * @since 1.3 */ Webhook create(Webhook webhook); @@ -86,7 +86,7 @@ boolean validateAuthenticationHeader( * @param webhookId The unique ID of the webhook. * @param webhook Webhook parameter for creation * @return Created webhook - * @since _NEXT_VERSION_ + * @since 1.3 */ Webhook update(String webhookId, Webhook webhook); @@ -94,7 +94,7 @@ boolean validateAuthenticationHeader( * Deletes a webhook as specified by the webhook ID * * @param webhookId The unique ID of the webhook. - * @since _NEXT_VERSION_ + * @since 1.3 */ void delete(String webhookId); } diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java index af470725..c96d9f02 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java @@ -13,6 +13,6 @@ * Ireland, and additional channels will be supported as they become popular. * * @see Conversation - * @since _NEXT_VERSION_ + * @since 1.3 */ package com.sinch.sdk.domains.conversation.api.v1; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java index e856d37d..48e32d6e 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java @@ -12,7 +12,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface ConversationsListRecentRequest { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRequest.java index 5812001b..cbb3d957 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRequest.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRequest.java @@ -9,7 +9,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface ConversationsListRequest { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListRecentResponse.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListRecentResponse.java index c74aca5e..308b4ce6 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListRecentResponse.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListRecentResponse.java @@ -11,7 +11,7 @@ /** * Recent messages and conversation response * - * @since _NEXT_VERSION_ + * @since 1.3 */ public class ConversationsListRecentResponse extends ListResponse { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListResponse.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListResponse.java index 40651f59..ad605cee 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListResponse.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/ConversationsListResponse.java @@ -12,7 +12,7 @@ /** * Lists all conversations response * - * @since _NEXT_VERSION_ + * @since 1.3 */ public class ConversationsListResponse extends ListResponse { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java index 11e76740..882d76fe 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java @@ -8,7 +8,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface EventsListRequest { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/EventsListResponse.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/EventsListResponse.java index cbd192c8..6b3c2297 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/EventsListResponse.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/EventsListResponse.java @@ -12,7 +12,7 @@ /** * Lists all messages response * - * @since _NEXT_VERSION_ + * @since 1.3 */ public class EventsListResponse extends ListResponse { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessage.java index 012048e2..ac85382b 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessage.java @@ -9,7 +9,7 @@ * Message originating from an app * * @param Body type for message - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface AppMessage extends ConversationMessageBody { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java index 1845a938..bdd9343f 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java @@ -4,7 +4,7 @@ * Message originating from a Contact * * @param Body type for message - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface ContactMessage extends ConversationMessageBody { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java index f81b73b1..405c4ab9 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java @@ -11,7 +11,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface MessagesListRequest { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/MessagesListResponse.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/MessagesListResponse.java index 157715a1..81cc2345 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/MessagesListResponse.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/MessagesListResponse.java @@ -12,7 +12,7 @@ /** * Lists all messages response * - * @since _NEXT_VERSION_ + * @since 1.3 */ public class MessagesListResponse extends ListResponse { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/package-info.java index 686cb4f3..52f5169d 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/package-info.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/package-info.java @@ -3,6 +3,6 @@ * * @see https://developers.sinch.com/docs/conversation - * @since _NEXT_VERSION_ + * @since 1.3 */ package com.sinch.sdk.domains.conversation; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/TranslationListRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/TranslationListRequest.java index ebb71b7e..1357bc47 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/TranslationListRequest.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/TranslationListRequest.java @@ -8,7 +8,7 @@ * @see online * documentation - * @since _NEXT_VERSION_ + * @since 1.3 */ public interface TranslationListRequest { From cea4eab308b13712e0db37fabe1d8a07fbedf640 Mon Sep 17 00:00:00 2001 From: Jean-Pierre Portier Date: Tue, 24 Sep 2024 14:51:19 +0200 Subject: [PATCH 2/4] docs (Conversation/javadoc): Enhance javadoc --- .../sdk/domains/conversation/ConversationService.java | 3 ++- .../conversation/api/templates/TemplatesService.java | 2 +- .../conversation/api/templates/package-info.java | 7 +++++++ .../api/templates/v1/TemplatesServiceV1.java | 5 +++-- .../conversation/api/templates/v1/package-info.java | 7 +++++++ .../api/templates/v2/TemplatesServiceV2.java | 5 ++++- .../conversation/api/templates/v2/package-info.java | 7 +++++++ .../sdk/domains/conversation/api/v1/AppService.java | 10 +++++----- .../conversation/api/v1/ConversationService.java | 2 +- .../sdk/domains/conversation/api/v1/package-info.java | 2 +- .../sinch/sdk/domains/conversation/package-info.java | 4 +++- 11 files changed, 41 insertions(+), 13 deletions(-) create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/api/templates/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java diff --git a/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java b/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java index c1d98f5e..840d1a46 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java @@ -25,7 +25,8 @@ public interface ConversationService { * Templates service * *

The Template Management API offers a way to manage templates that can be used together with - * the Conversation API. Note that you may also use the Message Composer tool on the Sinch + * the Conversation API. + *

Note that you may also use the Message Composer tool on the Sinch * Customer Dashboard to manage templates. * * @return Service instance for project diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java index 809aadf8..9f336ff5 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/TemplatesService.java @@ -4,7 +4,7 @@ import com.sinch.sdk.domains.conversation.api.templates.v2.TemplatesServiceV2; /** - * Service for working with templates + * Service for working with Conversation templates * * @see online diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/package-info.java new file mode 100644 index 00000000..8c039f00 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/package-info.java @@ -0,0 +1,7 @@ +/** + * Conversation API interface for templates management + * + * @see Conversation Templates + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.api.templates; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java index b49e7629..0a22fb2d 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java @@ -6,8 +6,9 @@ /** * Templates V1 * - *

Version 1 endpoints for managing message templates. Currently maintained for existing users. - * Version 2 is recommended. + *

Version 1 endpoints for managing message templates. + *

Currently maintained for existing users. + *

Version 2 is recommended. * * @see online diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/package-info.java new file mode 100644 index 00000000..39c4a192 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/package-info.java @@ -0,0 +1,7 @@ +/** + * Conversation API interface for templates V1 management + * + * @see Conversation Templates V1 + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.api.templates.v1; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java index 0c5e1182..02df7b5a 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java @@ -7,7 +7,10 @@ /** * 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 diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java new file mode 100644 index 00000000..ba9dc5aa --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java @@ -0,0 +1,7 @@ +/** + * Conversation API interface for templates V2 management + * + * @see Conversation Templates V2 + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.api.templates.v2; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java index ed6bc9e1..e52de862 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java @@ -80,11 +80,11 @@ public interface AppService { * *

Any specified field values will replace existing values. * - *

Therefore, 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. For example, if you'd - * like to add new channel_credentials, you can get your existing Conversation API app, extract - * the existing channel_credentials list, append your new configuration to that list, and include - * the updated channel_credentials list in this update call. + *

Therefore, 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. + *
For example, if you'd like to add new channel_credentials, you can get your existing Conversation API app, extract + * the existing channel_credentials list, append your new configuration to that list, and include + * the updated channel_credentials 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 diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java index 695f77be..6bafe0a0 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java @@ -1,7 +1,7 @@ package com.sinch.sdk.domains.conversation.api.v1; /** - * Conversation Service + * Conversation Service V1 * * @see https://developers.sinch.com/docs/conversation/ diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java index c96d9f02..c5ccb023 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/package-info.java @@ -1,5 +1,5 @@ /** - * Conversation API interface + * Conversation API interface for V1 endpoints * *

The Sinch Conversation API allows you to send and receive messages globally over SMS, RCS, * WhatsApp, Viber Business, Facebook Messenger and other popular channels. diff --git a/client/src/main/com/sinch/sdk/domains/conversation/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/package-info.java index 52f5169d..2d7f0cac 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/package-info.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/package-info.java @@ -1,6 +1,8 @@ /** * Conversation API interface - * + *

+ * The Sinch Conversation API allows you to send and receive messages globally over SMS, RCS, + * WhatsApp, Viber Business, Facebook Messenger and other popular channels. * @see https://developers.sinch.com/docs/conversation * @since 1.3 From 2f4ba0fd1a570189c6a275c3cf870d2ed6d0ee19 Mon Sep 17 00:00:00 2001 From: Jean-Pierre Portier Date: Thu, 26 Sep 2024 08:43:15 +0200 Subject: [PATCH 3/4] docs (Conversation/javadoc): Enhance javadoc --- .../conversation/ConversationService.java | 5 +- .../api/templates/package-info.java | 3 +- .../api/templates/v1/TemplatesServiceV1.java | 2 + .../api/templates/v1/package-info.java | 3 +- .../api/templates/v2/TemplatesServiceV2.java | 14 ++- .../api/templates/v2/package-info.java | 3 +- .../conversation/api/v1/AppService.java | 9 +- .../conversation/api/v1/MessagesService.java | 63 +++++++++++ .../models/v1/ChannelRecipientIdentities.java | 2 + .../conversation/models/v1/Recipient.java | 1 + .../models/v1/app/package-info.java | 14 +++ .../models/v1/app/request/package-info.java | 8 ++ .../models/v1/app/response/package-info.java | 8 ++ .../models/v1/capability/package-info.java | 18 ++++ .../v1/capability/request/package-info.java | 8 ++ .../v1/capability/response/package-info.java | 8 ++ .../models/v1/contact/package-info.java | 15 +++ .../v1/contact/request/package-info.java | 8 ++ .../v1/contact/response/package-info.java | 8 ++ .../models/v1/conversation/package-info.java | 10 ++ .../ConversationsListRecentRequest.java | 5 + .../v1/conversation/request/package-info.java | 8 ++ .../conversation/response/package-info.java | 8 ++ .../v1/credentials/ChannelCredentials.java | 1 + ...ationChannelCredentialsBuilderFactory.java | 101 ++++++++++++++++++ .../models/v1/credentials/package-info.java | 17 +++ .../models/v1/events/AppEvent.java | 1 + .../models/v1/events/ContactEvent.java | 1 + .../models/v1/events/ContactMessageEvent.java | 1 + .../models/v1/events/package-info.java | 10 ++ .../v1/events/request/EventsListRequest.java | 1 + .../v1/events/request/package-info.java | 8 ++ .../v1/events/response/package-info.java | 8 ++ .../models/v1/events/types/package-info.java | 8 ++ .../models/v1/messages/AppMessageBody.java | 1 + .../models/v1/messages/ContactMessage.java | 2 + .../v1/messages/ContactMessageBody.java | 1 + .../v1/messages/ConversationMessage.java | 1 + .../v1/messages/ConversationMessageBody.java | 1 + .../v1/messages/OmniMessageOverride.java | 1 + .../models/v1/messages/package-info.java | 16 +++ .../messages/request/MessagesListRequest.java | 1 + .../v1/messages/request/package-info.java | 8 ++ .../v1/messages/response/package-info.java | 8 ++ .../v1/messages/types/call/package-info.java | 6 ++ .../v1/messages/types/card/package-info.java | 6 ++ .../messages/types/carousel/package-info.java | 6 ++ .../ChannelSpecificContactMessageContent.java | 1 + .../ChannelSpecificMessage.java | 1 + .../types/channelspecific/package-info.java | 6 ++ .../flows/WhatsAppInteractiveHeader.java | 1 + .../whatsapp/flows/package-info.java | 6 ++ .../whatsapp/nfmreply/package-info.java | 6 ++ .../v1/messages/types/choice/Choice.java | 5 + .../types/choice/ChoiceCallMessage.java | 1 + .../types/choice/ChoiceLocationMessage.java | 1 + .../types/choice/ChoiceMessageType.java | 1 + .../types/choice/ChoiceTextMessage.java | 1 + .../types/choice/ChoiceURLMessage.java | 1 + .../messages/types/choice/package-info.java | 6 ++ .../types/choiceresponse/package-info.java | 6 ++ .../types/contactinfo/package-info.java | 6 ++ .../messages/types/fallback/package-info.java | 6 ++ .../v1/messages/types/list/ListItem.java | 1 + .../v1/messages/types/list/package-info.java | 6 ++ .../messages/types/location/package-info.java | 6 ++ .../v1/messages/types/media/package-info.java | 6 ++ .../types/mediacard/package-info.java | 6 ++ .../v1/messages/types/package-info.java | 8 ++ .../types/productresponse/package-info.java | 6 ++ .../messages/types/template/package-info.java | 6 ++ .../v1/messages/types/text/package-info.java | 6 ++ .../v1/messages/types/url/package-info.java | 6 ++ .../conversation/models/v1/package-info.java | 7 ++ .../models/v1/request/package-info.java | 6 ++ .../models/v1/transcoding/package-info.java | 8 ++ .../v1/transcoding/request/package-info.java | 8 ++ .../v1/transcoding/response/package-info.java | 8 ++ .../events/capability/package-info.java | 6 ++ .../webhooks/events/channel/package-info.java | 6 ++ .../webhooks/events/contact/package-info.java | 6 ++ .../events/conversation/package-info.java | 6 ++ .../events/delivery/package-info.java | 6 ++ .../webhooks/events/inbound/package-info.java | 6 ++ .../webhooks/events/message/package-info.java | 6 ++ .../webhooks/events/opting/package-info.java | 6 ++ .../v1/webhooks/events/package-info.java | 7 ++ .../webhooks/events/record/package-info.java | 6 ++ .../smartconversations/package-info.java | 6 ++ .../events/unsupported/package-info.java | 6 ++ .../models/v1/webhooks/package-info.java | 8 ++ .../v1/webhooks/response/package-info.java | 8 ++ .../domains/conversation/package-info.java | 7 +- .../templates/models/package-info.java | 9 ++ .../templates/models/v1/package-info.java | 9 ++ .../templates/models/v2/package-info.java | 9 ++ .../models/v2/request/package-info.java | 6 ++ .../ConversationChannelCredentials.java | 11 +- pom.xml | 1 + 99 files changed, 719 insertions(+), 17 deletions(-) create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/types/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/call/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/card/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/carousel/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/nfmreply/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choiceresponse/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/contactinfo/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/fallback/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/location/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/media/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/mediacard/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/productresponse/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/template/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/text/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/url/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/request/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/capability/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/channel/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/contact/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/conversation/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/delivery/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/inbound/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/message/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/opting/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/record/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/smartconversations/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/unsupported/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/response/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/templates/models/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/templates/models/v1/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/package-info.java create mode 100644 client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/package-info.java diff --git a/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java b/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java index 840d1a46..85c3297e 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/ConversationService.java @@ -26,8 +26,9 @@ public interface ConversationService { * *

The Template Management API offers a way to manage templates that can be used together with * the Conversation API. - *

Note that you may also use the Message Composer tool on the Sinch - * Customer Dashboard to manage templates. + * + *

Note that you may also use the Message Composer tool on the Sinch Customer Dashboard to + * manage templates. * * @return Service instance for project * @see Conversation Templates + * @see Conversation + * Templates * @since 1.3 */ package com.sinch.sdk.domains.conversation.api.templates; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java index 0a22fb2d..359701a2 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v1/TemplatesServiceV1.java @@ -7,7 +7,9 @@ * Templates V1 * *

Version 1 endpoints for managing message templates. + * *

Currently maintained for existing users. + * *

Version 2 is recommended. * * @see Conversation Templates V1 + * @see Conversation + * Templates V1 * @since 1.3 */ package com.sinch.sdk.domains.conversation.api.templates.v1; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java index 02df7b5a..8717f033 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/TemplatesServiceV2.java @@ -7,10 +7,16 @@ /** * 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). + * + *

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 diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java index ba9dc5aa..9c16e3c5 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/templates/v2/package-info.java +++ b/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 Conversation Templates V2 + * @see Conversation + * Templates V2 * @since 1.3 */ package com.sinch.sdk.domains.conversation.api.templates.v2; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java index e52de862..1089ff75 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/AppService.java @@ -81,10 +81,11 @@ public interface AppService { *

Any specified field values will replace existing values. * *

Therefore, 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. - *
For example, if you'd like to add new channel_credentials, you can get your existing Conversation API app, extract - * the existing channel_credentials list, append your new configuration to that list, and include - * the updated channel_credentials list in this update call. + * app, ensure that you include existing values AND new values in the call.
+ * For example, if you'd like to add new channel_credentials, you can get your + * existing Conversation API app, extract the existing channel_credentials list, + * append your new configuration to that list, and include the updated channel_credentials + * 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 diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java index de578298..d9832fe3 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java @@ -49,22 +49,85 @@ public interface MessagesService { */ SendMessageResponse sendMessage(SendMessageRequest request); + /** + * Send a card message + * + * @param request CardMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendCardMessage(SendMessageRequest request); + /** + * Send a carousel message + * + * @param request CarouselMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendCarouselMessage(SendMessageRequest request); + /** + * Send a choice message + * + * @param request ChoiceMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendChoiceMessage(SendMessageRequest request); + /** + * Send a contact info message + * + * @param request ContactInfoMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendContactInfoMessage(SendMessageRequest request); + /** + * Send a list message + * + * @param request ListMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendListMessage(SendMessageRequest request); + /** + * Send a location message + * + * @param request LocationMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendLocationMessage(SendMessageRequest request); + /** + * Send a media message + * + * @param request MediaMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendMediaMessage(SendMessageRequest request); + /** + * Send a template message + * + * @param request TemplateMessage request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendTemplateMessage(SendMessageRequest request); + /** + * Send a send message request message + * + * @param request request + * @return Response + * @see #sendMessage(SendMessageRequest) + */ SendMessageResponse sendTextMessage(SendMessageRequest request); /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/ChannelRecipientIdentities.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/ChannelRecipientIdentities.java index d9e716a8..9308fc07 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/ChannelRecipientIdentities.java +++ b/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 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 { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/Recipient.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/Recipient.java index 519a793b..0e2f565a 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/Recipient.java +++ b/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 {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/package-info.java new file mode 100644 index 00000000..5a9a103b --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/package-info.java @@ -0,0 +1,14 @@ +/** + * Conversation models for App + * + *

Apps are created and configured through the Sinch Dashboard, are tied to the API user and come + * with a set of channel credentials for each underlying connected channel. + * + *

The app has a list of conversations between itself and different contacts which + * share the same project. + * + * @see App + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.app; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/request/package-info.java new file mode 100644 index 00000000..3a667431 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/request/package-info.java @@ -0,0 +1,8 @@ +/** + * App request models + * + * @see App + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.app.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/response/package-info.java new file mode 100644 index 00000000..0dde0857 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/app/response/package-info.java @@ -0,0 +1,8 @@ +/** + * App response models + * + * @see App + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.app.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/package-info.java new file mode 100644 index 00000000..e2d286df --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/package-info.java @@ -0,0 +1,18 @@ +/** + * Conversation models for Capability + * + *

A capability query checks the options available for reaching the contact on the channels on + * which it has a channel identity. + * + *

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. + * + *

The request is executed asynchronously, therefore the service responds immediately. The result + * of the capability query is sent to the registered webhook for the CAPABILITY trigger. + * + * @see Capability + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.capability; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/request/package-info.java new file mode 100644 index 00000000..7285012d --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/request/package-info.java @@ -0,0 +1,8 @@ +/** + * Capability request models + * + * @see Capability + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.capability.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/response/package-info.java new file mode 100644 index 00000000..ae31cd4e --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/capability/response/package-info.java @@ -0,0 +1,8 @@ +/** + * Capability responses models + * + * @see Capability + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.capability.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/package-info.java new file mode 100644 index 00000000..db4b0235 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/package-info.java @@ -0,0 +1,15 @@ +/** + * Conversation models for Contact + * + *

A contact is a collection that groups together underlying connected channel recipient + * identities. It's tied to a specific project and is therefore considered public to all + * apps sharing the same project. + * + *

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 Capability + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.contact; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/request/package-info.java new file mode 100644 index 00000000..946c22ed --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/request/package-info.java @@ -0,0 +1,8 @@ +/** + * Contact request models + * + * @see Contact + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.contact.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/response/package-info.java new file mode 100644 index 00000000..93b851c4 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/contact/response/package-info.java @@ -0,0 +1,8 @@ +/** + * Contact response models + * + * @see Contact + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.contact.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/package-info.java new file mode 100644 index 00000000..980f5494 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/package-info.java @@ -0,0 +1,10 @@ +/** + * Conversation models for Conversation + * + *

APIS for working with the conversation log. + * + * @see Conversation + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.conversation; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java index 48e32d6e..db1f1f60 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/ConversationsListRecentRequest.java +++ b/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 { /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/package-info.java new file mode 100644 index 00000000..29469b48 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/request/package-info.java @@ -0,0 +1,8 @@ +/** + * Conversation request models + * + * @see Conversation + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.conversation.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/package-info.java new file mode 100644 index 00000000..d98c352f --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/conversation/response/package-info.java @@ -0,0 +1,8 @@ +/** + * Conversation response models + * + * @see Conversation + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.conversation.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ChannelCredentials.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ChannelCredentials.java index 2bf9650f..f477e15a 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ChannelCredentials.java +++ b/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 {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java index 53fdc81e..1edce6c9 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java @@ -2,8 +2,18 @@ import com.sinch.sdk.domains.conversation.models.v1.ConversationChannel; +/** Factory helper for App credentials builder */ public class ConversationChannelCredentialsBuilderFactory { + private ConversationChannelCredentialsBuilderFactory() {} + + /** + * Create dedicated conversation credential builder for {@link ConversationChannel#APPLEBC} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder appleBc( AppleBusinessChatCredentials credentials) { return ConversationChannelCredentials.builder() @@ -11,18 +21,39 @@ public static ConversationChannelCredentials.Builder appleBc( .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#INSTAGRAM} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder instagram(InstagramCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.INSTAGRAM) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#KAKAOTALK} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder kakaoTalk(KakaoTalkCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.KAKAOTALK) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for + * {@link ConversationChannel#KAKAOTALKCHAT} channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder kakaoTalkChat( KakaoTalkChatCredentials credentials) { return ConversationChannelCredentials.builder() @@ -30,12 +61,26 @@ public static ConversationChannelCredentials.Builder kakaoTalkChat( .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#LINE} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder line(LineCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.LINE) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#MESSENGER} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder messenger( StaticTokenCredentials credentials) { return ConversationChannelCredentials.builder() @@ -43,36 +88,78 @@ public static ConversationChannelCredentials.Builder messenger( .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#MMS} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder mms(MMSCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.MMS) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#RCS} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder rcs(StaticBearerCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.RCS) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#SMS} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder sms(StaticBearerCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.SMS) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#TELEGRAM} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder telegram(TelegramCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.TELEGRAM) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#VIBER} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder viber(StaticTokenCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.VIBER) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#VIBERBM} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder viberBm( StaticBearerCredentials credentials) { return ConversationChannelCredentials.builder() @@ -80,12 +167,26 @@ public static ConversationChannelCredentials.Builder viberBm( .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#WECHAT} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder weChat(WeChatCredentials credentials) { return ConversationChannelCredentials.builder() .setChannel(ConversationChannel.WECHAT) .setCredentials(credentials); } + /** + * Create dedicated conversation credential builder for{@link ConversationChannel#WHATSAPP} + * channel + * + * @param credentials Credentials + * @return Credentials builder + */ public static ConversationChannelCredentials.Builder whatsApp( StaticBearerCredentials credentials) { return ConversationChannelCredentials.builder() diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/package-info.java new file mode 100644 index 00000000..3bb2ce36 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/package-info.java @@ -0,0 +1,17 @@ +/** + * Conversation models for App credentials + * + *

Apps are created and configured through the Sinch Dashboard, are tied to the API user and come + * with a set of channel credentials for each underlying connected channel. + * + *

Use the {@link + * com.sinch.sdk.domains.conversation.models.v1.credentials.ConversationChannelCredentialsBuilderFactory} + * factory builder helper to create credentials related to channel + * + * @see App + * @see + * com.sinch.sdk.domains.conversation.models.v1.credentials.ConversationChannelCredentialsBuilderFactory + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.credentials; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/AppEvent.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/AppEvent.java index a3fdf189..7d8a8ffc 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/AppEvent.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/AppEvent.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.events; +/** Base class for all classes supported by AppEvent */ public interface AppEvent {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactEvent.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactEvent.java index 0a60e7ce..9562c592 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactEvent.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactEvent.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.events; +/** Base class for all classes supported by ContactEvent */ public interface ContactEvent {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactMessageEvent.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactMessageEvent.java index 988da532..9dfe3f1f 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactMessageEvent.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/ContactMessageEvent.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.events; +/** Base class for all classes supported by ContactMessageEvent */ public interface ContactMessageEvent {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/package-info.java new file mode 100644 index 00000000..ae6f1558 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/package-info.java @@ -0,0 +1,10 @@ +/** + * Conversation models for Events + * + *

APIs for sending events. + * + * @see Events + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.events; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java index 882d76fe..473a4197 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/EventsListRequest.java @@ -57,6 +57,7 @@ static Builder builder(EventsListRequest parameters) { return new EventsListRequestImpl.Builder(parameters); } + /** Dedicated Builder */ interface Builder { /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/package-info.java new file mode 100644 index 00000000..dc641028 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/request/package-info.java @@ -0,0 +1,8 @@ +/** + * Events request models + * + * @see Events + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.events.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/package-info.java new file mode 100644 index 00000000..b9c3f722 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/response/package-info.java @@ -0,0 +1,8 @@ +/** + * Events response models + * + * @see Events + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.events.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/types/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/types/package-info.java new file mode 100644 index 00000000..82f8fcc1 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/events/types/package-info.java @@ -0,0 +1,8 @@ +/** + * Event types models + * + * @see Events + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.events.types; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessageBody.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessageBody.java index fe827043..04f75e00 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessageBody.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/AppMessageBody.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages; +/** Base class for all classes supported by AppMessageBody */ public interface AppMessageBody {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java index bdd9343f..a821fbc0 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessage.java @@ -16,6 +16,8 @@ public interface ContactMessage extends Conversati T getBody(); /** + * Get replyTo + * * @see ReplyTo * @return reply to */ diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessageBody.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessageBody.java index 1379a393..69d248fa 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessageBody.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ContactMessageBody.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages; +/** Base class for all classes supported by ContactMessageBody */ public interface ContactMessageBody {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessage.java index e39c45e9..826b932f 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessage.java @@ -17,6 +17,7 @@ import com.sinch.sdk.domains.conversation.models.v1.ProcessingMode; import java.time.Instant; +/** Message originating from a Conversation */ public interface ConversationMessage { ConversationMessageBody getBody(); diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessageBody.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessageBody.java index fbe95989..04d1e34d 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessageBody.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/ConversationMessageBody.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages; +/** Base class for all classes supported by ConversationMessageBody */ public interface ConversationMessageBody {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/OmniMessageOverride.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/OmniMessageOverride.java index 48b0f99c..822b1248 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/OmniMessageOverride.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/OmniMessageOverride.java @@ -2,6 +2,7 @@ import com.sinch.sdk.domains.conversation.models.v1.ConversationChannel; +/** Base class for all classes supported by OmniMessageOverride */ public interface OmniMessageOverride { enum ChannelSpecificTemplate { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/package-info.java new file mode 100644 index 00000000..9fe9cd43 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/package-info.java @@ -0,0 +1,16 @@ +/** + * Conversation models for Messages + * + *

To start sending messages you must have a Conversation API app. + * + *

The app holds information about the channel credentials and registered webhooks to which the + * API delivers callbacks such as message delivery receipts and contact messages. + * + *

If you don't already have an app please follow the instructions in the getting started guide + * available in the Sinch Dashboard to create one.* + * + * @see Messages + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java index 405c4ab9..d51ebf2a 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/MessagesListRequest.java @@ -123,6 +123,7 @@ static Builder builder(MessagesListRequest parameters) { return new MessagesListRequestImpl.Builder(parameters); } + /** Dedicated Builder */ interface Builder { /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/package-info.java new file mode 100644 index 00000000..0b6fcd5e --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/request/package-info.java @@ -0,0 +1,8 @@ +/** + * Messages request models + * + * @see Messages + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/package-info.java new file mode 100644 index 00000000..f2f4e4bb --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/response/package-info.java @@ -0,0 +1,8 @@ +/** + * Messages response models + * + * @see Messages + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/call/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/call/package-info.java new file mode 100644 index 00000000..b21e04bb --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/call/package-info.java @@ -0,0 +1,6 @@ +/** + * Message for triggering a call models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.call; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/card/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/card/package-info.java new file mode 100644 index 00000000..07e33c21 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/card/package-info.java @@ -0,0 +1,6 @@ +/** + * Card message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.card; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/carousel/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/carousel/package-info.java new file mode 100644 index 00000000..e46f17ba --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/carousel/package-info.java @@ -0,0 +1,6 @@ +/** + * Carousel message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.carousel; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificContactMessageContent.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificContactMessageContent.java index 28875431..b40e0472 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificContactMessageContent.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificContactMessageContent.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages.types.channelspecific; +/** Base class for all classes supported by ChannelSpecificContactMessageContent */ public interface ChannelSpecificContactMessageContent {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificMessage.java index 2fcd8045..b18310bb 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/ChannelSpecificMessage.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages.types.channelspecific; +/** Base class for all classes supported by ChannelSpecificMessage */ public interface ChannelSpecificMessage {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/package-info.java new file mode 100644 index 00000000..2dd77043 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/package-info.java @@ -0,0 +1,6 @@ +/** + * Channel specific message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.channelspecific; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/WhatsAppInteractiveHeader.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/WhatsAppInteractiveHeader.java index 4c325672..4a350033 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/WhatsAppInteractiveHeader.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/WhatsAppInteractiveHeader.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages.types.channelspecific.whatsapp.flows; +/** Base class for all classes supported by WhatsAppInteractiveHeader */ public interface WhatsAppInteractiveHeader {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/package-info.java new file mode 100644 index 00000000..571e4bf1 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/flows/package-info.java @@ -0,0 +1,6 @@ +/** + * Whatsapp Flow channel specific message message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.channelspecific.whatsapp.flows; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/nfmreply/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/nfmreply/package-info.java new file mode 100644 index 00000000..25ee1f2a --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/channelspecific/whatsapp/nfmreply/package-info.java @@ -0,0 +1,6 @@ +/** + * WhatsApp Interactive Nfm Reply message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.channelspecific.whatsapp.nfmreply; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/Choice.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/Choice.java index a50d9113..ea09c9a3 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/Choice.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/Choice.java @@ -3,6 +3,11 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import com.sinch.sdk.domains.conversation.models.v1.messages.request.SendMessageRequest.Builder; +/** + * Base class for message containing choices/actions. + * + * @param Message body content type + */ @JsonDeserialize(using = ChoiceImpl.ChoiceDeserializer.class) public interface Choice { diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceCallMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceCallMessage.java index cab6cf37..6845c1a7 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceCallMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceCallMessage.java @@ -2,6 +2,7 @@ import com.sinch.sdk.domains.conversation.models.v1.messages.types.call.CallMessage; +/** Choice call message */ public interface ChoiceCallMessage extends Choice { /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceLocationMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceLocationMessage.java index 8cac9f79..55ec2af7 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceLocationMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceLocationMessage.java @@ -2,6 +2,7 @@ import com.sinch.sdk.domains.conversation.models.v1.messages.types.location.LocationMessage; +/** Choice location message */ public interface ChoiceLocationMessage extends Choice { /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceMessageType.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceMessageType.java index 145de3ba..d6c6a0a4 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceMessageType.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceMessageType.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages.types.choice; +/** Base class for message supporting ChoiceMessageType */ public interface ChoiceMessageType {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceTextMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceTextMessage.java index 524ef26e..ef387136 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceTextMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceTextMessage.java @@ -2,6 +2,7 @@ import com.sinch.sdk.domains.conversation.models.v1.messages.types.text.TextMessage; +/** Choice text message */ public interface ChoiceTextMessage extends Choice { /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceURLMessage.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceURLMessage.java index ab8d0857..5cdcc0d8 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceURLMessage.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/ChoiceURLMessage.java @@ -2,6 +2,7 @@ import com.sinch.sdk.domains.conversation.models.v1.messages.types.url.UrlMessage; +/** Choice URL message */ public interface ChoiceURLMessage extends Choice { /** diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/package-info.java new file mode 100644 index 00000000..8e063bfe --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choice/package-info.java @@ -0,0 +1,6 @@ +/** + * Choice message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.choice; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choiceresponse/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choiceresponse/package-info.java new file mode 100644 index 00000000..a209ffa2 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/choiceresponse/package-info.java @@ -0,0 +1,6 @@ +/** + * Choice response message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.choiceresponse; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/contactinfo/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/contactinfo/package-info.java new file mode 100644 index 00000000..b7a407b0 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/contactinfo/package-info.java @@ -0,0 +1,6 @@ +/** + * ContactInfo message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.contactinfo; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/fallback/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/fallback/package-info.java new file mode 100644 index 00000000..9c336d27 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/fallback/package-info.java @@ -0,0 +1,6 @@ +/** + * Fallback message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.fallback; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/ListItem.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/ListItem.java index ddcde2f8..33d27ce3 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/ListItem.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/ListItem.java @@ -1,3 +1,4 @@ package com.sinch.sdk.domains.conversation.models.v1.messages.types.list; +/** Base class for all classes supported by ListItem */ public interface ListItem {} diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/package-info.java new file mode 100644 index 00000000..76bc9f00 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/list/package-info.java @@ -0,0 +1,6 @@ +/** + * List message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.list; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/location/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/location/package-info.java new file mode 100644 index 00000000..72bd0e4c --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/location/package-info.java @@ -0,0 +1,6 @@ +/** + * Location message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.location; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/media/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/media/package-info.java new file mode 100644 index 00000000..35812d36 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/media/package-info.java @@ -0,0 +1,6 @@ +/** + * Media message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.media; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/mediacard/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/mediacard/package-info.java new file mode 100644 index 00000000..401ec8d9 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/mediacard/package-info.java @@ -0,0 +1,6 @@ +/** + * MediaCard message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.mediacard; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/package-info.java new file mode 100644 index 00000000..7ebfbc67 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/package-info.java @@ -0,0 +1,8 @@ +/** + * Messages types models + * + * @see Messages + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/productresponse/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/productresponse/package-info.java new file mode 100644 index 00000000..5bee8060 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/productresponse/package-info.java @@ -0,0 +1,6 @@ +/** + * ProductResponse message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.productresponse; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/template/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/template/package-info.java new file mode 100644 index 00000000..9100b54d --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/template/package-info.java @@ -0,0 +1,6 @@ +/** + * Template message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.template; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/text/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/text/package-info.java new file mode 100644 index 00000000..347412bc --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/text/package-info.java @@ -0,0 +1,6 @@ +/** + * Text message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.text; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/url/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/url/package-info.java new file mode 100644 index 00000000..f00b11f3 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/messages/types/url/package-info.java @@ -0,0 +1,6 @@ +/** + * URL message models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.messages.types.url; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/package-info.java new file mode 100644 index 00000000..11cbeb34 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/package-info.java @@ -0,0 +1,7 @@ +/** + * Conversation models for V1 endpoints + * + * @see Conversation + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/request/package-info.java new file mode 100644 index 00000000..79a31223 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/request/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation requests models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/package-info.java new file mode 100644 index 00000000..0b9de13c --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/package-info.java @@ -0,0 +1,8 @@ +/** + * Conversation models for Transcoding + * + * @see Transcoding + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.transcoding; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/request/package-info.java new file mode 100644 index 00000000..180f59b1 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/request/package-info.java @@ -0,0 +1,8 @@ +/** + * Transcoding request models + * + * @see Transcoding + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.transcoding.request; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/response/package-info.java new file mode 100644 index 00000000..32ad6f3c --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/transcoding/response/package-info.java @@ -0,0 +1,8 @@ +/** + * Transcoding response models + * + * @see Transcoding + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.transcoding.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/capability/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/capability/package-info.java new file mode 100644 index 00000000..b73fc977 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/capability/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for CAPABILITY sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.capability; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/channel/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/channel/package-info.java new file mode 100644 index 00000000..7bb21bdc --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/channel/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for CHANNEL sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.channel; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/contact/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/contact/package-info.java new file mode 100644 index 00000000..087762c4 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/contact/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for CONTACT sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.contact; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/conversation/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/conversation/package-info.java new file mode 100644 index 00000000..1c56a70b --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/conversation/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for CONVERSATION sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.conversation; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/delivery/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/delivery/package-info.java new file mode 100644 index 00000000..ed711b16 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/delivery/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for DELIVERY sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.delivery; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/inbound/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/inbound/package-info.java new file mode 100644 index 00000000..d54fb673 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/inbound/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for INBOUND sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.inbound; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/message/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/message/package-info.java new file mode 100644 index 00000000..845ea3c1 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/message/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for MESSAGE sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.message; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/opting/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/opting/package-info.java new file mode 100644 index 00000000..e274fcd7 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/opting/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for OPT-IN/OPT-OUT sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.opting; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/package-info.java new file mode 100644 index 00000000..922556e3 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/package-info.java @@ -0,0 +1,7 @@ +/** + * Conversation models for webhooks events sent onto callbacks + * + * @see callbacks + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/record/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/record/package-info.java new file mode 100644 index 00000000..6ce385f0 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/record/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for RECORD sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.record; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/smartconversations/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/smartconversations/package-info.java new file mode 100644 index 00000000..fb4096b6 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/smartconversations/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for SMART CONVERSATIONS sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.smartconversations; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/unsupported/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/unsupported/package-info.java new file mode 100644 index 00000000..93d2d2dc --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/events/unsupported/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation models for UNSUPPORTED sent onto callbacks + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.events.unsupported; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/package-info.java new file mode 100644 index 00000000..4af029bb --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/package-info.java @@ -0,0 +1,8 @@ +/** + * Conversation models for Webhooks + * + * @see Webhooks + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/response/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/response/package-info.java new file mode 100644 index 00000000..07802ac4 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/webhooks/response/package-info.java @@ -0,0 +1,8 @@ +/** + * Webhooks response models + * + * @see Webhooks + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.models.v1.webhooks.response; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/package-info.java index 2d7f0cac..60420a5e 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/package-info.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/package-info.java @@ -1,8 +1,9 @@ /** * Conversation API interface - *

- * The Sinch Conversation API allows you to send and receive messages globally over SMS, RCS, - * WhatsApp, Viber Business, Facebook Messenger and other popular channels. + * + *

The Sinch Conversation API allows you to send and receive messages globally over SMS, RCS, + * WhatsApp, Viber Business, Facebook Messenger and other popular channels. + * * @see https://developers.sinch.com/docs/conversation * @since 1.3 diff --git a/client/src/main/com/sinch/sdk/domains/conversation/templates/models/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/package-info.java new file mode 100644 index 00000000..d56271b4 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/package-info.java @@ -0,0 +1,9 @@ +/** + * Conversation models for templates + * + * @see Templates + * V1 + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.templates.models; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v1/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v1/package-info.java new file mode 100644 index 00000000..1b8581aa --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v1/package-info.java @@ -0,0 +1,9 @@ +/** + * Conversation models for templates V1 + * + * @see Templates + * V1 + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.templates.models.v1; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/package-info.java new file mode 100644 index 00000000..e396e14e --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/package-info.java @@ -0,0 +1,9 @@ +/** + * Conversation models for templates V2 + * + * @see Templates + * V2 + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.templates.models.v2; diff --git a/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/package-info.java b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/package-info.java new file mode 100644 index 00000000..e47f05d5 --- /dev/null +++ b/client/src/main/com/sinch/sdk/domains/conversation/templates/models/v2/request/package-info.java @@ -0,0 +1,6 @@ +/** + * Conversation Templates V2 request models + * + * @since 1.3 + */ +package com.sinch.sdk.domains.conversation.templates.models.v2.request; diff --git a/openapi-contracts/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentials.java b/openapi-contracts/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentials.java index 76843c00..d6d63b80 100644 --- a/openapi-contracts/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentials.java +++ b/openapi-contracts/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentials.java @@ -13,7 +13,16 @@ import com.fasterxml.jackson.databind.annotation.JsonDeserialize; import com.sinch.sdk.domains.conversation.models.v1.ConversationChannel; -/** Enables access to the underlying messaging channel. */ +/** + * Enables access to the underlying messaging channel. + * + *

Use the {@link + * com.sinch.sdk.domains.conversation.models.v1.credentials.ConversationChannelCredentialsBuilderFactory} + * factory builder helper to create credentials related to channel + * + * @see + * com.sinch.sdk.domains.conversation.models.v1.credentials.ConversationChannelCredentialsBuilderFactory + */ @JsonDeserialize(builder = ConversationChannelCredentialsImpl.Builder.class) public interface ConversationChannelCredentials { diff --git a/pom.xml b/pom.xml index e3b83124..ca227c4b 100644 --- a/pom.xml +++ b/pom.xml @@ -150,6 +150,7 @@ **/AbstractOpenApiSchema.java **/*Impl.java **/BuildersDelegation.java + **/*Mapper.java com/sinch/sdk/domains/verification/models/*.java com/sinch/sdk/domains/verification/VerificationsService.java From fa1c32378ba280b407d6f75fd7b33a93ea661ac7 Mon Sep 17 00:00:00 2001 From: Jean-Pierre Portier Date: Thu, 26 Sep 2024 14:03:30 +0200 Subject: [PATCH 4/4] PR's comments --- .../conversation/api/v1/MessagesService.java | 37 +++++++--- ...ationChannelCredentialsBuilderFactory.java | 70 +++++++++++-------- 2 files changed, 68 insertions(+), 39 deletions(-) diff --git a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java index d9832fe3..b90e197e 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/api/v1/MessagesService.java @@ -43,8 +43,8 @@ public interface MessagesService { * *

You can find all of your IDs and authentication credentials on the Sinch Customer Dashboard. * - * @return Response related to messages sent (from {@link - * com.sinch.sdk.domains.conversation.models.v1.messages.response.SendMessageResponse}) + * @param request Request parameters + * @return Response related to sent message * @since 1.3 */ SendMessageResponse sendMessage(SendMessageRequest request); @@ -53,8 +53,9 @@ public interface MessagesService { * Send a card message * * @param request CardMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendCardMessage(SendMessageRequest request); @@ -62,8 +63,9 @@ public interface MessagesService { * Send a carousel message * * @param request CarouselMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendCarouselMessage(SendMessageRequest request); @@ -71,8 +73,9 @@ public interface MessagesService { * Send a choice message * * @param request ChoiceMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendChoiceMessage(SendMessageRequest request); @@ -80,8 +83,9 @@ public interface MessagesService { * Send a contact info message * * @param request ContactInfoMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendContactInfoMessage(SendMessageRequest request); @@ -89,8 +93,9 @@ public interface MessagesService { * Send a list message * * @param request ListMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendListMessage(SendMessageRequest request); @@ -98,8 +103,9 @@ public interface MessagesService { * Send a location message * * @param request LocationMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendLocationMessage(SendMessageRequest request); @@ -107,8 +113,9 @@ public interface MessagesService { * Send a media message * * @param request MediaMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendMediaMessage(SendMessageRequest request); @@ -116,8 +123,9 @@ public interface MessagesService { * Send a template message * * @param request TemplateMessage request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendTemplateMessage(SendMessageRequest request); @@ -125,8 +133,9 @@ public interface MessagesService { * Send a send message request message * * @param request request - * @return Response + * @return Response related to sent message * @see #sendMessage(SendMessageRequest) + * @since 1.3 */ SendMessageResponse sendTextMessage(SendMessageRequest request); @@ -136,6 +145,7 @@ public interface MessagesService { * @see #get(String, MessageSource) * @param messageId The unique ID of the message. * @return Conversation message + * @since 1.3 */ ConversationMessage get(String messageId); @@ -148,6 +158,7 @@ public interface MessagesService { * href="https://developers.sinch.com/docs/conversation/processing-modes">Processing Modes * @default CONVERSATION_SOURCE * @return Conversation message + * @since 1.3 */ ConversationMessage get(String messageId, MessageSource messageSource); @@ -178,6 +189,7 @@ public interface MessagesService { * * @see #delete(String, MessageSource) * @param messageId The unique ID of the message. + * @since 1.3 */ void delete(String messageId); @@ -191,6 +203,7 @@ public interface MessagesService { * for operations on messages in Dispatch Mode. For more information, see Processing Modes * @default CONVERSATION_SOURCE + * @since 1.3 */ void delete(String messageId, MessageSource messageSource); @@ -201,6 +214,7 @@ public interface MessagesService { * @param messageId The unique ID of the message. * @param request Request parameters to be used for updating * @return Updated message + * @since 1.3 */ ConversationMessage update(String messageId, MessageUpdateRequest request); @@ -214,6 +228,7 @@ public interface MessagesService { * @default CONVERSATION_SOURCE * @param request Request parameters to be used for updating * @return Updated message + * @since 1.3 */ ConversationMessage update( String messageId, MessageSource messageSource, MessageUpdateRequest request); diff --git a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java index 1edce6c9..062bf842 100644 --- a/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java +++ b/client/src/main/com/sinch/sdk/domains/conversation/models/v1/credentials/ConversationChannelCredentialsBuilderFactory.java @@ -11,8 +11,9 @@ private ConversationChannelCredentialsBuilderFactory() {} * Create dedicated conversation credential builder for {@link ConversationChannel#APPLEBC} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder appleBc( AppleBusinessChatCredentials credentials) { @@ -25,8 +26,9 @@ public static ConversationChannelCredentials.Builder appleBc( * Create dedicated conversation credential builder for{@link ConversationChannel#INSTAGRAM} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder instagram(InstagramCredentials credentials) { return ConversationChannelCredentials.builder() @@ -38,8 +40,9 @@ public static ConversationChannelCredentials.Builder instagram(InstagramCredenti * Create dedicated conversation credential builder for{@link ConversationChannel#KAKAOTALK} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder kakaoTalk(KakaoTalkCredentials credentials) { return ConversationChannelCredentials.builder() @@ -51,8 +54,9 @@ public static ConversationChannelCredentials.Builder kakaoTalk(KakaoTalkCredenti * Create dedicated conversation credential builder for * {@link ConversationChannel#KAKAOTALKCHAT} channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder kakaoTalkChat( KakaoTalkChatCredentials credentials) { @@ -65,8 +69,9 @@ public static ConversationChannelCredentials.Builder kakaoTalkChat( * Create dedicated conversation credential builder for{@link ConversationChannel#LINE} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder line(LineCredentials credentials) { return ConversationChannelCredentials.builder() @@ -78,8 +83,9 @@ public static ConversationChannelCredentials.Builder line(LineCredentials creden * Create dedicated conversation credential builder for{@link ConversationChannel#MESSENGER} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder messenger( StaticTokenCredentials credentials) { @@ -92,8 +98,9 @@ public static ConversationChannelCredentials.Builder messenger( * Create dedicated conversation credential builder for{@link ConversationChannel#MMS} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder mms(MMSCredentials credentials) { return ConversationChannelCredentials.builder() @@ -105,8 +112,9 @@ public static ConversationChannelCredentials.Builder mms(MMSCredentials credenti * Create dedicated conversation credential builder for{@link ConversationChannel#RCS} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder rcs(StaticBearerCredentials credentials) { return ConversationChannelCredentials.builder() @@ -118,8 +126,9 @@ public static ConversationChannelCredentials.Builder rcs(StaticBearerCredentials * Create dedicated conversation credential builder for{@link ConversationChannel#SMS} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder sms(StaticBearerCredentials credentials) { return ConversationChannelCredentials.builder() @@ -131,8 +140,9 @@ public static ConversationChannelCredentials.Builder sms(StaticBearerCredentials * Create dedicated conversation credential builder for{@link ConversationChannel#TELEGRAM} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder telegram(TelegramCredentials credentials) { return ConversationChannelCredentials.builder() @@ -144,8 +154,9 @@ public static ConversationChannelCredentials.Builder telegram(TelegramCredential * Create dedicated conversation credential builder for{@link ConversationChannel#VIBER} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder viber(StaticTokenCredentials credentials) { return ConversationChannelCredentials.builder() @@ -157,8 +168,9 @@ public static ConversationChannelCredentials.Builder viber(StaticTokenCredential * Create dedicated conversation credential builder for{@link ConversationChannel#VIBERBM} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder viberBm( StaticBearerCredentials credentials) { @@ -171,8 +183,9 @@ public static ConversationChannelCredentials.Builder viberBm( * Create dedicated conversation credential builder for{@link ConversationChannel#WECHAT} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder weChat(WeChatCredentials credentials) { return ConversationChannelCredentials.builder() @@ -184,8 +197,9 @@ public static ConversationChannelCredentials.Builder weChat(WeChatCredentials cr * Create dedicated conversation credential builder for{@link ConversationChannel#WHATSAPP} * channel * - * @param credentials Credentials - * @return Credentials builder + * @param credentials Credentials parameters to be used to init builder + * @return Conversation channel credentials builder filled with input parameters + * @since 1.3 */ public static ConversationChannelCredentials.Builder whatsApp( StaticBearerCredentials credentials) {