DEVEXP-375: Enhance DX for ttl field in SendMessageRequest

examples/simple-examples/src/conversation/messages/send.ts

@@ -24,6 +24,7 @@ import { getAppIdFromConfig, getContactIdFromConfig, initConversationService, pr
       queue: 'HIGH_PRIORITY',
       processing_strategy: 'DEFAULT',
       channel_priority_order: ['MESSENGER'],
+      ttl_seconds: 60,
     },
   };
 

examples/webhooks/src/services/conversation-event.service.ts

@@ -61,7 +61,7 @@ export class ConversationEventService {
               contact_id: message.contact_id!,
             },
             message: this.buildContactMessage(contactMessage),
-            ttl: '5s',
+            ttl_seconds: 5,
             channel_properties: {
               MESSENGER_NOTIFICATION_TYPE: 'NO_PUSH',
             }

packages/conversation/src/models/v1/send-message-request/send-message-request.ts

@@ -36,7 +36,7 @@ export interface SendMessageRequestBase<T extends Recipient> {
   /** @see Recipient */
   recipient: T;
   /** The timeout allotted for sending the message, expressed in seconds. Passed to channels which support it and emulated by the Conversation API for channels without ttl support but with message retract/unsend functionality. Channel failover will not be performed for messages with an expired TTL. The format is an integer with the suffix `s` (for seconds). Valid integer range is 3 to 315,576,000,000 (inclusive). Example values include `10s` (10 seconds) and `86400s` (24 hours). */
-  ttl?: string;
+  ttl_seconds?: number;
   /** Overrides the app\'s [Processing Mode](../../../../../conversation/processing-modes/). Default value is `DEFAULT`. */
   processing_strategy?: ProcessingStrategy;
   /** An arbitrary identifier that will be propagated to callbacks related to this message, including MO replies. Only applicable to messages sent with the `CONVERSATION` processing mode. Up to 128 characters long. */

packages/conversation/src/rest/v1/messages/messages-api.ts

@@ -361,6 +361,12 @@ export class MessagesApi extends ConversationDomainApi {
       'Accept': 'application/json',
     };
 
+    // Special fields handling: ttl_seconds: number => ttl: string
+    if (data.sendMessageRequestBody.ttl_seconds !== undefined) {
+      (data as any).sendMessageRequestBody.ttl = data.sendMessageRequestBody.ttl_seconds + 's';
+      delete data.sendMessageRequestBody.ttl_seconds;
+    }
+
     const body: RequestBody = data['sendMessageRequestBody']
       ? JSON.stringify(data['sendMessageRequestBody'])
       : '{}';

packages/conversation/tests/rest/v1/messages/messages-api.test.ts

@@ -191,6 +191,7 @@ describe('MessagesApi', () => {
       message: {
         ...messageBuilder.text(textMessageItem),
       },
+      ttl_seconds: 20,
     };
     const requestDataWithContactId: SendMessageRequestData<ContactId> = {
       sendMessageRequestBody: {