@sinch/conversation 1.2.0 → 1.3.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 (188) hide show
  1. package/dist/index.js +17 -7
  2. package/dist/index.js.map +1 -1
  3. package/dist/models/v1/app-message/app-message.d.ts +10 -7
  4. package/dist/models/v1/callback-settings/callback-settings.d.ts +1 -1
  5. package/dist/models/v1/card-message/card-message.d.ts +7 -4
  6. package/dist/models/v1/carousel-message/carousel-message.d.ts +5 -2
  7. package/dist/models/v1/channel-specific-contact-message/channel-specific-contact-message.d.ts +1 -1
  8. package/dist/models/v1/channel-specific-message/channel-specific-message.d.ts +19 -5
  9. package/dist/models/v1/channel-specific-message/index.d.ts +1 -1
  10. package/dist/models/v1/choice-item/choice-item.d.ts +3 -3
  11. package/dist/models/v1/choice-message/choice-message.d.ts +6 -0
  12. package/dist/models/v1/contact-create-request/contact-create-request.d.ts +1 -1
  13. package/dist/models/v1/contact-message/contact-message.d.ts +4 -4
  14. package/dist/models/v1/contact-message-event/contact-message-event.d.ts +47 -2
  15. package/dist/models/v1/contact-message-event/index.d.ts +1 -1
  16. package/dist/models/v1/conversation-channel-credential/conversation-channel-credential.d.ts +16 -4
  17. package/dist/models/v1/conversation-channel-credential/index.d.ts +1 -1
  18. package/dist/models/v1/conversation-event/conversation-event.d.ts +1 -1
  19. package/dist/models/v1/conversation-message/conversation-message.d.ts +1 -1
  20. package/dist/models/v1/create-conversation-request/create-conversation-request.d.ts +7 -1
  21. package/dist/models/v1/delivery-report-based-fallback/delivery-report-based-fallback.d.ts +1 -1
  22. package/dist/models/v1/dispatch-retention-policy/dispatch-retention-policy.d.ts +2 -2
  23. package/dist/models/v1/enums.d.ts +23 -14
  24. package/dist/models/v1/helper.d.ts +5 -5
  25. package/dist/models/v1/helper.js.map +1 -1
  26. package/dist/models/v1/identified-by/identified-by.d.ts +4 -2
  27. package/dist/models/v1/identified-by/index.d.ts +1 -1
  28. package/dist/models/v1/index.d.ts +4 -9
  29. package/dist/models/v1/index.js +4 -9
  30. package/dist/models/v1/index.js.map +1 -1
  31. package/dist/models/v1/inject-conversation-event-request/inject-conversation-event-request.d.ts +1 -1
  32. package/dist/models/v1/inject-message-request/inject-message-request.d.ts +4 -6
  33. package/dist/models/v1/list-message/list-message.d.ts +6 -1
  34. package/dist/models/v1/list-section/list-section.d.ts +1 -1
  35. package/dist/models/v1/media-message/index.d.ts +1 -1
  36. package/dist/models/v1/media-message/media-message.d.ts +2 -2
  37. package/dist/models/v1/mod-callback-events/capability-event/capability-event.d.ts +1 -1
  38. package/dist/models/v1/mod-callback-events/event-inbound/event-inbound.d.ts +30 -3
  39. package/dist/models/v1/mod-callback-events/event-inbound/index.d.ts +1 -1
  40. package/dist/models/v1/mod-callback-events/smart-conversations-event/smart-conversations-event.d.ts +6 -3
  41. package/dist/models/v1/mod-credentials/index.d.ts +1 -0
  42. package/dist/models/v1/mod-credentials/index.js +1 -0
  43. package/dist/models/v1/mod-credentials/index.js.map +1 -1
  44. package/dist/models/v1/mod-credentials/line-credentials/line-credentials.d.ts +3 -1
  45. package/dist/models/v1/mod-credentials/line-enterprise-credentials/index.d.ts +1 -0
  46. package/dist/models/v1/mod-credentials/line-enterprise-credentials/index.js.map +1 -0
  47. package/dist/models/v1/mod-credentials/line-enterprise-credentials/line-enterprise-credentials.d.ts +24 -0
  48. package/dist/models/v1/{media-carousel-message/media-carousel-message.js → mod-credentials/line-enterprise-credentials/line-enterprise-credentials.js} +1 -1
  49. package/dist/models/v1/mod-credentials/line-enterprise-credentials/line-enterprise-credentials.js.map +1 -0
  50. package/dist/models/v1/queue-stats/queue-stats.d.ts +2 -2
  51. package/dist/models/v1/requests/contact/contact-request-data.d.ts +3 -3
  52. package/dist/models/v1/requests/conversation/conversation-request-data.d.ts +1 -1
  53. package/dist/models/v1/requests/messages/messages-request-data.d.ts +1 -1
  54. package/dist/models/v1/retention-policy/retention-policy.d.ts +1 -1
  55. package/dist/models/v1/runtime-error/index.d.ts +1 -1
  56. package/dist/models/v1/runtime-error/runtime-error.d.ts +3 -1
  57. package/dist/models/v1/send-message-request/send-message-request.d.ts +6 -4
  58. package/dist/models/v1/template-message/template-message.d.ts +6 -3
  59. package/dist/models/v1/template-reference/index.d.ts +1 -1
  60. package/dist/models/v1/template-reference/template-reference.d.ts +15 -3
  61. package/dist/models/v1/webhook/webhook.d.ts +3 -3
  62. package/dist/models/v1/webhook-trigger/webhook-trigger.d.ts +1 -0
  63. package/dist/models/v1/whatsapp-flow/index.d.ts +1 -0
  64. package/dist/models/v1/whatsapp-flow/index.js.map +1 -0
  65. package/dist/models/v1/whatsapp-flow/whatsapp-flow.d.ts +28 -0
  66. package/dist/models/v1/whatsapp-flow/whatsapp-flow.js +3 -0
  67. package/dist/models/v1/whatsapp-flow/whatsapp-flow.js.map +1 -0
  68. package/dist/models/v1/whatsapp-interactive-message-base/common/header/index.d.ts +5 -0
  69. package/dist/models/v1/whatsapp-interactive-message-base/common/header/index.js +22 -0
  70. package/dist/models/v1/whatsapp-interactive-message-base/common/header/index.js.map +1 -0
  71. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header/index.js.map +1 -0
  72. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header/whatsapp-interactive-document-header.js.map +1 -0
  73. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media/index.js.map +1 -0
  74. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media/whatsapp-interactive-header-media.js.map +1 -0
  75. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header/index.js.map +1 -0
  76. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header/whatsapp-interactive-image-header.js.map +1 -0
  77. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header/index.js.map +1 -0
  78. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header/whatsapp-interactive-text-header.js.map +1 -0
  79. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header/index.js.map +1 -0
  80. package/dist/models/v1/whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header/whatsapp-interactive-video-header.js.map +1 -0
  81. package/dist/models/v1/whatsapp-interactive-message-base/common/index.d.ts +4 -0
  82. package/dist/models/v1/whatsapp-interactive-message-base/common/index.js +21 -0
  83. package/dist/models/v1/whatsapp-interactive-message-base/common/index.js.map +1 -0
  84. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-body/index.js.map +1 -0
  85. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-body/whatsapp-interactive-body.js.map +1 -0
  86. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-footer/index.js.map +1 -0
  87. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-footer/whatsapp-interactive-footer.js.map +1 -0
  88. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/index.d.ts +1 -0
  89. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/index.js +3 -0
  90. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/index.js.map +1 -0
  91. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/whatsapp-interactive-header.d.ts +4 -0
  92. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/whatsapp-interactive-header.js +3 -0
  93. package/dist/models/v1/whatsapp-interactive-message-base/common/whatsapp-interactive-header/whatsapp-interactive-header.js.map +1 -0
  94. package/dist/models/v1/whatsapp-interactive-message-base/index.d.ts +2 -0
  95. package/dist/models/v1/whatsapp-interactive-message-base/index.js +18 -0
  96. package/dist/models/v1/whatsapp-interactive-message-base/index.js.map +1 -0
  97. package/dist/models/v1/whatsapp-interactive-message-base/whatsapp-interactive-message-base.d.ts +9 -0
  98. package/dist/models/v1/whatsapp-interactive-message-base/whatsapp-interactive-message-base.js +3 -0
  99. package/dist/models/v1/whatsapp-interactive-message-base/whatsapp-interactive-message-base.js.map +1 -0
  100. package/dist/models/v1/whatsapp-payment-order-details/index.d.ts +1 -0
  101. package/dist/models/v1/whatsapp-payment-order-details/index.js +3 -0
  102. package/dist/models/v1/whatsapp-payment-order-details/index.js.map +1 -0
  103. package/dist/models/v1/whatsapp-payment-order-details/whatsapp-payment-order-details.d.ts +98 -0
  104. package/dist/models/v1/whatsapp-payment-order-details/whatsapp-payment-order-details.js +3 -0
  105. package/dist/models/v1/whatsapp-payment-order-details/whatsapp-payment-order-details.js.map +1 -0
  106. package/dist/models/v1/whatsapp-payment-order-status/index.d.ts +1 -0
  107. package/dist/models/v1/whatsapp-payment-order-status/index.js +3 -0
  108. package/dist/models/v1/whatsapp-payment-order-status/index.js.map +1 -0
  109. package/dist/models/v1/whatsapp-payment-order-status/whatsapp-payment-order-status.d.ts +32 -0
  110. package/dist/models/v1/{flow-channel-specific-message/flow-channel-specific-message.js → whatsapp-payment-order-status/whatsapp-payment-order-status.js} +1 -1
  111. package/dist/models/v1/whatsapp-payment-order-status/whatsapp-payment-order-status.js.map +1 -0
  112. package/dist/rest/v1/app/app-api.d.ts +1 -1
  113. package/dist/rest/v1/app/app-api.jest.fixture.d.ts +0 -1
  114. package/dist/rest/v1/app/app-api.js +1 -1
  115. package/dist/rest/v1/callbacks/callbacks-webhook.d.ts +0 -1
  116. package/dist/rest/v1/callbacks/callbacks-webhook.js +3 -0
  117. package/dist/rest/v1/callbacks/callbacks-webhook.js.map +1 -1
  118. package/dist/rest/v1/capability/capability-api.jest.fixture.d.ts +0 -1
  119. package/dist/rest/v1/contact/contact-api.d.ts +1 -1
  120. package/dist/rest/v1/contact/contact-api.jest.fixture.d.ts +0 -1
  121. package/dist/rest/v1/contact/contact-api.js +1 -1
  122. package/dist/rest/v1/conversation/conversation-api.d.ts +1 -1
  123. package/dist/rest/v1/conversation/conversation-api.jest.fixture.d.ts +0 -1
  124. package/dist/rest/v1/conversation/conversation-api.js +1 -1
  125. package/dist/rest/v1/conversation-domain-api.d.ts +1 -0
  126. package/dist/rest/v1/conversation-domain-api.js +22 -1
  127. package/dist/rest/v1/conversation-domain-api.js.map +1 -1
  128. package/dist/rest/v1/events/events-api.jest.fixture.d.ts +0 -1
  129. package/dist/rest/v1/messages/messages-api.d.ts +1 -1
  130. package/dist/rest/v1/messages/messages-api.jest.fixture.d.ts +0 -1
  131. package/dist/rest/v1/messages/messages-api.js +1 -1
  132. package/dist/rest/v1/templates-v1/templates-v1-api.jest.fixture.d.ts +0 -1
  133. package/dist/rest/v1/templates-v2/templates-v2-api.jest.fixture.d.ts +0 -1
  134. package/dist/rest/v1/transcoding/transcoding-api.jest.fixture.d.ts +0 -1
  135. package/dist/rest/v1/webhooks/webhooks-api.jest.fixture.d.ts +0 -1
  136. package/package.json +2 -2
  137. package/dist/models/v1/flow-channel-specific-message/flow-channel-specific-message.d.ts +0 -37
  138. package/dist/models/v1/flow-channel-specific-message/flow-channel-specific-message.js.map +0 -1
  139. package/dist/models/v1/flow-channel-specific-message/index.d.ts +0 -1
  140. package/dist/models/v1/flow-channel-specific-message/index.js.map +0 -1
  141. package/dist/models/v1/media-carousel-message/index.d.ts +0 -1
  142. package/dist/models/v1/media-carousel-message/index.js.map +0 -1
  143. package/dist/models/v1/media-carousel-message/media-carousel-message.d.ts +0 -7
  144. package/dist/models/v1/media-carousel-message/media-carousel-message.js.map +0 -1
  145. package/dist/models/v1/whatsapp-interactive-body/index.js.map +0 -1
  146. package/dist/models/v1/whatsapp-interactive-body/whatsapp-interactive-body.js.map +0 -1
  147. package/dist/models/v1/whatsapp-interactive-document-header/index.js.map +0 -1
  148. package/dist/models/v1/whatsapp-interactive-document-header/whatsapp-interactive-document-header.js.map +0 -1
  149. package/dist/models/v1/whatsapp-interactive-footer/index.js.map +0 -1
  150. package/dist/models/v1/whatsapp-interactive-footer/whatsapp-interactive-footer.js.map +0 -1
  151. package/dist/models/v1/whatsapp-interactive-header-media/index.js.map +0 -1
  152. package/dist/models/v1/whatsapp-interactive-header-media/whatsapp-interactive-header-media.js.map +0 -1
  153. package/dist/models/v1/whatsapp-interactive-image-header/index.js.map +0 -1
  154. package/dist/models/v1/whatsapp-interactive-image-header/whatsapp-interactive-image-header.js.map +0 -1
  155. package/dist/models/v1/whatsapp-interactive-text-header/index.js.map +0 -1
  156. package/dist/models/v1/whatsapp-interactive-text-header/whatsapp-interactive-text-header.js.map +0 -1
  157. package/dist/models/v1/whatsapp-interactive-video-header/index.js.map +0 -1
  158. package/dist/models/v1/whatsapp-interactive-video-header/whatsapp-interactive-video-header.js.map +0 -1
  159. /package/dist/models/v1/{flow-channel-specific-message → mod-credentials/line-enterprise-credentials}/index.js +0 -0
  160. /package/dist/models/v1/{media-carousel-message → whatsapp-flow}/index.js +0 -0
  161. /package/dist/models/v1/{whatsapp-interactive-document-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header}/index.d.ts +0 -0
  162. /package/dist/models/v1/{whatsapp-interactive-body → whatsapp-interactive-message-base/common/header/whatsapp-interactive-document-header}/index.js +0 -0
  163. /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
  164. /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
  165. /package/dist/models/v1/{whatsapp-interactive-header-media → whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media}/index.d.ts +0 -0
  166. /package/dist/models/v1/{whatsapp-interactive-document-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-header-media}/index.js +0 -0
  167. /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
  168. /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
  169. /package/dist/models/v1/{whatsapp-interactive-image-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header}/index.d.ts +0 -0
  170. /package/dist/models/v1/{whatsapp-interactive-footer → whatsapp-interactive-message-base/common/header/whatsapp-interactive-image-header}/index.js +0 -0
  171. /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
  172. /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
  173. /package/dist/models/v1/{whatsapp-interactive-text-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header}/index.d.ts +0 -0
  174. /package/dist/models/v1/{whatsapp-interactive-header-media → whatsapp-interactive-message-base/common/header/whatsapp-interactive-text-header}/index.js +0 -0
  175. /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
  176. /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
  177. /package/dist/models/v1/{whatsapp-interactive-video-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header}/index.d.ts +0 -0
  178. /package/dist/models/v1/{whatsapp-interactive-image-header → whatsapp-interactive-message-base/common/header/whatsapp-interactive-video-header}/index.js +0 -0
  179. /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
  180. /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
  181. /package/dist/models/v1/{whatsapp-interactive-body → whatsapp-interactive-message-base/common/whatsapp-interactive-body}/index.d.ts +0 -0
  182. /package/dist/models/v1/{whatsapp-interactive-text-header → whatsapp-interactive-message-base/common/whatsapp-interactive-body}/index.js +0 -0
  183. /package/dist/models/v1/{whatsapp-interactive-body → whatsapp-interactive-message-base/common/whatsapp-interactive-body}/whatsapp-interactive-body.d.ts +0 -0
  184. /package/dist/models/v1/{whatsapp-interactive-body → whatsapp-interactive-message-base/common/whatsapp-interactive-body}/whatsapp-interactive-body.js +0 -0
  185. /package/dist/models/v1/{whatsapp-interactive-footer → whatsapp-interactive-message-base/common/whatsapp-interactive-footer}/index.d.ts +0 -0
  186. /package/dist/models/v1/{whatsapp-interactive-video-header → whatsapp-interactive-message-base/common/whatsapp-interactive-footer}/index.js +0 -0
  187. /package/dist/models/v1/{whatsapp-interactive-footer → whatsapp-interactive-message-base/common/whatsapp-interactive-footer}/whatsapp-interactive-footer.d.ts +0 -0
  188. /package/dist/models/v1/{whatsapp-interactive-footer → whatsapp-interactive-message-base/common/whatsapp-interactive-footer}/whatsapp-interactive-footer.js +0 -0
