@sinch/conversation 1.2.1 → 1.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (376) hide show
  1. package/dist/models/v1/app-message/app-message.d.ts +10 -7
  2. package/dist/models/v1/audit-record/audit-record.d.ts +18 -0
  3. package/dist/models/v1/audit-record/audit-record.js +3 -0
  4. package/dist/models/v1/audit-record/audit-record.js.map +1 -0
  5. package/dist/models/v1/audit-record/index.d.ts +1 -0
  6. package/dist/models/v1/audit-record/index.js.map +1 -0
  7. package/dist/models/v1/audit-records-list/audit-records-list.d.ts +8 -0
  8. package/dist/models/v1/audit-records-list/audit-records-list.js +3 -0
  9. package/dist/models/v1/audit-records-list/audit-records-list.js.map +1 -0
  10. package/dist/models/v1/audit-records-list/index.d.ts +1 -0
  11. package/dist/models/v1/audit-records-list/index.js.map +1 -0
  12. package/dist/models/v1/calendar-message/calendar-message.d.ts +14 -0
  13. package/dist/models/v1/calendar-message/calendar-message.js +3 -0
  14. package/dist/models/v1/calendar-message/calendar-message.js.map +1 -0
  15. package/dist/models/v1/calendar-message/index.d.ts +1 -0
  16. package/dist/models/v1/calendar-message/index.js.map +1 -0
  17. package/dist/models/v1/callback-settings/callback-settings.d.ts +1 -1
  18. package/dist/models/v1/card-message/card-message.d.ts +13 -4
  19. package/dist/models/v1/card-message/index.d.ts +1 -1
  20. package/dist/models/v1/carousel-message/carousel-message.d.ts +5 -2
  21. package/dist/models/v1/channel-identity/channel-identity.d.ts +1 -1
  22. package/dist/models/v1/channel-specific-contact-message/channel-specific-contact-message.d.ts +1 -1
  23. package/dist/models/v1/channel-specific-message/channel-specific-message.d.ts +40 -5
  24. package/dist/models/v1/channel-specific-message/index.d.ts +1 -1
  25. package/dist/models/v1/choice/choice.d.ts +47 -1
  26. package/dist/models/v1/choice-item/choice-item.d.ts +3 -3
  27. package/dist/models/v1/choice-message/choice-message.d.ts +8 -2
  28. package/dist/models/v1/client-credentials/client-credentials.d.ts +6 -0
  29. package/dist/models/v1/consent-identity/consent-identity.d.ts +7 -0
  30. package/dist/models/v1/consent-identity/consent-identity.js +3 -0
  31. package/dist/models/v1/consent-identity/consent-identity.js.map +1 -0
  32. package/dist/models/v1/consent-identity/index.d.ts +1 -0
  33. package/dist/models/v1/consent-identity/index.js.map +1 -0
  34. package/dist/models/v1/contact-create-request/contact-create-request.d.ts +1 -1
  35. package/dist/models/v1/contact-message/contact-message.d.ts +4 -4
  36. package/dist/models/v1/contact-message-event/contact-message-event.d.ts +47 -2
  37. package/dist/models/v1/contact-message-event/index.d.ts +1 -1
  38. package/dist/models/v1/contact-settings/contact-settings.d.ts +7 -0
  39. package/dist/models/v1/contact-settings/contact-settings.js +3 -0
  40. package/dist/models/v1/contact-settings/contact-settings.js.map +1 -0
  41. package/dist/models/v1/contact-settings/index.d.ts +1 -0
  42. package/dist/models/v1/contact-settings/index.js.map +1 -0
  43. package/dist/models/v1/conversation-channel/conversation-channel.d.ts +2 -2
  44. package/dist/models/v1/conversation-channel-credential/conversation-channel-credential.d.ts +18 -5
  45. package/dist/models/v1/conversation-channel-credential/index.d.ts +1 -1
  46. package/dist/models/v1/conversation-event/conversation-event.d.ts +1 -1
  47. package/dist/models/v1/conversation-message/conversation-message.d.ts +2 -2
  48. package/dist/models/v1/create-conversation-request/create-conversation-request.d.ts +7 -1
  49. package/dist/models/v1/delivery-report-based-fallback/delivery-report-based-fallback.d.ts +1 -1
  50. package/dist/models/v1/dispatch-retention-policy/dispatch-retention-policy.d.ts +2 -2
  51. package/dist/models/v1/enums.d.ts +29 -14
  52. package/dist/models/v1/helper.d.ts +5 -5
  53. package/dist/models/v1/helper.js.map +1 -1
  54. package/dist/models/v1/identified-by/identified-by.d.ts +4 -2
  55. package/dist/models/v1/identified-by/index.d.ts +1 -1
  56. package/dist/models/v1/identity-conflict/identity-conflict.d.ts +8 -0
  57. package/dist/models/v1/identity-conflict/identity-conflict.js +3 -0
  58. package/dist/models/v1/identity-conflict/identity-conflict.js.map +1 -0
  59. package/dist/models/v1/identity-conflict/index.d.ts +1 -0
  60. package/dist/models/v1/identity-conflict/index.js.map +1 -0
  61. package/dist/models/v1/index.d.ts +29 -12
  62. package/dist/models/v1/index.js +29 -12
  63. package/dist/models/v1/index.js.map +1 -1
  64. package/dist/models/v1/inject-conversation-event-request/inject-conversation-event-request.d.ts +1 -1
  65. package/dist/models/v1/inject-message-request/inject-message-request.d.ts +5 -7
  66. package/dist/models/v1/kakaotalk-button/index.d.ts +1 -0
  67. package/dist/models/v1/kakaotalk-button/index.js.map +1 -0
  68. package/dist/models/v1/kakaotalk-button/kakaotalk-button.d.ts +27 -0
  69. package/dist/models/v1/kakaotalk-button/kakaotalk-button.js +3 -0
  70. package/dist/models/v1/kakaotalk-button/kakaotalk-button.js.map +1 -0
  71. package/dist/models/v1/kakaotalk-carousel/index.d.ts +1 -0
  72. package/dist/models/v1/kakaotalk-carousel/index.js.map +1 -0
  73. package/dist/models/v1/kakaotalk-carousel/kakaotalk-carousel.d.ts +38 -0
  74. package/dist/models/v1/kakaotalk-carousel/kakaotalk-carousel.js +3 -0
  75. package/dist/models/v1/kakaotalk-carousel/kakaotalk-carousel.js.map +1 -0
  76. package/dist/models/v1/kakaotalk-carousel-commerce/index.d.ts +1 -0
  77. package/dist/models/v1/kakaotalk-carousel-commerce/index.js.map +1 -0
  78. package/dist/models/v1/kakaotalk-carousel-commerce/kakaotalk-carousel-commerce.d.ts +12 -0
  79. package/dist/models/v1/kakaotalk-carousel-commerce/kakaotalk-carousel-commerce.js +3 -0
  80. package/dist/models/v1/kakaotalk-carousel-commerce/kakaotalk-carousel-commerce.js.map +1 -0
  81. package/dist/models/v1/kakaotalk-commerce/index.d.ts +1 -0
  82. package/dist/models/v1/kakaotalk-commerce/index.js +3 -0
  83. package/dist/models/v1/kakaotalk-commerce/index.js.map +1 -0
  84. package/dist/models/v1/kakaotalk-commerce/kakaotalk-commerce.d.ts +7 -0
  85. package/dist/models/v1/kakaotalk-commerce/kakaotalk-commerce.js +3 -0
  86. package/dist/models/v1/kakaotalk-commerce/kakaotalk-commerce.js.map +1 -0
  87. package/dist/models/v1/kakaotalk-coupon/index.d.ts +1 -0
  88. package/dist/models/v1/kakaotalk-coupon/index.js +3 -0
  89. package/dist/models/v1/kakaotalk-coupon/index.js.map +1 -0
  90. package/dist/models/v1/kakaotalk-coupon/kakaotalk-coupon.d.ts +79 -0
  91. package/dist/models/v1/kakaotalk-coupon/kakaotalk-coupon.js +3 -0
  92. package/dist/models/v1/kakaotalk-coupon/kakaotalk-coupon.js.map +1 -0
  93. package/dist/models/v1/kakaotalk-image/index.d.ts +1 -0
  94. package/dist/models/v1/kakaotalk-image/index.js +3 -0
  95. package/dist/models/v1/kakaotalk-image/index.js.map +1 -0
  96. package/dist/models/v1/kakaotalk-image/kakaotalk-image.d.ts +6 -0
  97. package/dist/models/v1/kakaotalk-image/kakaotalk-image.js +3 -0
  98. package/dist/models/v1/kakaotalk-image/kakaotalk-image.js.map +1 -0
  99. package/dist/models/v1/kakaotalk-message/index.d.ts +1 -0
  100. package/dist/models/v1/kakaotalk-message/index.js +3 -0
  101. package/dist/models/v1/kakaotalk-message/index.js.map +1 -0
  102. package/dist/models/v1/kakaotalk-message/kakaotalk-message.d.ts +16 -0
  103. package/dist/models/v1/kakaotalk-message/kakaotalk-message.js +3 -0
  104. package/dist/models/v1/kakaotalk-message/kakaotalk-message.js.map +1 -0
  105. package/dist/models/v1/kakaotalk-pricing/index.d.ts +1 -0
  106. package/dist/models/v1/kakaotalk-pricing/index.js +3 -0
  107. package/dist/models/v1/kakaotalk-pricing/index.js.map +1 -0
  108. package/dist/models/v1/kakaotalk-pricing/kakao-talk-pricing.d.ts +33 -0
  109. package/dist/models/v1/kakaotalk-pricing/kakao-talk-pricing.js +3 -0
  110. package/dist/models/v1/kakaotalk-pricing/kakao-talk-pricing.js.map +1 -0
  111. package/dist/models/v1/line-notification-template/index.d.ts +1 -0
  112. package/dist/models/v1/line-notification-template/index.js +3 -0
  113. package/dist/models/v1/line-notification-template/index.js.map +1 -0
  114. package/dist/models/v1/line-notification-template/line-notification-template.d.ts +10 -0
  115. package/dist/models/v1/line-notification-template/line-notification-template.js +3 -0
  116. package/dist/models/v1/line-notification-template/line-notification-template.js.map +1 -0
  117. package/dist/models/v1/line-notification-template-body/index.d.ts +1 -0
  118. package/dist/models/v1/line-notification-template-body/index.js +3 -0
  119. package/dist/models/v1/line-notification-template-body/index.js.map +1 -0
  120. package/dist/models/v1/line-notification-template-body/line-notification-template-body.d.ts +13 -0
  121. package/dist/models/v1/line-notification-template-body/line-notification-template-body.js +3 -0
  122. package/dist/models/v1/line-notification-template-body/line-notification-template-body.js.map +1 -0
  123. package/dist/models/v1/line-notification-template-button/index.d.ts +1 -0
  124. package/dist/models/v1/line-notification-template-button/index.js +3 -0
  125. package/dist/models/v1/line-notification-template-button/index.js.map +1 -0
  126. package/dist/models/v1/line-notification-template-button/line-notification-template-button.d.ts +9 -0
  127. package/dist/models/v1/line-notification-template-button/line-notification-template-button.js +3 -0
  128. package/dist/models/v1/line-notification-template-button/line-notification-template-button.js.map +1 -0
  129. package/dist/models/v1/line-notification-template-item/index.d.ts +1 -0
  130. package/dist/models/v1/line-notification-template-item/index.js +3 -0
  131. package/dist/models/v1/line-notification-template-item/index.js.map +1 -0
  132. package/dist/models/v1/line-notification-template-item/line-notification-template-item.d.ts +9 -0
  133. package/dist/models/v1/line-notification-template-item/line-notification-template-item.js +3 -0
  134. package/dist/models/v1/line-notification-template-item/line-notification-template-item.js.map +1 -0
  135. package/dist/models/v1/list-last-messages-by-channel-identity-request/index.d.ts +1 -0
  136. package/dist/models/v1/list-last-messages-by-channel-identity-request/index.js +3 -0
  137. package/dist/models/v1/list-last-messages-by-channel-identity-request/index.js.map +1 -0
  138. package/dist/models/v1/list-last-messages-by-channel-identity-request/list-last-messages-by-channel-identity-request.d.ts +29 -0
  139. package/dist/models/v1/list-last-messages-by-channel-identity-request/list-last-messages-by-channel-identity-request.js +3 -0
  140. package/dist/models/v1/list-last-messages-by-channel-identity-request/list-last-messages-by-channel-identity-request.js.map +1 -0
  141. package/dist/models/v1/list-message/list-message.d.ts +6 -1
  142. package/dist/models/v1/list-section/list-section.d.ts +1 -1
  143. package/dist/models/v1/media-message/index.d.ts +1 -1
  144. package/dist/models/v1/media-message/media-message.d.ts +2 -2
  145. package/dist/models/v1/mod-callback-events/capability-event/capability-event.d.ts +1 -1
  146. package/dist/models/v1/mod-callback-events/conversation-callback-event/conversation-callback-event.d.ts +2 -2
  147. package/dist/models/v1/mod-callback-events/event-inbound/event-inbound.d.ts +30 -3
  148. package/dist/models/v1/mod-callback-events/event-inbound/index.d.ts +1 -1
  149. package/dist/models/v1/mod-callback-events/smart-conversations-event/smart-conversations-event.d.ts +6 -3
  150. package/dist/models/v1/mod-credentials/index.d.ts +1 -0
  151. package/dist/models/v1/mod-credentials/index.js +1 -0
  152. package/dist/models/v1/mod-credentials/index.js.map +1 -1
  153. package/dist/models/v1/mod-credentials/line-credentials/line-credentials.d.ts +3 -1
  154. package/dist/models/v1/mod-credentials/line-enterprise-credentials/index.d.ts +1 -0
  155. package/dist/models/v1/mod-credentials/line-enterprise-credentials/index.js +3 -0
  156. package/dist/models/v1/mod-credentials/line-enterprise-credentials/index.js.map +1 -0
  157. package/dist/models/v1/mod-credentials/line-enterprise-credentials/line-enterprise-credentials.d.ts +24 -0
  158. package/dist/models/v1/mod-credentials/line-enterprise-credentials/line-enterprise-credentials.js +3 -0
  159. package/dist/models/v1/mod-credentials/line-enterprise-credentials/line-enterprise-credentials.js.map +1 -0
  160. package/dist/models/v1/project-settings/index.d.ts +1 -0
  161. package/dist/models/v1/project-settings/index.js +3 -0
  162. package/dist/models/v1/project-settings/index.js.map +1 -0
  163. package/dist/models/v1/project-settings/project-settings.d.ts +10 -0
  164. package/dist/models/v1/project-settings/project-settings.js +3 -0
  165. package/dist/models/v1/project-settings/project-settings.js.map +1 -0
  166. package/dist/models/v1/project-settings-request/index.d.ts +1 -0
  167. package/dist/models/v1/project-settings-request/index.js +3 -0
  168. package/dist/models/v1/project-settings-request/index.js.map +1 -0
  169. package/dist/models/v1/project-settings-request/project-settings-request.d.ts +10 -0
  170. package/dist/models/v1/project-settings-request/project-settings-request.js +3 -0
  171. package/dist/models/v1/project-settings-request/project-settings-request.js.map +1 -0
  172. package/dist/models/v1/queue-stats/queue-stats.d.ts +2 -2
  173. package/dist/models/v1/requests/consents/consents-request-data.d.ts +17 -0
  174. package/dist/models/v1/requests/consents/consents-request-data.js +3 -0
  175. package/dist/models/v1/requests/consents/consents-request-data.js.map +1 -0
  176. package/dist/models/v1/requests/contact/contact-request-data.d.ts +9 -3
  177. package/dist/models/v1/requests/conversation/conversation-request-data.d.ts +1 -1
  178. package/dist/models/v1/requests/index.d.ts +2 -0
  179. package/dist/models/v1/requests/index.js +2 -0
  180. package/dist/models/v1/requests/index.js.map +1 -1
  181. package/dist/models/v1/requests/messages/messages-request-data.d.ts +9 -2
  182. package/dist/models/v1/requests/project-settings/project-settings-request-data.d.ts +13 -0
  183. package/dist/models/v1/{flow-channel-specific-message/flow-channel-specific-message.js → requests/project-settings/project-settings-request-data.js} +1 -1
  184. package/dist/models/v1/requests/project-settings/project-settings-request-data.js.map +1 -0
  185. package/dist/models/v1/retention-policy/retention-policy.d.ts +1 -1
  186. package/dist/models/v1/runtime-error/index.d.ts +1 -1
  187. package/dist/models/v1/runtime-error/runtime-error.d.ts +3 -1
  188. package/dist/models/v1/send-message-request/send-message-request.d.ts +6 -4
  189. package/dist/models/v1/share-location-message/index.d.ts +1 -0
  190. package/dist/models/v1/share-location-message/index.js +3 -0
  191. package/dist/models/v1/share-location-message/index.js.map +1 -0
  192. package/dist/models/v1/share-location-message/share-location-message.d.ts +6 -0
  193. package/dist/models/v1/{media-carousel-message/media-carousel-message.js → share-location-message/share-location-message.js} +1 -1
  194. package/dist/models/v1/share-location-message/share-location-message.js.map +1 -0
  195. package/dist/models/v1/smart-conversation/smart-conversation.d.ts +1 -1
  196. package/dist/models/v1/template-message/template-message.d.ts +6 -3
  197. package/dist/models/v1/template-reference/index.d.ts +1 -1
  198. package/dist/models/v1/template-reference/template-reference.d.ts +15 -3
  199. package/dist/models/v1/webhook/webhook.d.ts +3 -3
  200. package/dist/models/v1/webhook-trigger/webhook-trigger.d.ts +1 -0
  201. package/dist/models/v1/whatsapp-flow/index.d.ts +1 -0
  202. package/dist/models/v1/whatsapp-flow/index.js +3 -0
  203. package/dist/models/v1/whatsapp-flow/index.js.map +1 -0
  204. package/dist/models/v1/whatsapp-flow/whatsapp-flow.d.ts +28 -0
  205. package/dist/models/v1/whatsapp-flow/whatsapp-flow.js +3 -0
  206. package/dist/models/v1/whatsapp-flow/whatsapp-flow.js.map +1 -0
  207. package/dist/models/v1/whatsapp-interactive-message-base/common/header/index.d.ts +5 -0
  208. package/dist/models/v1/whatsapp-interactive-message-base/common/header/index.js +22 -0
  209. package/dist/models/v1/whatsapp-interactive-message-base/common/header/index.js.map +1 -0
  210. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header/index.js +3 -0
  211. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header/index.js.map +1 -0
  212. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header/whatsapp-interactive-document-header.js.map +1 -0
  213. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media/index.js +3 -0
  214. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media/index.js.map +1 -0
  215. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media/whatsapp-interactive-header-media.js.map +1 -0
  216. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header/index.js +3 -0
  217. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header/index.js.map +1 -0
  218. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header/whatsapp-interactive-image-header.js.map +1 -0
  219. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header/index.js +3 -0
  220. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header/index.js.map +1 -0
  221. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header/whatsapp-interactive-text-header.js.map +1 -0
  222. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header/index.js +3 -0
  223. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header/index.js.map +1 -0
  224. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header/whatsapp-interactive-video-header.js.map +1 -0
  225. package/dist/models/v1/whatsapp-interactive-message-base/common/index.d.ts +4 -0
  226. package/dist/models/v1/whatsapp-interactive-message-base/common/index.js +21 -0
  227. package/dist/models/v1/whatsapp-interactive-message-base/common/index.js.map +1 -0
  228. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-body/index.js +3 -0
  229. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-body/index.js.map +1 -0
  230. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-body/whatsapp-interactive-body.js.map +1 -0
  231. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-footer/index.js +3 -0
  232. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-footer/index.js.map +1 -0
  233. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-footer/whatsapp-interactive-footer.js.map +1 -0
  234. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/index.d.ts +1 -0
  235. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/index.js +3 -0
  236. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/index.js.map +1 -0
  237. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/whatsapp-interactive-header.d.ts +4 -0
  238. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/whatsapp-interactive-header.js +3 -0
  239. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/whatsapp-interactive-header.js.map +1 -0
  240. package/dist/models/v1/whatsapp-interactive-message-base/index.d.ts +2 -0
  241. package/dist/models/v1/whatsapp-interactive-message-base/index.js +18 -0
  242. package/dist/models/v1/whatsapp-interactive-message-base/index.js.map +1 -0
  243. package/dist/models/v1/whatsapp-interactive-message-base/whatsapp-interactive-message-base.d.ts +9 -0
  244. package/dist/models/v1/whatsapp-interactive-message-base/whatsapp-interactive-message-base.js +3 -0
  245. package/dist/models/v1/whatsapp-interactive-message-base/whatsapp-interactive-message-base.js.map +1 -0
  246. package/dist/models/v1/whatsapp-payment-order-details/index.d.ts +1 -0
  247. package/dist/models/v1/whatsapp-payment-order-details/index.js +3 -0
  248. package/dist/models/v1/whatsapp-payment-order-details/index.js.map +1 -0
  249. package/dist/models/v1/whatsapp-payment-order-details/whatsapp-payment-order-details.d.ts +117 -0
  250. package/dist/models/v1/whatsapp-payment-order-details/whatsapp-payment-order-details.js +3 -0
  251. package/dist/models/v1/whatsapp-payment-order-details/whatsapp-payment-order-details.js.map +1 -0
  252. package/dist/models/v1/whatsapp-payment-order-status/index.d.ts +1 -0
  253. package/dist/models/v1/whatsapp-payment-order-status/index.js +3 -0
  254. package/dist/models/v1/whatsapp-payment-order-status/index.js.map +1 -0
  255. package/dist/models/v1/whatsapp-payment-order-status/whatsapp-payment-order-status.d.ts +32 -0
  256. package/dist/models/v1/whatsapp-payment-order-status/whatsapp-payment-order-status.js +3 -0
  257. package/dist/models/v1/whatsapp-payment-order-status/whatsapp-payment-order-status.js.map +1 -0
  258. package/dist/rest/v1/app/app-api.d.ts +4 -9
  259. package/dist/rest/v1/app/app-api.js +4 -14
  260. package/dist/rest/v1/app/app-api.js.map +1 -1
  261. package/dist/rest/v1/callbacks/callbacks-webhook.d.ts +7 -0
  262. package/dist/rest/v1/callbacks/callbacks-webhook.js +13 -0
  263. package/dist/rest/v1/callbacks/callbacks-webhook.js.map +1 -1
  264. package/dist/rest/v1/capability/capability-api.d.ts +2 -7
  265. package/dist/rest/v1/capability/capability-api.js +2 -8
  266. package/dist/rest/v1/capability/capability-api.js.map +1 -1
  267. package/dist/rest/v1/consents/consents-api.d.ts +20 -0
  268. package/dist/rest/v1/consents/consents-api.jest.fixture.d.ts +13 -0
  269. package/dist/rest/v1/consents/consents-api.jest.fixture.js +17 -0
  270. package/dist/rest/v1/consents/consents-api.jest.fixture.js.map +1 -0
  271. package/dist/rest/v1/consents/consents-api.js +61 -0
  272. package/dist/rest/v1/consents/consents-api.js.map +1 -0
  273. package/dist/rest/v1/consents/index.d.ts +2 -0
  274. package/dist/rest/v1/consents/index.js +19 -0
  275. package/dist/rest/v1/consents/index.js.map +1 -0
  276. package/dist/rest/v1/contact/contact-api.d.ts +13 -10
  277. package/dist/rest/v1/contact/contact-api.jest.fixture.d.ts +5 -1
  278. package/dist/rest/v1/contact/contact-api.jest.fixture.js +4 -0
  279. package/dist/rest/v1/contact/contact-api.jest.fixture.js.map +1 -1
  280. package/dist/rest/v1/contact/contact-api.js +31 -16
  281. package/dist/rest/v1/contact/contact-api.js.map +1 -1
  282. package/dist/rest/v1/conversation/conversation-api.d.ts +5 -9
  283. package/dist/rest/v1/conversation/conversation-api.js +4 -18
  284. package/dist/rest/v1/conversation/conversation-api.js.map +1 -1
  285. package/dist/rest/v1/conversation-domain-api.d.ts +13 -14
  286. package/dist/rest/v1/conversation-domain-api.js +29 -52
  287. package/dist/rest/v1/conversation-domain-api.js.map +1 -1
  288. package/dist/rest/v1/conversation-service.d.ts +31 -2
  289. package/dist/rest/v1/conversation-service.js +126 -32
  290. package/dist/rest/v1/conversation-service.js.map +1 -1
  291. package/dist/rest/v1/events/events-api.d.ts +4 -8
  292. package/dist/rest/v1/events/events-api.js +3 -12
  293. package/dist/rest/v1/events/events-api.js.map +1 -1
  294. package/dist/rest/v1/index.d.ts +3 -0
  295. package/dist/rest/v1/index.js +3 -0
  296. package/dist/rest/v1/index.js.map +1 -1
  297. package/dist/rest/v1/messages/messages-api.d.ts +13 -11
  298. package/dist/rest/v1/messages/messages-api.jest.fixture.d.ts +7 -1
  299. package/dist/rest/v1/messages/messages-api.jest.fixture.js +4 -0
  300. package/dist/rest/v1/messages/messages-api.jest.fixture.js.map +1 -1
  301. package/dist/rest/v1/messages/messages-api.js +33 -16
  302. package/dist/rest/v1/messages/messages-api.js.map +1 -1
  303. package/dist/rest/v1/project-settings/index.d.ts +2 -0
  304. package/dist/rest/v1/project-settings/index.js +19 -0
  305. package/dist/rest/v1/project-settings/index.js.map +1 -0
  306. package/dist/rest/v1/project-settings/project-settings-api.d.ts +30 -0
  307. package/dist/rest/v1/project-settings/project-settings-api.jest.fixture.d.ts +20 -0
  308. package/dist/rest/v1/project-settings/project-settings-api.jest.fixture.js +25 -0
  309. package/dist/rest/v1/project-settings/project-settings-api.jest.fixture.js.map +1 -0
  310. package/dist/rest/v1/project-settings/project-settings-api.js +101 -0
  311. package/dist/rest/v1/project-settings/project-settings-api.js.map +1 -0
  312. package/dist/rest/v1/templates-v1/templates-v1-api.d.ts +8 -8
  313. package/dist/rest/v1/templates-v1/templates-v1-api.js +8 -13
  314. package/dist/rest/v1/templates-v1/templates-v1-api.js.map +1 -1
  315. package/dist/rest/v1/templates-v2/templates-v2-api.d.ts +3 -8
  316. package/dist/rest/v1/templates-v2/templates-v2-api.js +3 -14
  317. package/dist/rest/v1/templates-v2/templates-v2-api.js.map +1 -1
  318. package/dist/rest/v1/transcoding/transcoding-api.d.ts +2 -7
  319. package/dist/rest/v1/transcoding/transcoding-api.js +2 -8
  320. package/dist/rest/v1/transcoding/transcoding-api.js.map +1 -1
  321. package/dist/rest/v1/webhooks/webhooks-api.d.ts +2 -7
  322. package/dist/rest/v1/webhooks/webhooks-api.js +2 -12
  323. package/dist/rest/v1/webhooks/webhooks-api.js.map +1 -1
  324. package/package.json +2 -2
  325. package/dist/models/v1/flow-channel-specific-message/flow-channel-specific-message.d.ts +0 -37
  326. package/dist/models/v1/flow-channel-specific-message/flow-channel-specific-message.js.map +0 -1
  327. package/dist/models/v1/flow-channel-specific-message/index.d.ts +0 -1
  328. package/dist/models/v1/flow-channel-specific-message/index.js.map +0 -1
  329. package/dist/models/v1/media-carousel-message/index.d.ts +0 -1
  330. package/dist/models/v1/media-carousel-message/index.js.map +0 -1
  331. package/dist/models/v1/media-carousel-message/media-carousel-message.d.ts +0 -7
  332. package/dist/models/v1/media-carousel-message/media-carousel-message.js.map +0 -1
  333. package/dist/models/v1/whatsapp-interactive-body/index.js.map +0 -1
  334. package/dist/models/v1/whatsapp-interactive-body/whatsapp-interactive-body.js.map +0 -1
  335. package/dist/models/v1/whatsapp-interactive-document-header/index.js.map +0 -1
  336. package/dist/models/v1/whatsapp-interactive-document-header/whatsapp-interactive-document-header.js.map +0 -1
  337. package/dist/models/v1/whatsapp-interactive-footer/index.js.map +0 -1
  338. package/dist/models/v1/whatsapp-interactive-footer/whatsapp-interactive-footer.js.map +0 -1
  339. package/dist/models/v1/whatsapp-interactive-header-media/index.js.map +0 -1
  340. package/dist/models/v1/whatsapp-interactive-header-media/whatsapp-interactive-header-media.js.map +0 -1
  341. package/dist/models/v1/whatsapp-interactive-image-header/index.js.map +0 -1
  342. package/dist/models/v1/whatsapp-interactive-image-header/whatsapp-interactive-image-header.js.map +0 -1
  343. package/dist/models/v1/whatsapp-interactive-text-header/index.js.map +0 -1
  344. package/dist/models/v1/whatsapp-interactive-text-header/whatsapp-interactive-text-header.js.map +0 -1
  345. package/dist/models/v1/whatsapp-interactive-video-header/index.js.map +0 -1
  346. package/dist/models/v1/whatsapp-interactive-video-header/whatsapp-interactive-video-header.js.map +0 -1
  347. /package/dist/models/v1/{flow-channel-specific-message → audit-record}/index.js +0 -0
  348. /package/dist/models/v1/{media-carousel-message → audit-records-list}/index.js +0 -0
  349. /package/dist/models/v1/{whatsapp-interactive-body → calendar-message}/index.js +0 -0
  350. /package/dist/models/v1/{whatsapp-interactive-document-header → consent-identity}/index.js +0 -0
  351. /package/dist/models/v1/{whatsapp-interactive-footer → contact-settings}/index.js +0 -0
  352. /package/dist/models/v1/{whatsapp-interactive-header-media → identity-conflict}/index.js +0 -0
  353. /package/dist/models/v1/{whatsapp-interactive-image-header → kakaotalk-button}/index.js +0 -0
  354. /package/dist/models/v1/{whatsapp-interactive-video-header → kakaotalk-carousel}/index.js +0 -0
  355. /package/dist/models/v1/{whatsapp-interactive-text-header → kakaotalk-carousel-commerce}/index.js +0 -0
  356. /package/dist/models/v1/{whatsapp-interactive-document-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header}/index.d.ts +0 -0
  357. /package/dist/models/v1/{whatsapp-interactive-document-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header}/whatsapp-interactive-document-header.d.ts +0 -0
  358. /package/dist/models/v1/{whatsapp-interactive-document-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header}/whatsapp-interactive-document-header.js +0 -0
  359. /package/dist/models/v1/{whatsapp-interactive-header-media → whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media}/index.d.ts +0 -0
  360. /package/dist/models/v1/{whatsapp-interactive-header-media → whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media}/whatsapp-interactive-header-media.d.ts +0 -0
  361. /package/dist/models/v1/{whatsapp-interactive-header-media → whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media}/whatsapp-interactive-header-media.js +0 -0
  362. /package/dist/models/v1/{whatsapp-interactive-image-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header}/index.d.ts +0 -0
  363. /package/dist/models/v1/{whatsapp-interactive-image-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header}/whatsapp-interactive-image-header.d.ts +0 -0
  364. /package/dist/models/v1/{whatsapp-interactive-image-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header}/whatsapp-interactive-image-header.js +0 -0
  365. /package/dist/models/v1/{whatsapp-interactive-text-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header}/index.d.ts +0 -0
  366. /package/dist/models/v1/{whatsapp-interactive-text-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header}/whatsapp-interactive-text-header.d.ts +0 -0
  367. /package/dist/models/v1/{whatsapp-interactive-text-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header}/whatsapp-interactive-text-header.js +0 -0
  368. /package/dist/models/v1/{whatsapp-interactive-video-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header}/index.d.ts +0 -0
  369. /package/dist/models/v1/{whatsapp-interactive-video-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header}/whatsapp-interactive-video-header.d.ts +0 -0
  370. /package/dist/models/v1/{whatsapp-interactive-video-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header}/whatsapp-interactive-video-header.js +0 -0
  371. /package/dist/models/v1/{whatsapp-interactive-body → whatsapp-interactive-message-base/common/whatsapp-interactive-body}/index.d.ts +0 -0
  372. /package/dist/models/v1/{whatsapp-interactive-body → whatsapp-interactive-message-base/common/whatsapp-interactive-body}/whatsapp-interactive-body.d.ts +0 -0
  373. /package/dist/models/v1/{whatsapp-interactive-body → whatsapp-interactive-message-base/common/whatsapp-interactive-body}/whatsapp-interactive-body.js +0 -0
  374. /package/dist/models/v1/{whatsapp-interactive-footer → whatsapp-interactive-message-base/common/whatsapp-interactive-footer}/index.d.ts +0 -0
  375. /package/dist/models/v1/{whatsapp-interactive-footer → whatsapp-interactive-message-base/common/whatsapp-interactive-footer}/whatsapp-interactive-footer.d.ts +0 -0
  376. /package/dist/models/v1/{whatsapp-interactive-footer → whatsapp-interactive-message-base/common/whatsapp-interactive-footer}/whatsapp-interactive-footer.js +0 -0
