DEVEXP-1147-1157: (Conversation) OAS sync - Week 49 & 50 (#220)

Author: asein-sinch

packages/conversation/src/models/v1/calendar-message/calendar-message.ts

@@ -0,0 +1,14 @@
+export interface CalendarMessage {
+  /** The title is shown close to the button that leads to open a user calendar. */
+  title: string;
+  /** The timestamp defines start of a calendar event. */
+  event_start: Date;
+  /** The timestamp defines end of a calendar event. */
+  event_end: Date;
+  /** Title of a calendar event. */
+  event_title: string;
+  /** Description of a calendar event. */
+  event_description?: string;
+  /** The URL that is opened when the user cannot open a calendar event directly or channel does not have support for this type. */
+  fallback_url: string;
+}

packages/conversation/src/models/v1/calendar-message/index.ts

@@ -0,0 +1 @@
+export type { CalendarMessage } from './calendar-message';

packages/conversation/src/models/v1/channel-specific-message/channel-specific-message.ts

@@ -1,8 +1,8 @@
 import { WhatsAppFlow } from '../whatsapp-flow';
 import { WhatsAppPaymentOrderDetails } from '../whatsapp-payment-order-details';
 import { WhatsAppPaymentOrderStatus } from '../whatsapp-payment-order-status';
-import { KakaoTalkCommerceMessageContent } from '../kakaotalk-commerce-message-content';
-import { KakaoTalkCarouselCommerceMessageContent } from '../kakaotalk-carousel-commerce-message-content';
+import { KakaoTalkCommerce } from '../kakaotalk-commerce';
+import { KakaoTalkCarouselCommerce } from '../kakaotalk-carousel-commerce';
 
 /**
  * A message containing a channel specific message (not supported by OMNI types).
@@ -37,13 +37,13 @@ export interface WhatsAppPaymentOrderStatusMessage {
 export interface KakaoTalkCommerceMessage {
   /** The type of the channel specific message. */
   message_type: 'COMMERCE';
-  /** @see KakaoTalkCommerceMessageContent */
-  message: KakaoTalkCommerceMessageContent;
+  /** @see KakaoTalkCommerce */
+  message: KakaoTalkCommerce;
 }
 
 export interface KakaoTalkCarouselCommerceMessage {
   /** The type of the channel specific message. */
   message_type: 'CAROUSEL_COMMERCE';
-  /** @see KakaoTalkCarouselCommerceMessageContent */
-  message: KakaoTalkCarouselCommerceMessageContent;
+  /** @see KakaoTalkCarouselCommerce */
+  message: KakaoTalkCarouselCommerce;
 }

packages/conversation/src/models/v1/choice/choice.ts

@@ -2,6 +2,8 @@ import { CallMessage } from '../call-message';
 import { LocationMessageItem } from '../location-message';
 import { TextMessageItem } from '../text-message';
 import { UrlMessage } from '../url-message';
+import { CalendarMessage } from '../calendar-message';
+import { ShareLocationMessage } from '../share-location-message';
 
 /**
  * A choice is an action the user can take such as buttons for quick replies or other call to actions.
@@ -10,45 +12,95 @@ export type Choice =
   CallMessageChoice
   | LocationMessageChoice
   | TextMessageChoice
-  | UrlMessageChoice;
+  | UrlMessageChoice
+  | CalendarMessageChoice
+  | ShareLocationMessageChoice;
 
 export interface ChoiceBase {
   /** An optional field. This data will be returned in the ChoiceResponseMessage. The default is message_id_{text, title}. */
   postback_data?: string;
 }
 
+/**
+ * Message for triggering a call.
+ */
 export interface CallMessageChoice extends ChoiceBase {
   /** @see CallMessage */
   call_message: CallMessage;
   // Exclude other choice types
   location_message?: never;
   text_message?: never;
   url_message?: never;
+  calendar_message?: never;
+  share_location_message?: never;
 }
 
+/**
+ * Message containing geographic location.
+ */
 export interface LocationMessageChoice extends ChoiceBase {
   /** @see LocationMessageItem */
   location_message: LocationMessageItem;
   // Exclude other choice types
   call_message?: never;
   text_message?: never;
   url_message?: never;
+  calendar_message?: never;
+  share_location_message?: never;
 }
 
+/**
+ * A message containing only text.
+ */
 export interface TextMessageChoice extends ChoiceBase {
   /** @see TextMessageItem */
   text_message: TextMessageItem;
   // Exclude other choice types
   call_message?: never;
   location_message?: never;
   url_message?: never;
+  calendar_message?: never;
+  share_location_message?: never;
 }
 