package/dist/index.js CHANGED
@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
15
15
  }) : function(o, v) {
16
16
  o["default"] = v;
17
17
  });
18
- var __importStar = (this && this.__importStar) || function (mod) {
19
- if (mod && mod.__esModule) return mod;
20
- var result = {};
21
- if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
22
- __setModuleDefault(result, mod);
23
- return result;
24
- };
18
+ var __importStar = (this && this.__importStar) || (function () {
19
+ var ownKeys = function(o) {
20
+ ownKeys = Object.getOwnPropertyNames || function (o) {
21
+ var ar = [];
22
+ for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
23
+ return ar;
24
+ };
25
+ return ownKeys(o);
26
+ };
27
+ return function (mod) {
28
+ if (mod && mod.__esModule) return mod;
29
+ var result = {};
30
+ if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
31
+ __setModuleDefault(result, mod);
32
+ return result;
33
+ };
34
+ })();
25
35
  var __exportStar = (this && this.__exportStar) || function(m, exports) {
26
36
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
27
37
  };
package/dist/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAyC;AACzC,yCAAuB;AACvB,oDAAkC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,yDAAyC;AACzC,yCAAuB;AACvB,oDAAkC"}
@@ -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;
@@ -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,8 @@ export interface CardMessageItem {
15
18
  description?: string;
16
19
  /** @see CardHeight */
17
20
  height?: CardHeight;
18
- /** @see MediaCarouselMessage */
19
- media_message?: MediaCarouselMessage;
21
+ /** @see MediaProperties */
22
+ media_message?: MediaProperties;
20
23
  /** The title of the card message. */
21
24
  title?: string;
22
25
  }