@@ -1,6 +1,6 @@
1
1
  import { Agent } from '../agent';
2
2
  import { LocationMessage, LocationMessageItem } from '../location-message';
3
- import { MediaMessage, MediaMessageItem } from '../media-message';
3
+ import { MediaMessage, MediaProperties } from '../media-message';
4
4
  import { TextMessage, TextMessageItem } from '../text-message';
5
5
  import { TemplateMessageItem } from '../template-message';
6
6
  import { TemplateReference } from '../template-reference';
@@ -64,8 +64,8 @@ export interface AppCarouselMessage extends AppMessageBase {
64
64
  contact_info_message?: never;
65
65
  }
66
66
  export interface AppMediaMessage extends AppMessageBase {
67
- /** @see MediaMessageItem */
68
- media_message: MediaMessageItem;
67
+ /** @see MediaProperties */
68
+ media_message: MediaProperties;
69
69
  card_message?: never;
70
70
  choice_message?: never;
71
71
  location_message?: never;
@@ -125,15 +125,18 @@ export interface AppContactInfoMessage extends AppMessageBase {
125
125
  }
126
126
  interface AppMessageBase {
127
127
  /**
128
- * Channel specific messages, overriding any transcoding.
129
- * The key in the map must point to a valid conversation channel as defined by the enum ConversationChannel.
128
+ * Allows you to specify a channel and define a corresponding channel specific message payload that will override the standard Conversation API message types.
129
+ * The key in the map must point to a valid conversation channel as defined in the enum `ConversationChannel`. The message content must be provided in string format.
130
+ * You may use the [transcoding endpoint](https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Transcoding/) to help create your message.
131
+ * For more information about how to construct an explicit channel message for a particular channel, see that [channel's corresponding documentation](https://developers.sinch.com/docs/conversation/channel-support/) (for example, using explicit channel messages with [the WhatsApp channel](https://developers.sinch.com/docs/conversation/channel-support/whatsapp/message-support/#explicit-channel-messages)).
130
132
  */
131
133
  explicit_channel_message?: {
132
134
  [key in ConversationChannel]?: string;
133
135
  };
134
136
  /**
135
- * The option to override the omni-channel template configuration with a channel-specific template
136
- * (for channels on which channel-specific templates can be created. For more information, see [Channel Specific Templates](https://developers.sinch.com/docs/conversation/templates/#channel-specific-templates)).
137
+ * Override the message's content for specified channels.
138
+ * The key in the map must point to a valid conversation channel as defined in the enum `ConversationChannel`.
139
+ * The content defined under the specified channel will be sent on that channel.
137
140
  */
138
141
  explicit_channel_omni_message?: {
139
142
  [key in ChannelSpecificTemplate]?: OmniMessageOverride;
@@ -0,0 +1,18 @@
1
+ import { ConsentsListType, ConsentOperation, ConsentOrigin } from '../enums';
2
+ /**
3
+ * Represents a consent audit record from the Conversation API.
4
+ */
5
+ export interface AuditRecord {
6
+ /** The origin from the opt-out or opt-in. This could be the Batch API or an MO (when matched with an end-user MO). */
7
+ origin: ConsentOrigin;
8
+ /** The operation that the audit record refers to. Can be INSERT, UPDATE or DELETE. */
9
+ operation: ConsentOperation;
10
+ /** The list type of the consent list the audit record refers to. */
11
+ list_type: ConsentsListType;
12
+ /** The project ID associated with the consent list the audit record refers to. */
13
+ project_id: string;
14
+ /** The app ID associated with the consent list the audit record refers to. */
15
+ app_id: string;
16
+ /** Datetime of when the consent list audit record happened. */
17
+ datetime: Date;
18
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=audit-record.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"audit-record.js","sourceRoot":"","sources":["../../../../src/models/v1/audit-record/audit-record.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export type { AuditRecord } from './audit-record';
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/audit-record/index.ts"],"names":[],"mappings":""}
@@ -0,0 +1,8 @@
1
+ import { AuditRecord } from '../audit-record';
2
+ import { ConsentIdentity } from '../consent-identity';
3
+ export interface AuditRecordsList {
4
+ /** @see ConsentIdentity */
5
+ identity?: ConsentIdentity;
6
+ /** List of audit records associated with the given identity */
7
+ audit_records?: AuditRecord[];
8
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=audit-records-list.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"audit-records-list.js","sourceRoot":"","sources":["../../../../src/models/v1/audit-records-list/audit-records-list.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export type { AuditRecordsList } from './audit-records-list';
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/audit-records-list/index.ts"],"names":[],"mappings":""}
@@ -0,0 +1,14 @@
1
+ export interface CalendarMessage {
2
+ /** The title is shown close to the button that leads to open a user calendar. */
3
+ title: string;
4
+ /** The timestamp defines start of a calendar event. */
5
+ event_start: Date;
6
+ /** The timestamp defines end of a calendar event. */
7
+ event_end: Date;
8
+ /** Title of a calendar event. */
9
+ event_title: string;
10
+ /** Description of a calendar event. */
11
+ event_description?: string;
12
+ /** The URL that is opened when the user cannot open a calendar event directly or channel does not have support for this type. */
13
+ fallback_url: string;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=calendar-message.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"calendar-message.js","sourceRoot":"","sources":["../../../../src/models/v1/calendar-message/calendar-message.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export type { CalendarMessage } from './calendar-message';
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/calendar-message/index.ts"],"names":[],"mappings":""}
@@ -2,6 +2,6 @@
2
2
  * This object contains additional settings related to callback processing.
3
3
  */
4
4
  export interface CallbackSettings {
5
- /** Optional. Secret can be used to sign contents of delivery receipts for a message that was sent with the default `callback_url` overridden. You can then use the secret to verify the signature. */
5
+ /** Optional. Secret can be used to sign contents of delivery receipts for a message that was sent with the default callback URL overridden (using the [`callback_url` field](https://developers.sinch.com/docs/conversation/api-reference/conversation/tag/Messages/#tag/Messages/operation/Messages_SendMessage!path=callback_url&t=request)). You can then use the secret to verify the signature. */
6
6
  secret_for_overridden_callback_urls?: string;
7
7
  }
@@ -1,13 +1,16 @@
1
- import { MediaCarouselMessage } from '../media-carousel-message';
2
1
  import { Choice } from '../choice';
3
2
  import { CardHeight } from '../enums';
3
+ import { MediaProperties } from '../media-message';
4
4
  /**
5
- * Message containing text, media and choices.
5
+ * Field containing a Card Message.
6
6
  */
7
7
  export interface CardMessage {
8
8
  /** Message containing text, media and choices. */
9
9
  card_message: CardMessageItem;
10
10
  }
11
+ /**
12
+ * Message containing text, media and choices.
13
+ */
11
14
  export interface CardMessageItem {
12
15
  /** You may include choices in your Card Message. The number of choices is limited to 10. */
13
16
  choices?: Choice[];
@@ -15,8 +18,14 @@ export interface CardMessageItem {
15
18
  description?: string;
16
19
  /** @see CardHeight */
17
20
  height?: CardHeight;
18
- /** @see MediaCarouselMessage */
19
- media_message?: MediaCarouselMessage;
21
+ /** A message containing a media component. */
22
+ media_message?: MediaProperties;
20
23
  /** The title of the card message. */
21
24
  title?: string;
25
+ /** Optional additional properties. */
26
+ message_properties?: CardMessageItemProperties;
27
+ }
28
+ export interface CardMessageItemProperties {
29
+ /** Optional. Sets the header for the footer of a WhatsApp reply button message, if there is no media in the message. Ignored for other channels. Ignored if not transcoded to a native WhatsApp message with reply buttons. */
30
+ whatsapp_header?: string;
22
31
  }
@@ -1 +1 @@
1
- export type { CardMessage, CardMessageItem } from './card-message';
1
+ export type { CardMessage, CardMessageItem, CardMessageItemProperties } from './card-message';
@@ -1,12 +1,15 @@
1
1
  import { CardMessageItem } from '../card-message';
2
2
  import { Choice } from '../choice';
3
3
  /**
4
- * Message containing a list of cards often rendered horizontally on supported channels. Supported types for media are only images, such as .png, .jpg, .jpeg extensions.
4
+ * Field containing a Carrousel Message.
5
5
  */
6
6
  export interface CarouselMessage {
7
- /** Message containing a list of cards often rendered horizontally on supported channels. Supported types for media are only images, such as .png, .jpg, .jpeg extensions. */
7
+ /** Message containing a list of cards often rendered horizontally on supported channels. */
8
8
  carousel_message: CarouselMessageItem;
9
9
  }
10
+ /**
11
+ * Message containing a list of cards often rendered horizontally on supported channels.
12
+ */
10
13
  export interface CarouselMessageItem {
11
14
  /** A list of up to 10 cards. */
12
15
  cards: CardMessageItem[];
@@ -3,7 +3,7 @@ import { ConversationChannel } from '../conversation-channel';
3
3
  * A unique identity of message recipient on a particular channel. For example, the channel identity on SMS, WHATSAPP or VIBERBM is a MSISDN phone number.
4
4
  */
5
5
  export interface ChannelIdentity {
6
- /** Required if using a channel that uses app-scoped channel identities. Currently, FB Messenger, Viber Bot, Instagram, Apple Messages for Business, LINE, and WeChat use app-scoped channel identities, which means contacts will have different channel identities on different Conversation API apps. These can be thought of as virtual identities that are app-specific and, therefore, the app_id must be included in the API call. */
6
+ /** Required if using a channel that uses app-scoped channel identities. Currently, FB Messenger, Instagram, LINE, and WeChat use app-scoped channel identities, which means contacts will have different channel identities on different Conversation API apps. These can be thought of as virtual identities that are app-specific and, therefore, the app_id must be included in the API call. */
7
7
  app_id?: string;
8
8
  /** @see ConversationChannel */
9
9
  channel: ConversationChannel;
@@ -14,7 +14,7 @@ export interface WhatsAppSpecificContactMessage {
14
14
  */
15
15
  interface WhatsAppInteractiveNfmReplyMessage {
16
16
  /** The interactive message type. */
17
- type: string;
17
+ type: 'nfm_reply';
18
18
  /** @see WhatsAppInteractiveNfmReply */
19
19
  nfm_reply: WhatsAppInteractiveNfmReply;
20
20
  }
@@ -1,11 +1,46 @@
1
- import { FlowChannelSpecificMessage } from '../flow-channel-specific-message';
1
+ import { WhatsAppFlow } from '../whatsapp-flow';
2
+ import { WhatsAppPaymentOrderDetails } from '../whatsapp-payment-order-details';
3
+ import { WhatsAppPaymentOrderStatus } from '../whatsapp-payment-order-status';
4
+ import { KakaoTalkCommerce } from '../kakaotalk-commerce';
5
+ import { KakaoTalkCarouselCommerce } from '../kakaotalk-carousel-commerce';
6
+ import { LineNotificationTemplate } from '../line-notification-template';
2
7
  /**
3
8
  * A message containing a channel specific message (not supported by OMNI types).
4
9
  */
5
- export type ChannelSpecificMessage = WhatsAppFlowMessage;
10
+ export type ChannelSpecificMessage = WhatsAppFlowMessage | WhatsAppPaymentOrderDetailsMessage | WhatsAppPaymentOrderStatusMessage | KakaoTalkCommerceMessage | KakaoTalkCarouselCommerceMessage | LineNotificationTemplateMessage;
6
11
  export interface WhatsAppFlowMessage {
7
- /** @see MessageTypeEnum */
12
+ /** The type of the channel specific message. */
8
13
  message_type: 'FLOWS';
9
- /** @see FlowChannelSpecificMessage */
10
- message: FlowChannelSpecificMessage;
14
+ /** @see WhatsAppFlow */
15
+ message: WhatsAppFlow;
16
+ }
17
+ export interface WhatsAppPaymentOrderDetailsMessage {
18
+ /** The type of the channel specific message. */
19
+ message_type: 'ORDER_DETAILS';
20
+ /** @see WhatsappPaymentOrderDetails */
21
+ message: WhatsAppPaymentOrderDetails;
22
+ }
23
+ export interface WhatsAppPaymentOrderStatusMessage {
24
+ /** The type of the channel specific message. */
25
+ message_type: 'ORDER_STATUS';
26
+ /** @see WhatsAppPaymentOrderStatus */
27
+ message: WhatsAppPaymentOrderStatus;
28
+ }
29
+ export interface KakaoTalkCommerceMessage {
30
+ /** The type of the channel specific message. */
31
+ message_type: 'COMMERCE';
32
+ /** @see KakaoTalkCommerce */
33
+ message: KakaoTalkCommerce;
34
+ }
35
+ export interface KakaoTalkCarouselCommerceMessage {
36
+ /** The type of the channel specific message. */
37
+ message_type: 'CAROUSEL_COMMERCE';
38
+ /** @see KakaoTalkCarouselCommerce */
39
+ message: KakaoTalkCarouselCommerce;
40
+ }
41
+ export interface LineNotificationTemplateMessage {
42
+ /** The type of the channel specific message. */
43
+ message_type: 'NOTIFICATION_MESSAGE_TEMPLATE';
44
+ /** @see LineNotificationTemplate */
45
+ message: LineNotificationTemplate;
11
46
  }
@@ -1 +1 @@
1
- export type { ChannelSpecificMessage, WhatsAppFlowMessage } from './channel-specific-message';
1
+ export type { ChannelSpecificMessage, WhatsAppFlowMessage, WhatsAppPaymentOrderDetailsMessage, WhatsAppPaymentOrderStatusMessage, KakaoTalkCommerceMessage, KakaoTalkCarouselCommerceMessage, LineNotificationTemplateMessage, } from './channel-specific-message';
@@ -2,39 +2,85 @@ import { CallMessage } from '../call-message';
2
2
  import { LocationMessageItem } from '../location-message';
3
3
  import { TextMessageItem } from '../text-message';
4
4
  import { UrlMessage } from '../url-message';
5
+ import { CalendarMessage } from '../calendar-message';
6
+ import { ShareLocationMessage } from '../share-location-message';
5
7
  /**
6
8
  * A choice is an action the user can take such as buttons for quick replies or other call to actions.
7
9
  */
8
- export type Choice = CallMessageChoice | LocationMessageChoice | TextMessageChoice | UrlMessageChoice;
10
+ export type Choice = CallMessageChoice | LocationMessageChoice | TextMessageChoice | UrlMessageChoice | CalendarMessageChoice | ShareLocationMessageChoice;
9
11
  export interface ChoiceBase {
10
12
  /** An optional field. This data will be returned in the ChoiceResponseMessage. The default is message_id_{text, title}. */
11
13
  postback_data?: string;
12
14
  }
15
+ /**
16
+ * Message for triggering a call.
17
+ */
13
18
  export interface CallMessageChoice extends ChoiceBase {
14
19
  /** @see CallMessage */
15
20
  call_message: CallMessage;
16
21
  location_message?: never;
17
22
  text_message?: never;
18
23
  url_message?: never;
24
+ calendar_message?: never;
25
+ share_location_message?: never;
19
26
  }
27
+ /**
28
+ * Message containing geographic location.
29
+ */
20
30
  export interface LocationMessageChoice extends ChoiceBase {
21
31
  /** @see LocationMessageItem */
22
32
  location_message: LocationMessageItem;
23
33
  call_message?: never;
24
34
  text_message?: never;
25
35
  url_message?: never;
36
+ calendar_message?: never;
37
+ share_location_message?: never;
26
38
  }
39
+ /**
40
+ * A message containing only text.
41
+ */
27
42
  export interface TextMessageChoice extends ChoiceBase {
28
43
  /** @see TextMessageItem */
29
44
  text_message: TextMessageItem;
30
45
  call_message?: never;
31
46
  location_message?: never;
32
47
  url_message?: never;
48
+ calendar_message?: never;
49
+ share_location_message?: never;
33
50
  }
51
+ /**
52
+ * A generic URL message.
53
+ */
34
54
  export interface UrlMessageChoice extends ChoiceBase {
35
55
  /** @see UrlMessage */
36
56
  url_message: UrlMessage;
37
57
  call_message?: never;
38
58
  location_message?: never;
39
59
  text_message?: never;
60
+ calendar_message?: never;
61
+ share_location_message?: never;
62
+ }
63
+ /**
64
+ * Message containing details about a calendar event.
65
+ */
66
+ export interface CalendarMessageChoice extends ChoiceBase {
67
+ /** @see CalendarMessage */
68
+ calendar_message?: CalendarMessage;
69
+ call_message?: never;
70
+ location_message?: never;
71
+ text_message?: never;
72
+ url_message?: never;
73
+ share_location_message?: never;
74
+ }
75
+ /**
76
+ * Message requesting location from a user.
77
+ */
78
+ export interface ShareLocationMessageChoice extends ChoiceBase {
79
+ /** @see ShareLocationMessage */
80
+ share_location_message?: ShareLocationMessage;
81
+ call_message?: never;
82
+ location_message?: never;
83
+ text_message?: never;
84
+ url_message?: never;
85
+ calendar_message?: never;
40
86
  }
@@ -1,4 +1,4 @@
1
- import { MediaMessageItem } from '../media-message';
1
+ import { MediaProperties } from '../media-message';
2
2
  export interface ChoiceItemWrapper {
3
3
  /** A message component for interactive messages, containing a choice. */
4
4
  choice: ChoiceItem;
@@ -8,8 +8,8 @@ export interface ChoiceItem {
8
8
  title: string;
9
9
  /** Optional parameter. The description (or subtitle) of this choice item. */
10
10
  description?: string;
11
- /** @see MediaMessageItem */
12
- media_message?: MediaMessageItem;
11
+ /** Optional parameter. The media of this choice item. */
12
+ media?: MediaProperties;
13
13
  /** Optional parameter. Postback data that will be returned in the MO if the user selects this option. */
14
14
  postback_data?: string;
15
15
  }
@@ -1,10 +1,10 @@
1
1
  import { TextMessageItem } from '../text-message';
2
2
  import { Choice } from '../choice';
3
3
  /**
4
- * Message containing choices/actions.
4
+ * A message containing choices.
5
5
  */
6
6
  export interface ChoiceMessage {
7
- /** Message containing choices/actions. */
7
+ /** A message containing choices. */
8
8
  choice_message: ChoiceMessageItem;
9
9
  }
10
10
  export interface ChoiceMessageItem {
@@ -12,4 +12,10 @@ export interface ChoiceMessageItem {
12
12
  choices: Choice[];
13
13
  /** @see TextMessage */
14
14
  text_message?: TextMessageItem;
15
+ /** Additional properties for the message. */
16
+ message_properties?: ChoiceMessageItemProperties;
17
+ }
18
+ export interface ChoiceMessageItemProperties {
19
+ /** Optional. Sets the text for the footer of a WhatsApp reply button or URL button message. Ignored for other channels. */
20
+ whatsapp_footer?: string;
15
21
  }
@@ -8,4 +8,10 @@ export interface ClientCredentials {
8
8
  client_secret: string;
9
9
  /** The endpoint that will be used in the OAuth2 Client Credentials flow. Expected to return a JSON with an access token and `expires_in` value (in seconds). The `expires_in` value, which must be a minimum of 30 seconds and a maximum of 3600 seconds, is how long Sinch will save the access token before asking for a new one. */
10
10
  endpoint: string;
11
+ /** Optional. Space-separated string per RFC 6749. Used to limit the access granted by the token. Max length: 1024 characters. If blank or omitted, this is not included in the token request. */
12
+ scope?: string;
13
+ /** Optional. When granting `client_credentials`, this is generally omitted. If you do provide a value, it will be forwarded to your OAuth provider as-is. Max length: 64 characters. */
14
+ response_type?: string;
15
+ /** Optional. Controls how `client_id` and `client_secret` are sent to the token endpoint. Either `BASIC` or `FORM`. If not set or unrecognized, `BASIC` is used by default. */
16
+ token_request_type?: 'BASIC' | 'FORM' | string;
11
17
  }
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Represents an identity from the Conversation API.
3
+ */
4
+ export interface ConsentIdentity {
5
+ /** The identity from Conversation API. */
6
+ identity: string;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=consent-identity.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"consent-identity.js","sourceRoot":"","sources":["../../../../src/models/v1/consent-identity/consent-identity.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export type { ConsentIdentity } from './consent-identity';
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/consent-identity/index.ts"],"names":[],"mappings":""}
@@ -9,7 +9,7 @@ export interface ContactCreateRequest {
9
9
  channel_identities: ChannelIdentity[];
10
10
  /** List of channels defining the channel priority. The channel at the top of the list is tried first. */
11
11
  channel_priority?: ConversationChannel[];
12
- /** The display name. A default \'Unknown\' will be assigned if left empty. */
12
+ /** The display name. A default 'Unknown' will be assigned if left empty. */
13
13
  display_name?: string;
14
14
  /** Email of the contact. */
15
15
  email?: string;
@@ -2,7 +2,7 @@ import { ChoiceResponseMessage } from '../choice-response-message';
2
2
  import { FallbackMessage } from '../fallback-message';
3
3
  import { LocationMessageItem } from '../location-message';
4
4
  import { MediaCardMessage } from '../media-card-message';
5
- import { MediaMessageItem } from '../media-message';
5
+ import { MediaProperties } from '../media-message';
6
6
  import { ReplyTo } from '../reply-to';
7
7
  import { TextMessageItem } from '../text-message';
8
8
  import { ProductResponseMessage } from '../product-response-message';
@@ -67,8 +67,8 @@ interface ContactMessageMediaCardMessage extends ContactMessageBase {
67
67
  text_message?: never;
68
68
  }
69
69
  interface ContactMessageMediaMessage extends ContactMessageBase {
70
- /** @see MediaMessageItem */
71
- media_message: MediaMessageItem;
70
+ /** @see MediaProperties */
71
+ media_message: MediaProperties;
72
72
  channel_specific_message?: never;
73
73
  choice_response_message?: never;
74
74
  fallback_message?: never;
@@ -101,6 +101,6 @@ interface ContactMessageTextMessage extends ContactMessageBase {
101
101
  }
102
102
  interface ContactMessageBase {
103
103
  /** @see ReplyTo */
104
- reply_to?: ReplyTo;
104
+ reply_to?: ReplyTo | null;
105
105
  }
106
106
  export {};
@@ -1,11 +1,26 @@
1
1
  /**
2
2
  * The content of the event when contact_event is not populated. Note that this object is currently only available to select customers for beta testing. Mutually exclusive with contact_event.
3
3
  */
4
- export interface ContactMessageEvent {
4
+ export type ContactMessageEvent = PaymentStatusUpdateEventOneOf | ShortLinkActivatedEventOneOf | ReactionEventOneOf;
5
+ export interface PaymentStatusUpdateEventOneOf {
5
6
  /** Object reflecting the current state of a particular payment flow. */
6
7
  payment_status_update_event?: PaymentStatusUpdateEvent;
8
+ shortlink_activated_event?: never;
9
+ reaction_event?: never;
7
10
  }
8
- interface PaymentStatusUpdateEvent {
11
+ export interface ShortLinkActivatedEventOneOf {
12
+ /** Object reflecting an event that is created when a contact visits a shortlink. Currently, this is only supported for the Messenger and Instagram channels. */
13
+ shortlink_activated_event?: ShortLinkActivatedEvent;
14
+ payment_status_update_event?: never;
15
+ reaction_event?: never;
16
+ }
17
+ export interface ReactionEventOneOf {
18
+ /** Object reflecting an event that is created when a contact reacts/unreacts with an emoji to a particular MT message. Currently, this is only supported for the Messenger and Instagram channels. */
19
+ reaction_event?: ReactionEvent;
20
+ payment_status_update_event?: never;
21
+ shortlink_activated_event?: never;
22
+ }
23
+ export interface PaymentStatusUpdateEvent {
9
24
  /** Unique identifier for the corresponding payment of a particular order. */
10
25
  reference_id?: string;
11
26
  /** The stage the payment has reached within the payment flow. */
@@ -17,4 +32,34 @@ interface PaymentStatusUpdateEvent {
17
32
  }
18
33
  type PaymentStatusEnum = 'PAYMENT_STATUS_UNKNOWN' | 'PAYMENT_STATUS_NEW' | 'PAYMENT_STATUS_PENDING' | 'PAYMENT_STATUS_CAPTURED' | 'PAYMENT_STATUS_CANCELED' | 'PAYMENT_STATUS_FAILED';
19
34
  type PaymentTransactionStatusEnum = 'PAYMENT_STATUS_TRANSACTION_UNKNOWN' | 'PAYMENT_STATUS_TRANSACTION_PENDING' | 'PAYMENT_STATUS_TRANSACTION_FAILED' | 'PAYMENT_STATUS_TRANSACTION_SUCCESS' | 'PAYMENT_STATUS_TRANSACTION_CANCELED';
35
+ /**
36
+ * Object reflecting an event that is created when a contact visits a shortlink. Currently, this is only supported for the Messenger and Instagram channels. See [Shortlink Activated Event](https://developers.sinch.com/docs/conversation/callbacks/#shortlink-activated-event) for more details.
37
+ */
38
+ export interface ShortLinkActivatedEvent {
39
+ /** Refers to the payload previously configured to be sent in the postback. */
40
+ payload?: string;
41
+ /** Only relevant for the Instagram channel. */
42
+ title?: string;
43
+ /** The ref parameter from the shortlink the user visited. */
44
+ ref?: string;
45
+ /** Defaults to "SHORTLINK" for this type of event. */
46
+ source?: string;
47
+ /** The identifier for the referral. For Instagram and Messenger shortlinks, this is always set to "OPEN_THREAD". */
48
+ type?: string;
49
+ /** Set to true if target channel's conversation thread already existed at the moment the shortlink was visited. Set to false if a new conversation thread began when the shortlink was visited. */
50
+ existing_thread?: boolean;
51
+ }
52
+ /**
53
+ * Object reflecting an event that is created when a contact reacts/unreacts with an emoji to a particular MT message. Currently, this is only supported for the Messenger and Instagram channels. See [Reaction Event](https://developers.sinch.com/docs/conversation/callbacks/#reaction-event) for more details.
54
+ */
55
+ export interface ReactionEvent {
56
+ /** Indicates that an emoji reaction was placed on a message. This value is the string representation of the emoji. For example: "\u{2764}\u{FE0F}" */
57
+ emoji: string;
58
+ /** Type of action */
59
+ action: 'REACTION_ACTION_UNKNOWN' | 'REACTION_ACTION_REACT' | 'REACTION_ACTION_UNREACT';
60
+ /** The ID of the MT message that this reaction is associated with. */
61
+ message_id: string;
62
+ /** If present, represents the grouping of emojis. Example values: "smile", "angry", "sad", "wow", "love", "like", "dislike", "other" */
63
+ reaction_category?: string;
64
+ }
20
65
  export {};
@@ -1 +1 @@
1
- export type { ContactMessageEvent } from './contact-message-event';
1
+ export type { ContactMessageEvent, PaymentStatusUpdateEventOneOf, PaymentStatusUpdateEvent, ShortLinkActivatedEventOneOf, ShortLinkActivatedEvent, ReactionEventOneOf, ReactionEvent, } from './contact-message-event';
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Settings related to contact management for the project.
3
+ */
4
+ export interface ContactSettings {
5
+ /** Enables the Unified Contact ID feature. When enabled, contacts with the same phone number across SMS, RCS, and MMS channels are treated as a single entity. [See the documentation](https://developers.sinch.com/docs/conversation/unified-contact-id/) for details and requirements. */
6
+ unified_contact_id_enabled?: boolean;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=contact-settings.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"contact-settings.js","sourceRoot":"","sources":["../../../../src/models/v1/contact-settings/contact-settings.ts"],"names":[],"mappings":""}
@@ -0,0 +1 @@
1
+ export type { ContactSettings } from './contact-settings';
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/models/v1/contact-settings/index.ts"],"names":[],"mappings":""}
@@ -1,5 +1,5 @@
1
1
  /**
2
2
  * The identifier of the channel you want to include. Must be one of the enum values except 'CHANNEL_UNSPECIFIED'.
3
3
  */
4
- export type ConversationChannel = 'WHATSAPP' | 'RCS' | 'SMS' | 'MESSENGER' | 'VIBER' | 'VIBERBM' | 'MMS' | 'INSTAGRAM' | 'TELEGRAM' | 'KAKAOTALK' | 'KAKAOTALKCHAT' | 'LINE' | 'WECHAT' | 'APPLEBC' | 'CHANNEL_UNSPECIFIED';
5
- export type TemplateChannel = 'UNSPECIFIED' | 'CONVERSATION' | 'MESSENGER' | 'WHATSAPP' | 'RCS' | 'SMS' | 'VIBER' | 'VIBERBM';
4
+ export type ConversationChannel = 'WHATSAPP' | 'RCS' | 'SMS' | 'MESSENGER' | 'VIBERBM' | 'MMS' | 'INSTAGRAM' | 'TELEGRAM' | 'KAKAOTALK' | 'KAKAOTALKCHAT' | 'LINE' | 'WECHAT' | 'APPLEBC' | 'CHANNEL_UNSPECIFIED' | string;
5
+ export type TemplateChannel = 'UNSPECIFIED' | 'CONVERSATION' | 'MESSENGER' | 'WHATSAPP' | 'RCS' | 'SMS' | 'VIBERBM' | 'TELEGRAM' | 'INSTAGRAM' | 'KAKAOTALK' | 'APPLEBC' | string;