+/**
+ * A generic URL message.
+ */
 export interface UrlMessageChoice extends ChoiceBase {
   /** @see UrlMessage */
   url_message: UrlMessage;
   // Exclude other choice types
   call_message?: never;
   location_message?: never;
   text_message?: never;
+  calendar_message?: never;
+  share_location_message?: never;
+}
+
+/**
+ * Message containing details about a calendar event.
+ */
+export interface CalendarMessageChoice extends ChoiceBase {
+  /** @see CalendarMessage */
+  calendar_message?: CalendarMessage;
+  // Exclude other choice types
+  call_message?: never;
+  location_message?: never;
+  text_message?: never;
+  url_message?: never;
+  share_location_message?: never;
+}
+
+/**
+ * Message requesting location from a user.
+ */
+export interface ShareLocationMessageChoice extends ChoiceBase {
+  /** @see ShareLocationMessage */
+  share_location_message?: ShareLocationMessage;
+  // Exclude other choice types
+  call_message?: never;
+  location_message?: never;
+  text_message?: never;
+  url_message?: never;
+  calendar_message?: never;
 }

packages/conversation/src/models/v1/index.ts

@@ -8,6 +8,7 @@ export * from './app-response';
 export * from './app-update-request';
 export * from './audit-record';
 export * from './audit-records-list';
+export * from './calendar-message';
 export * from './call-message';
 export * from './callback-settings';
 export * from './card-message';
@@ -60,11 +61,12 @@ export * from './inject-event-response';
 export * from './inject-message-request';
 export * from './kakaotalk-button';
 export * from './kakaotalk-carousel';
-export * from './kakaotalk-carousel-commerce-message-content';
+export * from './kakaotalk-carousel-commerce';
 export * from './kakaotalk-commerce';
-export * from './kakaotalk-commerce-message-content';
 export * from './kakaotalk-coupon';
 export * from './kakaotalk-image';
+export * from './kakaotalk-message';
+export * from './kakaotalk-pricing';
 export * from './list-apps-response';
 export * from './list-message';
 export * from './list-section';
@@ -91,6 +93,7 @@ export * from './send-event-request';
 export * from './send-event-response';
 export * from './send-message-request';
 export * from './send-message-response';
+export * from './share-location-message';
 export * from './smart-conversation';
 export * from './template-message';
 export * from './template-reference';

packages/conversation/src/models/v1/kakaotalk-carousel-commerce-message-content/index.ts

@@ -0,0 +1 @@
+export type { KakaoTalkCarouselCommerce } from './kakaotalk-carousel-commerce';

packages/conversation/src/models/v1/kakaotalk-carousel-commerce/index.ts

@@ -3,7 +3,7 @@ import { KakaoTalkCarousel } from '../kakaotalk-carousel';
 /**
  * Carousel content
  */
-export interface KakaoTalkCarouselCommerceMessageContent {
+export interface KakaoTalkCarouselCommerce {
   /** Set to `true` if a push alarm should be sent to a device. */
   push_alarm?: boolean;
   /** Set to `true` if a message contains adult content. Set to `false` by default. */

…alk-carousel-commerce-message-content.ts …-commerce/kakaotalk-carousel-commerce.tspackages/conversation/src/models/v1/kakaotalk-carousel-commerce-message-content/kakaotalk-carousel-commerce-message-content.ts renamed to packages/conversation/src/models/v1/kakaotalk-carousel-commerce/kakaotalk-carousel-commerce.ts packages/conversation/src/models/v1/kakaotalk-carousel-commerce-message-content/kakaotalk-carousel-commerce-message-content.ts renamed to packages/conversation/src/models/v1/kakaotalk-carousel-commerce/kakaotalk-carousel-commerce.ts

@@ -1,6 +1,5 @@
 export type {
   KakaoTalkCarousel,
   KakaoTalkCarouselHead,
-  KakaoTalkCarouselList,
   KakaoTalkCarouselTail,
 } from './kakaotalk-carousel';

packages/conversation/src/models/v1/kakaotalk-carousel/index.ts

@@ -1,6 +1,4 @@
-import { KakaoTalkCommerce } from '../kakaotalk-commerce';
-import { KakaoTalkButton } from '../kakaotalk-button';
-import { KakaoTalkCoupon } from '../kakaotalk-coupon';
+import { KakaoTalkMessage } from '../kakaotalk-message';
 
 /**
  * Carousel content
@@ -9,7 +7,7 @@ export interface KakaoTalkCarousel {
   /** Carousel introduction */
   head?: KakaoTalkCarouselHead;
   /** List of carousel cards */
-  list: KakaoTalkCarouselList[];
+  list: KakaoTalkMessage[];
   /** "More" button */
   tail?: KakaoTalkCarouselTail;
 }
@@ -41,18 +39,3 @@ export interface KakaoTalkCarouselTail {
   /** App link opened on an Android device (e.g. `tel://PHONE_NUMBER`) */
   scheme_android?: string;
 }
-
-export interface KakaoTalkCarouselList {
-  /** Additional information */
-  additional_content?: string;
-  /** URL to the product image */
-  image_url: string;
-  /** URL opened when a user clicks on the image */
-  image_link?: string;
-  /** Product information */
-  commerce?: KakaoTalkCommerce;
-  /** Buttons list */
-  buttons: KakaoTalkButton[];
-  /** Discount coupon */
-  coupon?: KakaoTalkCoupon;
-}