@@ -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[];
@@ -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,25 @@
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';
2
4
  /**
3
5
  * A message containing a channel specific message (not supported by OMNI types).
4
6
  */
5
- export type ChannelSpecificMessage = WhatsAppFlowMessage;
7
+ export type ChannelSpecificMessage = WhatsAppFlowMessage | WhatsAppPaymentOrderDetailsMessage | WhatsAppPaymentOrderStatusMessage;
6
8
  export interface WhatsAppFlowMessage {
7
- /** @see MessageTypeEnum */
9
+ /** The type of the channel specific message. */
8
10
  message_type: 'FLOWS';
9
- /** @see FlowChannelSpecificMessage */
10
- message: FlowChannelSpecificMessage;
11
+ /** @see WhatsAppFlow */
12
+ message: WhatsAppFlow;
13
+ }
14
+ export interface WhatsAppPaymentOrderDetailsMessage {
15
+ /** The type of the channel specific message. */
16
+ message_type: 'ORDER_DETAILS';
17
+ /** @see WhatsappPaymentOrderDetails */
18
+ message: WhatsAppPaymentOrderDetails;
19
+ }
20
+ export interface WhatsAppPaymentOrderStatusMessage {
21
+ /** The type of the channel specific message. */
22
+ message_type: 'ORDER_STATUS';
23
+ /** @see WhatsAppPaymentOrderStatus */
24
+ message: WhatsAppPaymentOrderStatus;
11
25
  }
@@ -1 +1 @@
1
- export type { ChannelSpecificMessage, WhatsAppFlowMessage } from './channel-specific-message';
1
+ export type { ChannelSpecificMessage, WhatsAppFlowMessage, WhatsAppPaymentOrderDetailsMessage, WhatsAppPaymentOrderStatusMessage, } from './channel-specific-message';
@@ -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
+ /** @see MediaProperties */
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
  }
@@ -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
  }
@@ -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';
@@ -1,12 +1,13 @@
1
1
  import { AppleBcCredentials, InstagramCredentials, KakaoTalkChatCredentials, KakaoTalkCredentials, LineCredentials, MMSCredentials, StaticBearerCredential, StaticTokenCredential, TelegramCredentials, WeChatCredentials } from '../mod-credentials';
2
+ import { LineEnterpriseCredentials } from '../mod-credentials/line-enterprise-credentials';
2
3
  /**
3
4
  * Enables access to the underlying messaging channel.
4
5
  */
5
- export type ConversationChannelCredentialRequest = ChannelCredentialsAppleBC | ChannelCredentialsInstagram | ChannelCredentialsKakaoTalk | ChannelCredentialsKakaoTalkChat | ChannelCredentialsLine | ChannelCredentialsMessenger | ChannelCredentialsMms | ChannelCredentialsRcs | ChannelCredentialsSms | ChannelCredentialsTelegram | ChannelCredentialsViber | ChannelCredentialsViberBM | ChannelCredentialsWeChat | ChannelCredentialsWhatsApp;
6
+ export type ConversationChannelCredentialRequest = ChannelCredentialsAppleBC | ChannelCredentialsInstagram | ChannelCredentialsKakaoTalk | ChannelCredentialsKakaoTalkChat | ChannelCredentialsLine | ChannelCredentialsLineEnterprise | ChannelCredentialsMessenger | ChannelCredentialsMms | ChannelCredentialsRcs | ChannelCredentialsSms | ChannelCredentialsTelegram | ChannelCredentialsViber | ChannelCredentialsViberBM | ChannelCredentialsWeChat | ChannelCredentialsWhatsApp;
6
7
  /**
7
8
  * Enables access to the underlying messaging channel.
8
9
  */
9
- export type ConversationChannelCredentialResponse = ChannelCredentialsAppleBCResponse | ChannelCredentialsInstagramResponse | ChannelCredentialsKakaoTalkResponse | ChannelCredentialsKakaoTalkChatResponse | ChannelCredentialsLineResponse | ChannelCredentialsMessengerResponse | ChannelCredentialsMmsResponse | ChannelCredentialsRcsResponse | ChannelCredentialsSmsResponse | ChannelCredentialsTelegramResponse | ChannelCredentialsViberResponse | ChannelCredentialsViberBMResponse | ChannelCredentialsWeChatResponse | ChannelCredentialsWhatsAppResponse;
10
+ export type ConversationChannelCredentialResponse = ChannelCredentialsAppleBCResponse | ChannelCredentialsInstagramResponse | ChannelCredentialsKakaoTalkResponse | ChannelCredentialsKakaoTalkChatResponse | ChannelCredentialsLineResponse | ChannelCredentialsLineEnterpriseResponse | ChannelCredentialsMessengerResponse | ChannelCredentialsMmsResponse | ChannelCredentialsRcsResponse | ChannelCredentialsSmsResponse | ChannelCredentialsTelegramResponse | ChannelCredentialsViberResponse | ChannelCredentialsViberBMResponse | ChannelCredentialsWeChatResponse | ChannelCredentialsWhatsAppResponse;
10
11
  export interface ChannelCredentialsWhatsApp extends ConversationChannelCredentialRequestBase {
11
12
  channel: 'WHATSAPP';
12
13
  /** @see StaticBearerCredential */
@@ -93,6 +94,13 @@ export interface ChannelCredentialsLine extends ConversationChannelCredentialReq
93
94
  }
94
95
  export interface ChannelCredentialsLineResponse extends ChannelCredentialsLine, ConversationChannelCredentialResponseBase {
95
96
  }
97
+ export interface ChannelCredentialsLineEnterprise extends ConversationChannelCredentialRequestBase {
98
+ channel: 'LINE';
99
+ /** @see LineCredentials */
100
+ line_enterprise_credentials: LineEnterpriseCredentials;
101
+ }
102
+ export interface ChannelCredentialsLineEnterpriseResponse extends ChannelCredentialsLineEnterprise, ConversationChannelCredentialResponseBase {
103
+ }
96
104
  export interface ChannelCredentialsWeChat extends ConversationChannelCredentialRequestBase {
97
105
  channel: 'WECHAT';
98
106
  /** @see WeChatCredentials */
@@ -110,15 +118,19 @@ export interface ChannelCredentialsAppleBCResponse extends ChannelCredentialsApp
110
118
  interface ConversationChannelCredentialRequestBase {
111
119
  /** The secret used to verify the channel callbacks for channels which support callback verification. The callback verification is not needed for Sinch-managed channels because the callbacks are not leaving Sinch internal networks. Max length is 256 characters. Note: leaving channel_callback_secret empty for channels with callback verification will disable the verification. */
112
120
  callback_secret?: string;
121
+ /** The ordinal number of the credential. This field is used when the application supports multiple credential integrations per channel. Currently, this is only applicable to the `LINE` channel. For other channels, this value will always be set to `0`. In the case in which there are multiple credential integrations per channel on a single app, this field must have a unique value for each multi-credential channel entry. */
122
+ credential_ordinal_number?: number;
113
123
  }
114
124
  interface ConversationChannelCredentialResponseBase {
115
125
  /**
116
- * Output only. The state of the channel credentials integration.
126
+ * The state of the channel credentials integration.
117
127
  * When a channel is activated, the user is prompted for credentials that must be validated and in some cases exchanged by a long-lived token (Instagram).
118
128
  */
119
129
  state?: ChannelIntegrationState;
120
- /** Output only. Additional identifier set by the channel that represents a specific id used by the channel. */
130
+ /** Additional identifier set by the channel that represents a specific id used by the channel. */
121
131
  channel_known_id?: string;
132
+ /** The ordinal number of the credential. This field is used when the application supports multiple credential integrations per channel. Currently, this is only applicable to the `LINE` channel. For other channels, this value will always be set to `0`. In the case in which there are multiple credential integrations per channel on a single app, this field must have a unique value for each multi-credential channel entry. */
133
+ credential_ordinal_number?: number;
122
134
  }
123
135
  export interface ChannelIntegrationState {
124
136
  /**
@@ -1 +1 @@
1
- export type { ConversationChannelCredentialResponse, ChannelIntegrationState, ChannelCredentialsAppleBC, ChannelCredentialsInstagram, ChannelCredentialsKakaoTalk, ChannelCredentialsKakaoTalkChat, ChannelCredentialsLine, ChannelCredentialsMessenger, ChannelCredentialsMms, ChannelCredentialsRcs, ChannelCredentialsSms, ChannelCredentialsTelegram, ChannelCredentialsViber, ChannelCredentialsViberBM, ChannelCredentialsWeChat, ChannelCredentialsWhatsApp, ChannelCredentialsSmsWithBearer, ConversationChannelCredentialRequest, ChannelCredentialsAppleBCResponse, ChannelCredentialsInstagramResponse, ChannelCredentialsKakaoTalkResponse, ChannelCredentialsKakaoTalkChatResponse, ChannelCredentialsLineResponse, ChannelCredentialsMessengerResponse, ChannelCredentialsMmsResponse, ChannelCredentialsRcsResponse, ChannelCredentialsSmsResponse, ChannelCredentialsTelegramResponse, ChannelCredentialsViberResponse, ChannelCredentialsViberBMResponse, ChannelCredentialsWeChatResponse, ChannelCredentialsWhatsAppResponse, ChannelCredentialsSmsWithBearerResponse, } from './conversation-channel-credential';
1
+ export type { ConversationChannelCredentialResponse, ChannelIntegrationState, ChannelCredentialsAppleBC, ChannelCredentialsInstagram, ChannelCredentialsKakaoTalk, ChannelCredentialsKakaoTalkChat, ChannelCredentialsLine, ChannelCredentialsLineEnterprise, ChannelCredentialsMessenger, ChannelCredentialsMms, ChannelCredentialsRcs, ChannelCredentialsSms, ChannelCredentialsTelegram, ChannelCredentialsViber, ChannelCredentialsViberBM, ChannelCredentialsWeChat, ChannelCredentialsWhatsApp, ChannelCredentialsSmsWithBearer, ConversationChannelCredentialRequest, ChannelCredentialsAppleBCResponse, ChannelCredentialsInstagramResponse, ChannelCredentialsKakaoTalkResponse, ChannelCredentialsKakaoTalkChatResponse, ChannelCredentialsLineResponse, ChannelCredentialsLineEnterpriseResponse, ChannelCredentialsMessengerResponse, ChannelCredentialsMmsResponse, ChannelCredentialsRcsResponse, ChannelCredentialsSmsResponse, ChannelCredentialsTelegramResponse, ChannelCredentialsViberResponse, ChannelCredentialsViberBMResponse, ChannelCredentialsWeChatResponse, ChannelCredentialsWhatsAppResponse, ChannelCredentialsSmsWithBearerResponse, } from './conversation-channel-credential';
@@ -18,7 +18,7 @@ interface ConversationEventBase {
18
18
  contact_id?: string;
19
19
  /** @see ChannelIdentity */
20
20
  channel_identity: ChannelIdentity;
21
- /** */
21
+ /** The processed time of the message in UTC timezone. Must be less than current_time and greater than (current_time - 30 days). */
22
22
  accept_time?: Date;
23
23
  /** Whether or not Conversation API should store contacts and conversations for the app. For more information, see [Processing Modes](../../../../../conversation/processing-modes/). */
24
24
  processing_mode: ProcessingMode;
@@ -27,7 +27,7 @@ interface ConversationMessageBase {
27
27
  sender_id?: string;
28
28
  /** Output only. The processing mode. */
29
29
  processing_mode?: ProcessingMode;
30
- /** The status of the message, eventTime of the status and reason if status is failed */
30
+ /** @deprecated The status of the message, eventTime of the status and reason if status is failed */
31
31
  message_status?: MessageStatus | null;
32
32
  }
33
33
  interface MessageStatus {
@@ -11,8 +11,14 @@ export interface CreateConversationRequest {
11
11
  app_id: string;
12
12
  /** The ID of the participating contact. */
13
13
  contact_id: string;
14
- /** Arbitrary data set by the Conversation API clients. Up to 1024 characters long. */
14
+ /**
15
+ * Arbitrary data set by the Conversation API clients. Up to 1024 characters long.
16
+ * NOTE: This field has been deprecated due to changes in the system architecture or functionality.
17
+ * @deprecated It is no longer actively maintained and may be removed in future versions. Please avoid relying on this field in new code.
18
+ */
15
19
  metadata?: string;
16
20
  /** Arbitrary data set by the Conversation API clients and/or provided in the `conversation_metadata` field of a SendMessageRequest. A valid JSON object. */
17
21
  metadata_json?: object;
22
+ /** Arbitrary correlation ID related to the MT message set by the Conversation API user. */
23
+ correlation_id?: string;
18
24
  }
@@ -1,5 +1,5 @@
1
1
  /**
2
- * This object contains additional settings related to [delivery report based fallback](../../../../../conversation/keyconcepts/#delivery-report-base-message-fallback). Note that this **paid** functionality is available for open beta testing.
2
+ * This object contains additional settings related to [delivery report based fallback](https://developers.sinch.com/docs/conversation/keyconcepts/#delivery-report-base-message-fallback). Note that this **paid** functionality is available for open beta testing.
3
3
  */
4
4
  export interface DeliveryReportBasedFallback {
5
5
  /**
@@ -1,10 +1,10 @@
1
1
  import { DispatchRetentionPolicyType } from '../enums';
2
2
  /**
3
- * The retention policy configured for messages in [Dispatch Mode](../../../../../conversation/processing-modes/). Currently only `MESSAGE_EXPIRE_POLICY` is available. For more information about retention policies, see [Retention Policy](/docs/conversation/keyconcepts/#retention-policy).
3
+ * The retention policy configured for messages in [Dispatch Mode](https://developers.sinch.com/docs/conversation/processing-modes/). Currently only `MESSAGE_EXPIRE_POLICY` is available. For more information about retention policies, see [Retention Policy](https://developers.sinch.com/docs/conversation/keyconcepts/#retention-policy).
4
4
  */
5
5
  export interface DispatchRetentionPolicy {
6
6
  /** @see DispatchRetentionPolicyType */
7
7
  retention_type?: DispatchRetentionPolicyType;
8
- /** Optional. The days before a message is eligible for deletion. The valid range is `[0 - 7]`. In the case of a `0` day TTL, messages aren\'t stored at all. Note the retention cleanup job runs once every twenty-four hours, so messages are not deleted on the minute they become eligible for deletion. */
8
+ /** Optional. The days before a message is eligible for deletion. The valid range is `[0 - 7]`. In the case of a `0` day TTL, messages aren't stored at all. Note the retention cleanup job runs once every twenty-four hours, so messages are not deleted on the minute they become eligible for deletion. */
9
9
  ttl_days?: number;
10
10
  }
@@ -2,26 +2,35 @@
2
2
  * NONE - Omit metadata.
3
3
  * FULL - Include all metadata assigned to the conversation.
4
4
  */
5
- export type ConversationMetadataReportView = 'NONE' | 'FULL';
6
- export type ConversationMetadataUpdateStrategy = 'REPLACE' | 'MERGE_PATCH';
5
+ export type ConversationMetadataReportView = 'NONE' | 'FULL' | string;
6
+ /**
7
+ * Update strategy for the `conversation_metadata` field. Only supported in `CONVERSATION` processing mode.
8
+ */
9
+ export type ConversationMetadataUpdateStrategy = 'REPLACE' | 'MERGE_PATCH' | string;
7
10
  /**
8
11
  * You can set the desired size of the card in the message.
9
12
  */
10
- export type CardHeight = 'UNSPECIFIED_HEIGHT' | 'SHORT' | 'MEDIUM' | 'TALL';
11
- export type ConversationDirection = 'UNDEFINED_DIRECTION' | 'TO_APP' | 'TO_CONTACT';
12
- export type ConversationMergeStrategy = 'MERGE';
13
- export type ConversationMessagesView = 'WITH_METADATA' | 'WITHOUT_METADATA';
14
- export type DeliveryStatus = 'QUEUED_ON_CHANNEL' | 'DELIVERED' | 'READ' | 'FAILED' | 'SWITCHING_CHANNEL';
15
- export type DispatchRetentionPolicyType = 'MESSAGE_EXPIRE_POLICY';
13
+ export type CardHeight = 'UNSPECIFIED_HEIGHT' | 'SHORT' | 'MEDIUM' | 'TALL' | string;
14
+ export type ConversationDirection = 'UNDEFINED_DIRECTION' | 'TO_APP' | 'TO_CONTACT' | string;
15
+ export type ConversationMergeStrategy = 'MERGE' | string;
16
+ export type ConversationMessagesView = 'WITH_METADATA' | 'WITHOUT_METADATA' | string;
17
+ export type DeliveryStatus = 'QUEUED_ON_CHANNEL' | 'DELIVERED' | 'READ' | 'FAILED' | 'SWITCHING_CHANNEL' | string;
18
+ export type DispatchRetentionPolicyType = 'MESSAGE_EXPIRE_POLICY' | string;
16
19
  /**
17
20
  * The channel. Must be one of the supported channels for this operation.
18
21
  */
19
- export type GetChannelProfileConversationChannel = 'MESSENGER' | 'INSTAGRAM' | 'VIBER' | 'LINE';
22
+ export type GetChannelProfileConversationChannel = 'MESSENGER' | 'INSTAGRAM' | 'VIBER' | 'LINE' | string;
20
23
  /**
21
24
  * Select the priority type for the message
22
25
  */
23
- export type MessageQueue = 'NORMAL_PRIORITY' | 'HIGH_PRIORITY';
24
- export type ProcessingMode = 'CONVERSATION' | 'DISPATCH';
25
- export type ProcessingStrategy = 'DEFAULT' | 'DISPATCH_ONLY';
26
- export type WebhookTargetType = 'DISMISS' | 'HTTP';
27
- export type MessageSource = 'CONVERSATION_SOURCE' | 'DISPATCH_SOURCE';
26
+ export type MessageQueue = 'NORMAL_PRIORITY' | 'HIGH_PRIORITY' | string;
27
+ /**
28
+ * Whether or not Conversation API should store contacts and conversations for the app. For more information, see [Processing Modes](https://developers.sinch.com/docs/conversation/processing-modes/).
29
+ */
30
+ export type ProcessingMode = 'CONVERSATION' | 'DISPATCH' | string;
31
+ /**
32
+ * Overrides the app's [Processing Mode](https://developers.sinch.com/docs/conversation/processing-modes/). Default value is `DEFAULT`.
33
+ */
34
+ export type ProcessingStrategy = 'DEFAULT' | 'DISPATCH_ONLY' | string;
35
+ export type WebhookTargetType = 'DISMISS' | 'HTTP' | string;
36
+ export type MessageSource = 'CONVERSATION_SOURCE' | 'DISPATCH_SOURCE' | string;
@@ -4,7 +4,7 @@ import { CarouselMessage, CarouselMessageItem } from './carousel-message';
4
4
  import { ChoiceMessage, ChoiceMessageItem } from './choice-message';
5
5
  import { ContactInfoMessage, ContactInfoMessageItem } from './contact-info-message';
6
6
  import { LocationMessage, LocationMessageItem } from './location-message';
7
- import { MediaMessage, MediaMessageItem } from './media-message';
7
+ import { MediaMessage, MediaProperties } from './media-message';
8
8
  import { TemplateMessage, TemplateMessageItem } from './template-message';
9
9
  import { ListMessage, ListMessageItem } from './list-message';
10
10
  import { V2TemplateTranslation } from './v2-template-translation';
@@ -17,7 +17,7 @@ export declare const messageBuilder: {
17
17
  contactInfo: (contactInfoMessageItem: ContactInfoMessageItem) => ContactInfoMessage;
18
18
  list: (listMessageItem: ListMessageItem) => ListMessage;
19
19
  location: (locationMessageItem: LocationMessageItem) => LocationMessage;
20
- media: (mediaMessageItem: MediaMessageItem) => MediaMessage;
20
+ media: (mediaMessageItem: MediaProperties) => MediaMessage;
21
21
  template: (templateMessageItem: TemplateMessageItem) => TemplateMessage;
22
22
  text: (textMessageItem: TextMessageItem) => TextMessage;
23
23
  };
@@ -28,7 +28,7 @@ export declare const templateV1Helper: {
28
28
  buildChoiceMessageContent: (choiceMessageItem: ChoiceMessageItem) => string;
29
29
  buildContactInfoMessageContent: (contactInfoMessageItem: ContactInfoMessageItem) => string;
30
30
  buildLocationMessageContent: (locationMessageItem: LocationMessageItem) => string;
31
- buildMediaMessageContent: (mediaMessageItem: MediaMessageItem) => string;
31
+ buildMediaMessageContent: (mediaMessageItem: MediaProperties) => string;
32
32
  buildTemplateMessageContent: (templateMessageItem: TemplateMessageItem) => string;
33
33
  buildListMessageContent: (listMessageItem: ListMessageItem) => string;
34
34
  };
@@ -39,7 +39,7 @@ export declare const templateV2Helper: {
39
39
  buildChoiceMessageContent: (choiceMessageItem: ChoiceMessageItem) => ChoiceMessage;
40
40
  buildContactInfoMessageContent: (contactInfoMessageItem: ContactInfoMessageItem) => ContactInfoMessage;
41
41
  buildLocationMessageContent: (locationMessageItem: LocationMessageItem) => LocationMessage;
42
- buildMediaMessageContent: (mediaMessageItem: MediaMessageItem) => MediaMessage;
42
+ buildMediaMessageContent: (mediaMessageItem: MediaProperties) => MediaMessage;
43
43
  buildTemplateMessageContent: (templateMessageItem: TemplateMessageItem) => TemplateMessage;
44
44
  buildListMessageContent: (listMessageItem: ListMessageItem) => ListMessage;
45
45
  getMessageFromTranslation: (translation: V2TemplateTranslation) => {
@@ -62,7 +62,7 @@ export declare const templateV2Helper: {
62
62
  content: LocationMessageItem | undefined;
63
63
  } | {
64
64
  type: MessageType;
65
- content: MediaMessageItem | undefined;
65
+ content: MediaProperties | undefined;
66
66
  } | {
67
67
  type: MessageType;
68
68
  content: TemplateMessageItem | undefined;
@@ -1 +1 @@
1
- {"version":3,"file":"helper.js","sourceRoot":"","sources":["../../../src/models/v1/helper.ts"],"names":[],"mappings":";;;AAaa,QAAA,cAAc,GAAG;IAC5B,IAAI,EAAE,CAAC,eAAgC,EAAe,EAAE;QACtD,OAAO;YACL,YAAY,EAAE,eAAe;SACf,CAAC;IACnB,CAAC;IACD,QAAQ,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACtE,OAAO;YACL,gBAAgB,EAAE,mBAAmB;SACnB,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,CAAC,iBAAoC,EAAiB,EAAE;QAC9D,OAAO;YACL,cAAc,EAAE,iBAAiB;SACjB,CAAC;IACrB,CAAC;IACD,WAAW,EAAE,CAAC,sBAA8C,EAAsB,EAAE;QAClF,OAAO;YACL,oBAAoB,EAAE,sBAAsB;SACvB,CAAC;IAC1B,CAAC;IACD,IAAI,EAAE,CAAC,eAAgC,EAAe,EAAE;QACtD,OAAO;YACL,YAAY,EAAE,eAAe;SACf,CAAC;IACnB,CAAC;IACD,QAAQ,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACtE,OAAO;YACL,gBAAgB,EAAE,mBAAmB;SACnB,CAAC;IACvB,CAAC;IACD,KAAK,EAAE,CAAC,gBAAkC,EAAgB,EAAE;QAC1D,OAAO;YACL,aAAa,EAAE,gBAAgB;SAChB,CAAC;IACpB,CAAC;IACD,QAAQ,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACtE,OAAO;YACL,gBAAgB,EAAE,mBAAmB;SACnB,CAAC;IACvB,CAAC;IACD,IAAI,EAAE,CAAC,eAAgC,EAAe,EAAE;QACtD,OAAO;YACL,YAAY,EAAE,eAAe;SACf,CAAC;IACnB,CAAC;CACF,CAAC;AAEW,QAAA,gBAAgB,GAAG;IAC9B,uBAAuB,EAAE,CAAC,eAAgC,EAAU,EAAE;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAU,EAAE;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAU,EAAE;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,yBAAyB,EAAE,CAAC,iBAAoC,EAAU,EAAE;QAC1E,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,8BAA8B,EAAE,CAAC,sBAA8C,EAAU,EAAE;QACzF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC5E,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAU,EAAE;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,wBAAwB,EAAE,CAAC,gBAAkC,EAAU,EAAE;QACvE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAU,EAAE;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAU,EAAE;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF,CAAC;AAEW,QAAA,gBAAgB,GAAG;IAC9B,cAAc;IACd,uBAAuB,EAAE,CAAC,eAAgC,EAAe,EAAE;QACzE,OAAO,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAe,EAAE;QACzE,OAAO,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACzF,OAAO,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IACD,yBAAyB,EAAE,CAAC,iBAAoC,EAAiB,EAAE;QACjF,OAAO,sBAAc,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAClD,CAAC;IACD,8BAA8B,EAAE,CAAC,sBAA8C,EAAsB,EAAE;QACrG,OAAO,sBAAc,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAC5D,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACzF,OAAO,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IACD,wBAAwB,EAAE,CAAC,gBAAkC,EAAgB,EAAE;QAC7E,OAAO,sBAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAChD,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACzF,OAAO,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAe,EAAE;QACzE,OAAO,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IACD,yBAAyB,EAAE,CAAC,WAAkC,EAAE,EAAE;QAChE,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;YAClC,OAAO;gBACL,IAAI,sCAAkB;gBACtB,OAAO,EAAE,WAAW,CAAC,YAAY;aAClC,CAAC;QACJ,CAAC;aAAM,IAAI,kBAAkB,IAAI,WAAW,EAAE,CAAC;YAC7C,OAAO;gBACL,IAAI,8CAAsB;gBAC1B,OAAO,EAAE,WAAW,CAAC,gBAAgB;aACtC,CAAC;QACJ,CAAC;aAAM,IAAI,gBAAgB,IAAI,WAAW,EAAE,CAAC;YAC3C,OAAO;gBACL,IAAI,0CAAoB;gBACxB,OAAO,EAAE,WAAW,CAAC,cAAc;aACpC,CAAC;QACJ,CAAC;aAAM,IAAI,sBAAsB,IAAI,WAAW,EAAE,CAAC;YACjD,OAAO;gBACL,IAAI,qDAA0B;gBAC9B,OAAO,EAAE,WAAW,CAAC,oBAAoB;aAC1C,CAAC;QACJ,CAAC;aAAM,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;YACzC,OAAO;gBACL,IAAI,sCAAkB;gBACtB,OAAO,EAAE,WAAW,CAAC,YAAY;aAClC,CAAC;QACJ,CAAC;aAAM,IAAI,kBAAkB,IAAI,WAAW,EAAE,CAAC;YAC7C,OAAO;gBACL,IAAI,8CAAsB;gBAC1B,OAAO,EAAE,WAAW,CAAC,gBAAgB;aACtC,CAAC;QACJ,CAAC;aAAM,IAAI,eAAe,IAAI,WAAW,EAAE,CAAC;YAC1C,OAAO;gBACL,IAAI,wCAAmB;gBACvB,OAAO,EAAE,WAAW,CAAC,aAAa;aACnC,CAAC;QACJ,CAAC;aAAM,IAAI,kBAAkB,IAAI,WAAW,EAAE,CAAC;YAC7C,OAAO;gBACL,IAAI,8CAAsB;gBAC1B,OAAO,EAAE,WAAW,CAAC,gBAAgB;aACtC,CAAC;QACJ,CAAC;aAAM,IAAG,cAAc,IAAI,WAAW,EAAE,CAAC;YACxC,OAAO;gBACL,IAAI,sCAAkB;gBACtB,OAAO,EAAE,WAAW,CAAC,YAAY;aAClC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,IAAI,yCAAuB;gBAC3B,OAAO,EAAE,EAAE;aACZ,CAAC;QACJ,CAAC;IACH,CAAC;IACD,uBAAuB,EAAE,CAAC,YAAiD,EAAE,EAAE;QAC7E,IAAG,CAAC,YAAY,EAAE,CAAC;YACjB,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;CACF,CAAC;AAEW,QAAA,iBAAiB,GAAG;IAC/B,eAAe,EAAE,CAAC,UAAsB,EAAqB,EAAE;QAC7D,OAAO;YACL,MAAM,EAAE,UAAU;SACnB,CAAC;IACJ,CAAC;IACD,gBAAgB,EAAE,CAAC,WAAwB,EAAsB,EAAE;QACjE,OAAO;YACL,OAAO,EAAE,WAAW;SACrB,CAAC;IACJ,CAAC;CACF,CAAC"}
1
+ {"version":3,"file":"helper.js","sourceRoot":"","sources":["../../../src/models/v1/helper.ts"],"names":[],"mappings":";;;AAaa,QAAA,cAAc,GAAG;IAC5B,IAAI,EAAE,CAAC,eAAgC,EAAe,EAAE;QACtD,OAAO;YACL,YAAY,EAAE,eAAe;SACf,CAAC;IACnB,CAAC;IACD,QAAQ,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACtE,OAAO;YACL,gBAAgB,EAAE,mBAAmB;SACnB,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,CAAC,iBAAoC,EAAiB,EAAE;QAC9D,OAAO;YACL,cAAc,EAAE,iBAAiB;SACjB,CAAC;IACrB,CAAC;IACD,WAAW,EAAE,CAAC,sBAA8C,EAAsB,EAAE;QAClF,OAAO;YACL,oBAAoB,EAAE,sBAAsB;SACvB,CAAC;IAC1B,CAAC;IACD,IAAI,EAAE,CAAC,eAAgC,EAAe,EAAE;QACtD,OAAO;YACL,YAAY,EAAE,eAAe;SACf,CAAC;IACnB,CAAC;IACD,QAAQ,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACtE,OAAO;YACL,gBAAgB,EAAE,mBAAmB;SACnB,CAAC;IACvB,CAAC;IACD,KAAK,EAAE,CAAC,gBAAiC,EAAgB,EAAE;QACzD,OAAO;YACL,aAAa,EAAE,gBAAgB;SAChB,CAAC;IACpB,CAAC;IACD,QAAQ,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACtE,OAAO;YACL,gBAAgB,EAAE,mBAAmB;SACnB,CAAC;IACvB,CAAC;IACD,IAAI,EAAE,CAAC,eAAgC,EAAe,EAAE;QACtD,OAAO;YACL,YAAY,EAAE,eAAe;SACf,CAAC;IACnB,CAAC;CACF,CAAC;AAEW,QAAA,gBAAgB,GAAG;IAC9B,uBAAuB,EAAE,CAAC,eAAgC,EAAU,EAAE;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAU,EAAE;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAU,EAAE;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,yBAAyB,EAAE,CAAC,iBAAoC,EAAU,EAAE;QAC1E,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC,CAAC;IAClE,CAAC;IACD,8BAA8B,EAAE,CAAC,sBAA8C,EAAU,EAAE;QACzF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC,CAAC;IAC5E,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAU,EAAE;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,wBAAwB,EAAE,CAAC,gBAAiC,EAAU,EAAE;QACtE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAChE,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAU,EAAE;QAChF,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC,CAAC;IACtE,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAU,EAAE;QACpE,OAAO,IAAI,CAAC,SAAS,CAAC,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,CAAC;IAC9D,CAAC;CACF,CAAC;AAEW,QAAA,gBAAgB,GAAG;IAC9B,cAAc;IACd,uBAAuB,EAAE,CAAC,eAAgC,EAAe,EAAE;QACzE,OAAO,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAe,EAAE;QACzE,OAAO,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACzF,OAAO,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IACD,yBAAyB,EAAE,CAAC,iBAAoC,EAAiB,EAAE;QACjF,OAAO,sBAAc,CAAC,MAAM,CAAC,iBAAiB,CAAC,CAAC;IAClD,CAAC;IACD,8BAA8B,EAAE,CAAC,sBAA8C,EAAsB,EAAE;QACrG,OAAO,sBAAc,CAAC,WAAW,CAAC,sBAAsB,CAAC,CAAC;IAC5D,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACzF,OAAO,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IACD,wBAAwB,EAAE,CAAC,gBAAiC,EAAgB,EAAE;QAC5E,OAAO,sBAAc,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAChD,CAAC;IACD,2BAA2B,EAAE,CAAC,mBAAwC,EAAmB,EAAE;QACzF,OAAO,sBAAc,CAAC,QAAQ,CAAC,mBAAmB,CAAC,CAAC;IACtD,CAAC;IACD,uBAAuB,EAAE,CAAC,eAAgC,EAAe,EAAE;QACzE,OAAO,sBAAc,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAC9C,CAAC;IACD,yBAAyB,EAAE,CAAC,WAAkC,EAAE,EAAE;QAChE,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;YAClC,OAAO;gBACL,IAAI,sCAAkB;gBACtB,OAAO,EAAE,WAAW,CAAC,YAAY;aAClC,CAAC;QACJ,CAAC;aAAM,IAAI,kBAAkB,IAAI,WAAW,EAAE,CAAC;YAC7C,OAAO;gBACL,IAAI,8CAAsB;gBAC1B,OAAO,EAAE,WAAW,CAAC,gBAAgB;aACtC,CAAC;QACJ,CAAC;aAAM,IAAI,gBAAgB,IAAI,WAAW,EAAE,CAAC;YAC3C,OAAO;gBACL,IAAI,0CAAoB;gBACxB,OAAO,EAAE,WAAW,CAAC,cAAc;aACpC,CAAC;QACJ,CAAC;aAAM,IAAI,sBAAsB,IAAI,WAAW,EAAE,CAAC;YACjD,OAAO;gBACL,IAAI,qDAA0B;gBAC9B,OAAO,EAAE,WAAW,CAAC,oBAAoB;aAC1C,CAAC;QACJ,CAAC;aAAM,IAAI,cAAc,IAAI,WAAW,EAAE,CAAC;YACzC,OAAO;gBACL,IAAI,sCAAkB;gBACtB,OAAO,EAAE,WAAW,CAAC,YAAY;aAClC,CAAC;QACJ,CAAC;aAAM,IAAI,kBAAkB,IAAI,WAAW,EAAE,CAAC;YAC7C,OAAO;gBACL,IAAI,8CAAsB;gBAC1B,OAAO,EAAE,WAAW,CAAC,gBAAgB;aACtC,CAAC;QACJ,CAAC;aAAM,IAAI,eAAe,IAAI,WAAW,EAAE,CAAC;YAC1C,OAAO;gBACL,IAAI,wCAAmB;gBACvB,OAAO,EAAE,WAAW,CAAC,aAAa;aACnC,CAAC;QACJ,CAAC;aAAM,IAAI,kBAAkB,IAAI,WAAW,EAAE,CAAC;YAC7C,OAAO;gBACL,IAAI,8CAAsB;gBAC1B,OAAO,EAAE,WAAW,CAAC,gBAAgB;aACtC,CAAC;QACJ,CAAC;aAAM,IAAG,cAAc,IAAI,WAAW,EAAE,CAAC;YACxC,OAAO;gBACL,IAAI,sCAAkB;gBACtB,OAAO,EAAE,WAAW,CAAC,YAAY;aAClC,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,OAAO;gBACL,IAAI,yCAAuB;gBAC3B,OAAO,EAAE,EAAE;aACZ,CAAC;QACJ,CAAC;IACH,CAAC;IACD,uBAAuB,EAAE,CAAC,YAAiD,EAAE,EAAE;QAC7E,IAAG,CAAC,YAAY,EAAE,CAAC;YACjB,OAAO,EAAE,CAAC;QACZ,CAAC;aAAM,CAAC;YACN,OAAO,YAAY,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,OAAO,KAAK,QAAQ,CAAC,CAAC;QAChF,CAAC;IACH,CAAC;CACF,CAAC;AAEW,QAAA,iBAAiB,GAAG;IAC/B,eAAe,EAAE,CAAC,UAAsB,EAAqB,EAAE;QAC7D,OAAO;YACL,MAAM,EAAE,UAAU;SACnB,CAAC;IACJ,CAAC;IACD,gBAAgB,EAAE,CAAC,WAAwB,EAAsB,EAAE;QACjE,OAAO;YACL,OAAO,EAAE,WAAW;SACrB,CAAC;IACJ,CAAC;CACF,CAAC"}
@@ -2,10 +2,12 @@ import { ChannelRecipientIdentity } from '../channel-recipient-identity';
2
2
  /** Identifies the recipient of the message. Requires either contact_id or identified_by. If Dispatch Mode is used, only identified_by is allowed. */
3
3
  export interface IdentifiedBy {
4
4
  /** The identity as specified by the channel. */
5
- identified_by: IdentifiedByItem;
5
+ identified_by: ChannelIdentities;
6
6
  contact_id?: never;
7
7
  }
8
- export interface IdentifiedByItem {
8
+ export interface ChannelIdentities {
9
9
  /** A list of specific channel identities. The API will use these identities when sending to specific channels. */
10
10
  channel_identities: ChannelRecipientIdentity[];
11
11
  }
12
+ /** @deprecated */
13
+ export type IdentifiedByItem = ChannelIdentities;
@@ -1 +1 @@
1
- export type { IdentifiedBy, IdentifiedByItem } from './identified-by';
1
+ export type { IdentifiedBy, ChannelIdentities, IdentifiedByItem } from './identified-by';