sentdm 0.45.0 → 0.46.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 (476) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/README.md +11 -11
  4. data/lib/sentdm/client.rb +66 -0
  5. data/lib/sentdm/internal/sender_profiles_page.rb +140 -0
  6. data/lib/sentdm/internal/type/enum.rb +11 -11
  7. data/lib/sentdm/models/account.rb +173 -0
  8. data/lib/sentdm/models/account_channels.rb +39 -0
  9. data/lib/sentdm/models/account_profile.rb +86 -0
  10. data/lib/sentdm/models/account_rcs_channel.rb +26 -0
  11. data/lib/sentdm/models/account_sms_channel.rb +26 -0
  12. data/lib/sentdm/models/account_whatsapp_channel.rb +35 -0
  13. data/lib/sentdm/models/api_response_of_account.rb +48 -0
  14. data/lib/sentdm/models/api_response_of_cancelled_message.rb +43 -0
  15. data/lib/sentdm/models/api_response_of_channels_state.rb +48 -0
  16. data/lib/sentdm/models/api_response_of_compliance_requirements.rb +47 -0
  17. data/lib/sentdm/models/api_response_of_contacts_list.rb +42 -0
  18. data/lib/sentdm/models/api_response_of_message.rb +51 -0
  19. data/lib/sentdm/models/api_response_of_message_activities.rb +43 -0
  20. data/lib/sentdm/models/api_response_of_number_lookup_result.rb +43 -0
  21. data/lib/sentdm/models/api_response_of_profile_completion_accepted.rb +47 -0
  22. data/lib/sentdm/models/api_response_of_profile_completion_result.rb +47 -0
  23. data/lib/sentdm/models/api_response_of_profiles_list.rb +43 -0
  24. data/lib/sentdm/models/api_response_of_sender_profile.rb +54 -0
  25. data/lib/sentdm/models/api_response_of_sender_profiles_list.rb +42 -0
  26. data/lib/sentdm/models/api_response_of_templates_list.rb +42 -0
  27. data/lib/sentdm/models/api_response_of_users_list.rb +43 -0
  28. data/lib/sentdm/models/api_response_of_webhook_event_types_list.rb +43 -0
  29. data/lib/sentdm/models/api_response_of_webhook_events_list.rb +42 -0
  30. data/lib/sentdm/models/{webhook_rotate_secret_response.rb → api_response_of_webhook_secret.rb} +4 -17
  31. data/lib/sentdm/models/{webhook_test_response.rb → api_response_of_webhook_test.rb} +4 -23
  32. data/lib/sentdm/models/api_response_of_webhooks_list.rb +42 -0
  33. data/lib/sentdm/models/billing_contact.rb +35 -0
  34. data/lib/sentdm/models/brand_business.rb +96 -0
  35. data/lib/sentdm/models/brand_business_info.rb +3 -20
  36. data/lib/sentdm/models/brand_compliance.rb +75 -0
  37. data/lib/sentdm/models/brand_contact.rb +56 -0
  38. data/lib/sentdm/models/brand_with_kyc.rb +129 -0
  39. data/lib/sentdm/models/cancelled_message.rb +28 -0
  40. data/lib/sentdm/models/channel_event_payload.rb +3 -114
  41. data/lib/sentdm/models/channel_list_params.rb +20 -0
  42. data/lib/sentdm/models/channel_score.rb +35 -0
  43. data/lib/sentdm/models/channels/api_response_of_list_of_sms_market.rb +45 -0
  44. data/lib/sentdm/models/channels/api_response_of_rcs_agent.rb +60 -0
  45. data/lib/sentdm/models/channels/api_response_of_sms_market.rb +54 -0
  46. data/lib/sentdm/models/channels/api_response_of_whatsapp_channel.rb +47 -0
  47. data/lib/sentdm/models/channels/market_compliance.rb +409 -0
  48. data/lib/sentdm/models/channels/rc_create_params.rb +260 -0
  49. data/lib/sentdm/models/channels/rcs_address.rb +43 -0
  50. data/lib/sentdm/models/channels/rcs_agent.rb +278 -0
  51. data/lib/sentdm/models/channels/sms_create_params.rb +173 -0
  52. data/lib/sentdm/models/channels/sms_list_params.rb +22 -0
  53. data/lib/sentdm/models/channels/sms_market.rb +158 -0
  54. data/lib/sentdm/models/channels/sms_number.rb +41 -0
  55. data/lib/sentdm/models/channels/sms_number_request.rb +33 -0
  56. data/lib/sentdm/models/channels/sms_retrieve_params.rb +34 -0
  57. data/lib/sentdm/models/channels/sms_update_params.rb +64 -0
  58. data/lib/sentdm/models/channels/supplied_compliance.rb +89 -0
  59. data/lib/sentdm/models/channels/supplied_document.rb +35 -0
  60. data/lib/sentdm/models/channels/whatsapp_channel.rb +109 -0
  61. data/lib/sentdm/models/channels/whatsapp_create_params.rb +65 -0
  62. data/lib/sentdm/models/channels_state.rb +89 -0
  63. data/lib/sentdm/models/compliance_attachment_template.rb +36 -0
  64. data/lib/sentdm/models/compliance_requirement.rb +112 -0
  65. data/lib/sentdm/models/compliance_requirements.rb +98 -0
  66. data/lib/sentdm/models/compliance_retrieve_requirements_params.rb +52 -0
  67. data/lib/sentdm/models/compliance_setup_step.rb +78 -0
  68. data/lib/sentdm/models/contact_message_summary.rb +3 -34
  69. data/lib/sentdm/models/contacts_list.rb +26 -0
  70. data/lib/sentdm/models/conversation_messages_list.rb +3 -430
  71. data/lib/sentdm/models/entity_type.rb +18 -0
  72. data/lib/sentdm/models/inbound_media.rb +53 -0
  73. data/lib/sentdm/models/inbound_message_event_payload.rb +3 -53
  74. data/lib/sentdm/models/link_event.rb +79 -0
  75. data/lib/sentdm/models/link_event_payload.rb +211 -0
  76. data/lib/sentdm/models/message.rb +168 -0
  77. data/lib/sentdm/models/message_activities.rb +34 -0
  78. data/lib/sentdm/models/message_activity.rb +105 -0
  79. data/lib/sentdm/models/message_body.rb +79 -0
  80. data/lib/sentdm/models/message_button.rb +33 -0
  81. data/lib/sentdm/models/message_cancel_params.rb +32 -0
  82. data/lib/sentdm/models/message_channel_options.rb +43 -0
  83. data/lib/sentdm/models/message_header_media.rb +31 -0
  84. data/lib/sentdm/models/message_media.rb +74 -0
  85. data/lib/sentdm/models/message_recipient.rb +46 -0
  86. data/lib/sentdm/models/message_send_params.rb +6 -90
  87. data/lib/sentdm/models/message_send_response.rb +3 -95
  88. data/lib/sentdm/models/message_send_result.rb +55 -0
  89. data/lib/sentdm/models/message_status_event.rb +54 -0
  90. data/lib/sentdm/models/mms_market.rb +48 -0
  91. data/lib/sentdm/models/number_lookup_result.rb +63 -0
  92. data/lib/sentdm/models/pagination_cursors.rb +27 -0
  93. data/lib/sentdm/models/pagination_meta.rb +3 -27
  94. data/lib/sentdm/models/profile_completion_accepted.rb +20 -0
  95. data/lib/sentdm/models/profile_completion_result.rb +31 -0
  96. data/lib/sentdm/models/profile_detail.rb +6 -408
  97. data/lib/sentdm/models/profiles/brand_campaign.rb +3 -15
  98. data/lib/sentdm/models/profiles_list.rb +26 -0
  99. data/lib/sentdm/models/sender_profile.rb +138 -0
  100. data/lib/sentdm/models/sender_profile_billing.rb +21 -0
  101. data/lib/sentdm/models/sender_profile_billing_request.rb +33 -0
  102. data/lib/sentdm/models/sender_profile_channels.rb +90 -0
  103. data/lib/sentdm/models/sender_profile_create_params.rb +116 -0
  104. data/lib/sentdm/models/sender_profile_delete_params.rb +20 -0
  105. data/lib/sentdm/models/sender_profile_list_params.rb +30 -0
  106. data/lib/sentdm/models/sender_profile_rcs.rb +209 -0
  107. data/lib/sentdm/models/sender_profile_retrieve_params.rb +20 -0
  108. data/lib/sentdm/models/sender_profile_sms.rb +106 -0
  109. data/lib/sentdm/models/sender_profile_update_params.rb +71 -0
  110. data/lib/sentdm/models/sender_profile_whatsapp.rb +61 -0
  111. data/lib/sentdm/models/sender_profiles_list.rb +26 -0
  112. data/lib/sentdm/models/tcr_brand_identity_status.rb +17 -0
  113. data/lib/sentdm/models/tcr_brand_status.rb +16 -0
  114. data/lib/sentdm/models/tcr_campaign_status.rb +16 -0
  115. data/lib/sentdm/models/template_body.rb +3 -70
  116. data/lib/sentdm/models/template_header.rb +3 -37
  117. data/lib/sentdm/models/template_header_location.rb +38 -0
  118. data/lib/sentdm/models/template_media_item.rb +34 -0
  119. data/lib/sentdm/models/template_mms_body_content.rb +49 -0
  120. data/lib/sentdm/models/template_ref.rb +51 -0
  121. data/lib/sentdm/models/template_variable.rb +3 -64
  122. data/lib/sentdm/models/template_variable_props.rb +65 -0
  123. data/lib/sentdm/models/templates_list.rb +26 -0
  124. data/lib/sentdm/models/users_list.rb +26 -0
  125. data/lib/sentdm/models/voice/call.rb +3 -54
  126. data/lib/sentdm/models/voice/call_leg.rb +58 -0
  127. data/lib/sentdm/models/webhook_create_params.rb +3 -25
  128. data/lib/sentdm/models/webhook_delivery.rb +160 -0
  129. data/lib/sentdm/models/webhook_event_types_list.rb +26 -0
  130. data/lib/sentdm/models/webhook_events_list.rb +26 -0
  131. data/lib/sentdm/models/webhook_response.rb +3 -28
  132. data/lib/sentdm/models/webhook_secret.rb +15 -0
  133. data/lib/sentdm/models/webhook_sender_profile.rb +29 -0
  134. data/lib/sentdm/models/webhook_sender_profile_config.rb +27 -0
  135. data/lib/sentdm/models/webhook_test.rb +21 -0
  136. data/lib/sentdm/models/webhook_update_params.rb +3 -25
  137. data/lib/sentdm/models/webhooks_list.rb +26 -0
  138. data/lib/sentdm/models.rb +188 -0
  139. data/lib/sentdm/resources/channels/rcs.rb +177 -0
  140. data/lib/sentdm/resources/channels/sms.rb +417 -0
  141. data/lib/sentdm/resources/channels/whatsapp.rb +106 -0
  142. data/lib/sentdm/resources/channels.rb +162 -0
  143. data/lib/sentdm/resources/compliance.rb +127 -0
  144. data/lib/sentdm/resources/conversations.rb +4 -4
  145. data/lib/sentdm/resources/me.rb +2 -2
  146. data/lib/sentdm/resources/messages.rb +71 -6
  147. data/lib/sentdm/resources/numbers.rb +2 -2
  148. data/lib/sentdm/resources/profiles.rb +4 -4
  149. data/lib/sentdm/resources/sender_profiles.rb +463 -0
  150. data/lib/sentdm/resources/users.rb +2 -2
  151. data/lib/sentdm/resources/webhooks.rb +10 -10
  152. data/lib/sentdm/version.rb +1 -1
  153. data/lib/sentdm.rb +120 -11
  154. data/rbi/sentdm/client.rbi +64 -0
  155. data/rbi/sentdm/internal/sender_profiles_page.rbi +122 -0
  156. data/rbi/sentdm/models/account.rbi +242 -0
  157. data/rbi/sentdm/models/account_channels.rbi +66 -0
  158. data/rbi/sentdm/models/account_profile.rbi +116 -0
  159. data/rbi/sentdm/models/account_rcs_channel.rbi +45 -0
  160. data/rbi/sentdm/models/account_sms_channel.rbi +45 -0
  161. data/rbi/sentdm/models/account_whatsapp_channel.rbi +58 -0
  162. data/rbi/sentdm/models/api_response_of_account.rbi +78 -0
  163. data/rbi/sentdm/models/{webhook_rotate_secret_response.rbi → api_response_of_cancelled_message.rbi} +6 -41
  164. data/rbi/sentdm/models/api_response_of_channels_state.rbi +78 -0
  165. data/rbi/sentdm/models/api_response_of_compliance_requirements.rbi +81 -0
  166. data/rbi/sentdm/models/api_response_of_contacts_list.rbi +74 -0
  167. data/rbi/sentdm/models/api_response_of_message.rbi +84 -0
  168. data/rbi/sentdm/models/api_response_of_message_activities.rbi +77 -0
  169. data/rbi/sentdm/models/{webhook_test_response.rbi → api_response_of_number_lookup_result.rbi} +9 -43
  170. data/rbi/sentdm/models/api_response_of_profile_completion_accepted.rbi +83 -0
  171. data/rbi/sentdm/models/{profile_complete_response.rbi → api_response_of_profile_completion_result.rbi} +6 -52
  172. data/rbi/sentdm/models/api_response_of_profiles_list.rbi +74 -0
  173. data/rbi/sentdm/models/api_response_of_sender_profile.rbi +90 -0
  174. data/rbi/sentdm/models/api_response_of_sender_profiles_list.rbi +77 -0
  175. data/rbi/sentdm/models/api_response_of_templates_list.rbi +74 -0
  176. data/rbi/sentdm/models/api_response_of_users_list.rbi +74 -0
  177. data/rbi/sentdm/models/api_response_of_webhook_event_types_list.rbi +79 -0
  178. data/rbi/sentdm/models/api_response_of_webhook_events_list.rbi +77 -0
  179. data/rbi/sentdm/models/api_response_of_webhook_secret.rbi +74 -0
  180. data/rbi/sentdm/models/api_response_of_webhook_test.rbi +74 -0
  181. data/rbi/sentdm/models/api_response_of_webhooks_list.rbi +74 -0
  182. data/rbi/sentdm/models/billing_contact.rbi +49 -0
  183. data/rbi/sentdm/models/brand_business.rbi +115 -0
  184. data/rbi/sentdm/models/brand_business_info.rbi +3 -49
  185. data/rbi/sentdm/models/brand_compliance.rbi +108 -0
  186. data/rbi/sentdm/models/brand_contact.rbi +78 -0
  187. data/rbi/sentdm/models/brand_with_kyc.rbi +167 -0
  188. data/rbi/sentdm/models/cancelled_message.rbi +37 -0
  189. data/rbi/sentdm/models/channel_event_payload.rbi +4 -204
  190. data/rbi/sentdm/models/channel_list_params.rbi +38 -0
  191. data/rbi/sentdm/models/channel_score.rbi +56 -0
  192. data/rbi/sentdm/models/channels/api_response_of_list_of_sms_market.rbi +76 -0
  193. data/rbi/sentdm/models/channels/api_response_of_rcs_agent.rbi +103 -0
  194. data/rbi/sentdm/models/channels/api_response_of_sms_market.rbi +93 -0
  195. data/rbi/sentdm/models/channels/api_response_of_whatsapp_channel.rbi +85 -0
  196. data/rbi/sentdm/models/channels/market_compliance.rbi +770 -0
  197. data/rbi/sentdm/models/channels/rc_create_params.rbi +397 -0
  198. data/rbi/sentdm/models/channels/rcs_address.rbi +62 -0
  199. data/rbi/sentdm/models/channels/rcs_agent.rbi +320 -0
  200. data/rbi/sentdm/models/channels/sms_create_params.rbi +291 -0
  201. data/rbi/sentdm/models/channels/sms_list_params.rbi +40 -0
  202. data/rbi/sentdm/models/channels/sms_market.rbi +247 -0
  203. data/rbi/sentdm/models/channels/sms_number.rbi +60 -0
  204. data/rbi/sentdm/models/channels/sms_number_request.rbi +48 -0
  205. data/rbi/sentdm/models/channels/sms_retrieve_params.rbi +56 -0
  206. data/rbi/sentdm/models/channels/sms_update_params.rbi +93 -0
  207. data/rbi/sentdm/models/channels/supplied_compliance.rbi +140 -0
  208. data/rbi/sentdm/models/channels/supplied_document.rbi +57 -0
  209. data/rbi/sentdm/models/channels/whatsapp_channel.rbi +172 -0
  210. data/rbi/sentdm/models/channels/whatsapp_create_params.rbi +104 -0
  211. data/rbi/sentdm/models/channels_state.rbi +151 -0
  212. data/rbi/sentdm/models/compliance_attachment_template.rbi +56 -0
  213. data/rbi/sentdm/models/compliance_requirement.rbi +149 -0
  214. data/rbi/sentdm/models/compliance_requirements.rbi +165 -0
  215. data/rbi/sentdm/models/compliance_retrieve_requirements_params.rbi +79 -0
  216. data/rbi/sentdm/models/compliance_setup_step.rbi +115 -0
  217. data/rbi/sentdm/models/contact_message_summary.rbi +4 -69
  218. data/rbi/sentdm/models/contacts_list.rbi +50 -0
  219. data/rbi/sentdm/models/conversation_messages_list.rbi +4 -669
  220. data/rbi/sentdm/models/entity_type.rbi +23 -0
  221. data/rbi/sentdm/models/inbound_media.rbi +76 -0
  222. data/rbi/sentdm/models/inbound_message_event_payload.rbi +3 -85
  223. data/rbi/sentdm/models/link_event.rbi +128 -0
  224. data/rbi/sentdm/models/link_event_payload.rbi +279 -0
  225. data/rbi/sentdm/models/message.rbi +214 -0
  226. data/rbi/sentdm/models/message_activities.rbi +63 -0
  227. data/rbi/sentdm/models/message_activity.rbi +145 -0
  228. data/rbi/sentdm/models/message_body.rbi +104 -0
  229. data/rbi/sentdm/models/message_button.rbi +52 -0
  230. data/rbi/sentdm/models/message_cancel_params.rbi +59 -0
  231. data/rbi/sentdm/models/message_channel_options.rbi +65 -0
  232. data/rbi/sentdm/models/message_header_media.rbi +44 -0
  233. data/rbi/sentdm/models/message_media.rbi +95 -0
  234. data/rbi/sentdm/models/message_recipient.rbi +70 -0
  235. data/rbi/sentdm/models/message_send_params.rbi +7 -155
  236. data/rbi/sentdm/models/message_send_response.rbi +4 -163
  237. data/rbi/sentdm/models/message_send_result.rbi +85 -0
  238. data/rbi/sentdm/models/message_status_event.rbi +70 -0
  239. data/rbi/sentdm/models/mms_market.rbi +66 -0
  240. data/rbi/sentdm/models/number_lookup_result.rbi +89 -0
  241. data/rbi/sentdm/models/pagination_cursors.rbi +42 -0
  242. data/rbi/sentdm/models/pagination_meta.rbi +4 -43
  243. data/rbi/sentdm/models/profile_completion_accepted.rbi +33 -0
  244. data/rbi/sentdm/models/profile_completion_result.rbi +43 -0
  245. data/rbi/sentdm/models/profile_detail.rbi +8 -621
  246. data/rbi/sentdm/models/profiles/brand_campaign.rbi +3 -45
  247. data/rbi/sentdm/models/profiles_list.rbi +50 -0
  248. data/rbi/sentdm/models/sender_profile.rbi +204 -0
  249. data/rbi/sentdm/models/sender_profile_billing.rbi +34 -0
  250. data/rbi/sentdm/models/sender_profile_billing_request.rbi +46 -0
  251. data/rbi/sentdm/models/sender_profile_channels.rbi +163 -0
  252. data/rbi/sentdm/models/sender_profile_create_params.rbi +190 -0
  253. data/rbi/sentdm/models/sender_profile_delete_params.rbi +35 -0
  254. data/rbi/sentdm/models/sender_profile_list_params.rbi +57 -0
  255. data/rbi/sentdm/models/sender_profile_rcs.rbi +211 -0
  256. data/rbi/sentdm/models/sender_profile_retrieve_params.rbi +35 -0
  257. data/rbi/sentdm/models/sender_profile_sms.rbi +156 -0
  258. data/rbi/sentdm/models/sender_profile_update_params.rbi +96 -0
  259. data/rbi/sentdm/models/sender_profile_whatsapp.rbi +83 -0
  260. data/rbi/sentdm/models/sender_profiles_list.rbi +54 -0
  261. data/rbi/sentdm/models/tcr_brand_identity_status.rbi +27 -0
  262. data/rbi/sentdm/models/tcr_brand_status.rbi +20 -0
  263. data/rbi/sentdm/models/tcr_campaign_status.rbi +23 -0
  264. data/rbi/sentdm/models/template_body.rbi +6 -114
  265. data/rbi/sentdm/models/template_header.rbi +4 -53
  266. data/rbi/sentdm/models/template_header_location.rbi +47 -0
  267. data/rbi/sentdm/models/template_media_item.rbi +51 -0
  268. data/rbi/sentdm/models/template_mms_body_content.rbi +73 -0
  269. data/rbi/sentdm/models/template_ref.rbi +79 -0
  270. data/rbi/sentdm/models/template_variable.rbi +4 -80
  271. data/rbi/sentdm/models/template_variable_props.rbi +81 -0
  272. data/rbi/sentdm/models/templates_list.rbi +50 -0
  273. data/rbi/sentdm/models/users_list.rbi +50 -0
  274. data/rbi/sentdm/models/voice/call.rbi +3 -86
  275. data/rbi/sentdm/models/voice/call_leg.rbi +90 -0
  276. data/rbi/sentdm/models/webhook_create_params.rbi +4 -49
  277. data/rbi/sentdm/models/webhook_delivery.rbi +211 -0
  278. data/rbi/sentdm/models/webhook_event_types_list.rbi +54 -0
  279. data/rbi/sentdm/models/webhook_events_list.rbi +52 -0
  280. data/rbi/sentdm/models/webhook_response.rbi +4 -50
  281. data/rbi/sentdm/models/webhook_secret.rbi +24 -0
  282. data/rbi/sentdm/models/webhook_sender_profile.rbi +46 -0
  283. data/rbi/sentdm/models/webhook_sender_profile_config.rbi +44 -0
  284. data/rbi/sentdm/models/webhook_test.rbi +32 -0
  285. data/rbi/sentdm/models/webhook_update_params.rbi +4 -49
  286. data/rbi/sentdm/models/webhooks_list.rbi +50 -0
  287. data/rbi/sentdm/models.rbi +197 -0
  288. data/rbi/sentdm/resources/channels/rcs.rbi +208 -0
  289. data/rbi/sentdm/resources/channels/sms.rbi +437 -0
  290. data/rbi/sentdm/resources/channels/whatsapp.rbi +108 -0
  291. data/rbi/sentdm/resources/channels.rbi +149 -0
  292. data/rbi/sentdm/resources/compliance.rbi +121 -0
  293. data/rbi/sentdm/resources/conversations.rbi +2 -10
  294. data/rbi/sentdm/resources/me.rbi +1 -1
  295. data/rbi/sentdm/resources/messages.rbi +64 -7
  296. data/rbi/sentdm/resources/numbers.rbi +1 -1
  297. data/rbi/sentdm/resources/profiles.rbi +2 -2
  298. data/rbi/sentdm/resources/sender_profiles.rbi +461 -0
  299. data/rbi/sentdm/resources/users.rbi +1 -1
  300. data/rbi/sentdm/resources/webhooks.rbi +6 -12
  301. data/sig/sentdm/client.rbs +4 -0
  302. data/sig/sentdm/internal/sender_profiles_page.rbs +80 -0
  303. data/sig/sentdm/models/account.rbs +111 -0
  304. data/sig/sentdm/models/account_channels.rbs +38 -0
  305. data/sig/sentdm/models/account_profile.rbs +68 -0
  306. data/sig/sentdm/models/account_rcs_channel.rbs +17 -0
  307. data/sig/sentdm/models/account_sms_channel.rbs +17 -0
  308. data/sig/sentdm/models/account_whatsapp_channel.rbs +28 -0
  309. data/sig/sentdm/models/api_response_of_account.rbs +39 -0
  310. data/sig/sentdm/models/api_response_of_cancelled_message.rbs +39 -0
  311. data/sig/sentdm/models/api_response_of_channels_state.rbs +39 -0
  312. data/sig/sentdm/models/api_response_of_compliance_requirements.rbs +39 -0
  313. data/sig/sentdm/models/api_response_of_contacts_list.rbs +39 -0
  314. data/sig/sentdm/models/api_response_of_message.rbs +39 -0
  315. data/sig/sentdm/models/api_response_of_message_activities.rbs +39 -0
  316. data/sig/sentdm/models/api_response_of_number_lookup_result.rbs +39 -0
  317. data/sig/sentdm/models/api_response_of_profile_completion_accepted.rbs +39 -0
  318. data/sig/sentdm/models/api_response_of_profile_completion_result.rbs +39 -0
  319. data/sig/sentdm/models/api_response_of_profiles_list.rbs +39 -0
  320. data/sig/sentdm/models/api_response_of_sender_profile.rbs +39 -0
  321. data/sig/sentdm/models/api_response_of_sender_profiles_list.rbs +39 -0
  322. data/sig/sentdm/models/api_response_of_templates_list.rbs +39 -0
  323. data/sig/sentdm/models/api_response_of_users_list.rbs +39 -0
  324. data/sig/sentdm/models/api_response_of_webhook_event_types_list.rbs +39 -0
  325. data/sig/sentdm/models/api_response_of_webhook_events_list.rbs +39 -0
  326. data/sig/sentdm/models/api_response_of_webhook_secret.rbs +39 -0
  327. data/sig/sentdm/models/api_response_of_webhook_test.rbs +39 -0
  328. data/sig/sentdm/models/api_response_of_webhooks_list.rbs +39 -0
  329. data/sig/sentdm/models/billing_contact.rbs +30 -0
  330. data/sig/sentdm/models/brand_business.rbs +70 -0
  331. data/sig/sentdm/models/brand_business_info.rbs +4 -23
  332. data/sig/sentdm/models/brand_compliance.rbs +56 -0
  333. data/sig/sentdm/models/brand_contact.rbs +47 -0
  334. data/sig/sentdm/models/brand_with_kyc.rbs +93 -0
  335. data/sig/sentdm/models/cancelled_message.rbs +15 -0
  336. data/sig/sentdm/models/channel_event_payload.rbs +4 -56
  337. data/sig/sentdm/models/channel_list_params.rbs +25 -0
  338. data/sig/sentdm/models/channel_score.rbs +32 -0
  339. data/sig/sentdm/models/channels/api_response_of_list_of_sms_market.rbs +41 -0
  340. data/sig/sentdm/models/channels/api_response_of_rcs_agent.rbs +41 -0
  341. data/sig/sentdm/models/channels/api_response_of_sms_market.rbs +41 -0
  342. data/sig/sentdm/models/channels/api_response_of_whatsapp_channel.rbs +43 -0
  343. data/sig/sentdm/models/channels/market_compliance.rbs +338 -0
  344. data/sig/sentdm/models/channels/rc_create_params.rbs +242 -0
  345. data/sig/sentdm/models/channels/rcs_address.rbs +42 -0
  346. data/sig/sentdm/models/channels/rcs_agent.rbs +181 -0
  347. data/sig/sentdm/models/channels/sms_create_params.rbs +116 -0
  348. data/sig/sentdm/models/channels/sms_list_params.rbs +27 -0
  349. data/sig/sentdm/models/channels/sms_market.rbs +85 -0
  350. data/sig/sentdm/models/channels/sms_number.rbs +28 -0
  351. data/sig/sentdm/models/channels/sms_number_request.rbs +17 -0
  352. data/sig/sentdm/models/channels/sms_retrieve_params.rbs +36 -0
  353. data/sig/sentdm/models/channels/sms_update_params.rbs +63 -0
  354. data/sig/sentdm/models/channels/supplied_compliance.rbs +32 -0
  355. data/sig/sentdm/models/channels/supplied_document.rbs +30 -0
  356. data/sig/sentdm/models/channels/whatsapp_channel.rbs +78 -0
  357. data/sig/sentdm/models/channels/whatsapp_create_params.rbs +56 -0
  358. data/sig/sentdm/models/channels_state.rbs +55 -0
  359. data/sig/sentdm/models/compliance_attachment_template.rbs +26 -0
  360. data/sig/sentdm/models/compliance_requirement.rbs +76 -0
  361. data/sig/sentdm/models/compliance_requirements.rbs +66 -0
  362. data/sig/sentdm/models/compliance_retrieve_requirements_params.rbs +43 -0
  363. data/sig/sentdm/models/compliance_setup_step.rbs +62 -0
  364. data/sig/sentdm/models/contact_message_summary.rbs +6 -35
  365. data/sig/sentdm/models/contacts_list.rbs +31 -0
  366. data/sig/sentdm/models/conversation_messages_list.rbs +5 -312
  367. data/sig/sentdm/models/entity_type.rbs +22 -0
  368. data/sig/sentdm/models/inbound_media.rbs +35 -0
  369. data/sig/sentdm/models/inbound_message_event_payload.rbs +4 -36
  370. data/sig/sentdm/models/link_event.rbs +44 -0
  371. data/sig/sentdm/models/link_event_payload.rbs +106 -0
  372. data/sig/sentdm/models/message.rbs +130 -0
  373. data/sig/sentdm/models/message_activities.rbs +38 -0
  374. data/sig/sentdm/models/message_activity.rbs +66 -0
  375. data/sig/sentdm/models/message_body.rbs +52 -0
  376. data/sig/sentdm/models/message_button.rbs +34 -0
  377. data/sig/sentdm/models/message_cancel_params.rbs +38 -0
  378. data/sig/sentdm/models/message_channel_options.rbs +26 -0
  379. data/sig/sentdm/models/message_header_media.rbs +19 -0
  380. data/sig/sentdm/models/message_media.rbs +40 -0
  381. data/sig/sentdm/models/message_recipient.rbs +34 -0
  382. data/sig/sentdm/models/message_send_params.rbs +8 -54
  383. data/sig/sentdm/models/message_send_response.rbs +4 -77
  384. data/sig/sentdm/models/message_send_result.rbs +45 -0
  385. data/sig/sentdm/models/message_status_event.rbs +40 -0
  386. data/sig/sentdm/models/mms_market.rbs +35 -0
  387. data/sig/sentdm/models/number_lookup_result.rbs +64 -0
  388. data/sig/sentdm/models/pagination_cursors.rbs +15 -0
  389. data/sig/sentdm/models/pagination_meta.rbs +4 -16
  390. data/sig/sentdm/models/profile_completion_accepted.rbs +15 -0
  391. data/sig/sentdm/models/profile_completion_result.rbs +19 -0
  392. data/sig/sentdm/models/profile_detail.rbs +8 -315
  393. data/sig/sentdm/models/profiles/brand_campaign.rbs +4 -16
  394. data/sig/sentdm/models/profiles_list.rbs +31 -0
  395. data/sig/sentdm/models/sender_profile.rbs +76 -0
  396. data/sig/sentdm/models/sender_profile_billing.rbs +15 -0
  397. data/sig/sentdm/models/sender_profile_billing_request.rbs +15 -0
  398. data/sig/sentdm/models/sender_profile_channels.rbs +30 -0
  399. data/sig/sentdm/models/sender_profile_create_params.rbs +78 -0
  400. data/sig/sentdm/models/sender_profile_delete_params.rbs +20 -0
  401. data/sig/sentdm/models/sender_profile_list_params.rbs +32 -0
  402. data/sig/sentdm/models/sender_profile_rcs.rbs +150 -0
  403. data/sig/sentdm/models/sender_profile_retrieve_params.rbs +20 -0
  404. data/sig/sentdm/models/sender_profile_sms.rbs +40 -0
  405. data/sig/sentdm/models/sender_profile_update_params.rbs +62 -0
  406. data/sig/sentdm/models/sender_profile_whatsapp.rbs +16 -0
  407. data/sig/sentdm/models/sender_profiles_list.rbs +31 -0
  408. data/sig/sentdm/models/tcr_brand_identity_status.rbs +17 -0
  409. data/sig/sentdm/models/tcr_brand_status.rbs +15 -0
  410. data/sig/sentdm/models/tcr_campaign_status.rbs +15 -0
  411. data/sig/sentdm/models/template_body.rbs +4 -43
  412. data/sig/sentdm/models/template_header.rbs +4 -31
  413. data/sig/sentdm/models/template_header_location.rbs +30 -0
  414. data/sig/sentdm/models/template_media_item.rbs +17 -0
  415. data/sig/sentdm/models/template_mms_body_content.rbs +28 -0
  416. data/sig/sentdm/models/template_ref.rbs +26 -0
  417. data/sig/sentdm/models/template_variable.rbs +4 -51
  418. data/sig/sentdm/models/template_variable_props.rbs +50 -0
  419. data/sig/sentdm/models/templates_list.rbs +29 -0
  420. data/sig/sentdm/models/users_list.rbs +31 -0
  421. data/sig/sentdm/models/voice/call.rbs +4 -49
  422. data/sig/sentdm/models/voice/call_leg.rbs +50 -0
  423. data/sig/sentdm/models/webhook_create_params.rbs +4 -28
  424. data/sig/sentdm/models/webhook_delivery.rbs +99 -0
  425. data/sig/sentdm/models/webhook_event_types_list.rbs +31 -0
  426. data/sig/sentdm/models/webhook_events_list.rbs +31 -0
  427. data/sig/sentdm/models/webhook_response.rbs +4 -28
  428. data/sig/sentdm/models/webhook_secret.rbs +15 -0
  429. data/sig/sentdm/models/webhook_sender_profile.rbs +27 -0
  430. data/sig/sentdm/models/webhook_sender_profile_config.rbs +27 -0
  431. data/sig/sentdm/models/webhook_test.rbs +19 -0
  432. data/sig/sentdm/models/webhook_update_params.rbs +4 -28
  433. data/sig/sentdm/models/webhooks_list.rbs +31 -0
  434. data/sig/sentdm/models.rbs +188 -0
  435. data/sig/sentdm/resources/channels/rcs.rbs +41 -0
  436. data/sig/sentdm/resources/channels/sms.rbs +44 -0
  437. data/sig/sentdm/resources/channels/whatsapp.rbs +18 -0
  438. data/sig/sentdm/resources/channels.rbs +11 -0
  439. data/sig/sentdm/resources/compliance.rbs +15 -0
  440. data/sig/sentdm/resources/conversations.rbs +2 -2
  441. data/sig/sentdm/resources/me.rbs +1 -1
  442. data/sig/sentdm/resources/messages.rbs +12 -4
  443. data/sig/sentdm/resources/numbers.rbs +1 -1
  444. data/sig/sentdm/resources/profiles.rbs +2 -2
  445. data/sig/sentdm/resources/sender_profiles.rbs +44 -0
  446. data/sig/sentdm/resources/users.rbs +1 -1
  447. data/sig/sentdm/resources/webhooks.rbs +6 -6
  448. metadata +362 -35
  449. data/lib/sentdm/models/me_retrieve_response.rb +0 -409
  450. data/lib/sentdm/models/message_retrieve_activities_response.rb +0 -175
  451. data/lib/sentdm/models/message_retrieve_status_response.rb +0 -477
  452. data/lib/sentdm/models/number_lookup_response.rb +0 -104
  453. data/lib/sentdm/models/profile_complete_response.rb +0 -74
  454. data/lib/sentdm/models/profile_list_response.rb +0 -65
  455. data/lib/sentdm/models/user_list_response.rb +0 -65
  456. data/lib/sentdm/models/webhook_list_event_types_response.rb +0 -65
  457. data/lib/sentdm/models/webhook_list_events_response.rb +0 -445
  458. data/rbi/sentdm/models/me_retrieve_response.rbi +0 -705
  459. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +0 -319
  460. data/rbi/sentdm/models/message_retrieve_status_response.rbi +0 -765
  461. data/rbi/sentdm/models/number_lookup_response.rbi +0 -166
  462. data/rbi/sentdm/models/profile_list_response.rbi +0 -128
  463. data/rbi/sentdm/models/user_list_response.rbi +0 -128
  464. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +0 -142
  465. data/rbi/sentdm/models/webhook_list_events_response.rbi +0 -647
  466. data/sig/sentdm/models/me_retrieve_response.rbs +0 -306
  467. data/sig/sentdm/models/message_retrieve_activities_response.rbs +0 -137
  468. data/sig/sentdm/models/message_retrieve_status_response.rbs +0 -341
  469. data/sig/sentdm/models/number_lookup_response.rbs +0 -100
  470. data/sig/sentdm/models/profile_complete_response.rbs +0 -55
  471. data/sig/sentdm/models/profile_list_response.rbs +0 -67
  472. data/sig/sentdm/models/user_list_response.rbs +0 -67
  473. data/sig/sentdm/models/webhook_list_event_types_response.rbs +0 -67
  474. data/sig/sentdm/models/webhook_list_events_response.rbs +0 -243
  475. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +0 -51
  476. data/sig/sentdm/models/webhook_test_response.rbs +0 -55
@@ -1,65 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Profiles#list
6
- class ProfileListResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # The profiles in the organization.
9
- #
10
- # @return [Sentdm::Models::ProfileListResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::ProfileListResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::ErrorDetail, nil]
17
- optional :error, -> { Sentdm::ErrorDetail }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::APIMeta, nil]
23
- optional :meta, -> { Sentdm::APIMeta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::ProfileListResponse::Data, nil] The profiles in the organization.
35
- #
36
- # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::ProfileListResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute pagination
45
- # Pagination metadata for list responses
46
- #
47
- # @return [Sentdm::Models::PaginationMeta, nil]
48
- optional :pagination, -> { Sentdm::PaginationMeta }
49
-
50
- # @!attribute profiles
51
- # The profiles on this page.
52
- #
53
- # @return [Array<Sentdm::Models::ProfileDetail>, nil]
54
- optional :profiles, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ProfileDetail] }
55
-
56
- # @!method initialize(pagination: nil, profiles: nil)
57
- # The profiles in the organization.
58
- #
59
- # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
60
- #
61
- # @param profiles [Array<Sentdm::Models::ProfileDetail>] The profiles on this page.
62
- end
63
- end
64
- end
65
- end
@@ -1,65 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Users#list
6
- class UserListResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # The users in the organization.
9
- #
10
- # @return [Sentdm::Models::UserListResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::UserListResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::ErrorDetail, nil]
17
- optional :error, -> { Sentdm::ErrorDetail }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::APIMeta, nil]
23
- optional :meta, -> { Sentdm::APIMeta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::UserListResponse::Data, nil] The users in the organization.
35
- #
36
- # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::UserListResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute pagination
45
- # Pagination metadata for list responses
46
- #
47
- # @return [Sentdm::Models::PaginationMeta, nil]
48
- optional :pagination, -> { Sentdm::PaginationMeta }
49
-
50
- # @!attribute users
51
- # The users on this page.
52
- #
53
- # @return [Array<Sentdm::Models::UserResponse>, nil]
54
- optional :users, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::UserResponse] }
55
-
56
- # @!method initialize(pagination: nil, users: nil)
57
- # The users in the organization.
58
- #
59
- # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
60
- #
61
- # @param users [Array<Sentdm::Models::UserResponse>] The users on this page.
62
- end
63
- end
64
- end
65
- end
@@ -1,65 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Webhooks#list_event_types
6
- class WebhookListEventTypesResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # The webhook event types a customer can subscribe to.
9
- #
10
- # @return [Sentdm::Models::WebhookListEventTypesResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::WebhookListEventTypesResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::ErrorDetail, nil]
17
- optional :error, -> { Sentdm::ErrorDetail }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::APIMeta, nil]
23
- optional :meta, -> { Sentdm::APIMeta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::WebhookListEventTypesResponse::Data, nil] The webhook event types a customer can subscribe to.
35
- #
36
- # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::WebhookListEventTypesResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute event_types
45
- # The event_types on this page.
46
- #
47
- # @return [Array<Sentdm::Models::WebhookEventType>, nil]
48
- optional :event_types, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookEventType] }
49
-
50
- # @!attribute pagination
51
- # Pagination metadata for list responses
52
- #
53
- # @return [Sentdm::Models::PaginationMeta, nil]
54
- optional :pagination, -> { Sentdm::PaginationMeta }
55
-
56
- # @!method initialize(event_types: nil, pagination: nil)
57
- # The webhook event types a customer can subscribe to.
58
- #
59
- # @param event_types [Array<Sentdm::Models::WebhookEventType>] The event_types on this page.
60
- #
61
- # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
62
- end
63
- end
64
- end
65
- end
@@ -1,445 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Webhooks#list_events
6
- class WebhookListEventsResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute id
8
- #
9
- # @return [String, nil]
10
- optional :id, String
11
-
12
- # @!attribute created_at
13
- #
14
- # @return [Time, nil]
15
- optional :created_at, Time
16
-
17
- # @!attribute delivery_attempts
18
- #
19
- # @return [Integer, nil]
20
- optional :delivery_attempts, Integer
21
-
22
- # @!attribute delivery_status
23
- #
24
- # @return [String, nil]
25
- optional :delivery_status, String
26
-
27
- # @!attribute error_message
28
- #
29
- # @return [String, nil]
30
- optional :error_message, String, nil?: true
31
-
32
- # @!attribute event_data
33
- # The exact event body that was delivered, or attempted, for this record. One of
34
- # the six webhook envelopes:
35
- #
36
- # message — an outbound message changed status. message with event:
37
- # message.received — someone replied to you. templates — a template was approved,
38
- # rejected, paused or similar. channel — one of your markets moved in provisioning
39
- # or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
40
- # tracked short link was clicked or a hosted file downloaded, or one expired or
41
- # was revoked.
42
- #
43
- # Read field and event to tell which, the same way your endpoint does. The two
44
- # message envelopes are the reason that is two fields and not one: they share a
45
- # field and differ by event.
46
- #
47
- # Treat the list as open. It has grown twice — channel and then link — and a
48
- # handler that rejects an envelope it does not recognise will break on the next
49
- # addition rather than ignore it.
50
- #
51
- # @return [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, Sentdm::Models::CallEvent, nil]
52
- optional :event_data, union: -> { Sentdm::Models::WebhookListEventsResponse::EventData }
53
-
54
- # @!attribute event_type
55
- #
56
- # @return [String, nil]
57
- optional :event_type, String
58
-
59
- # @!attribute http_status_code
60
- #
61
- # @return [Integer, nil]
62
- optional :http_status_code, Integer, nil?: true
63
-
64
- # @!attribute processing_completed_at
65
- #
66
- # @return [Time, nil]
67
- optional :processing_completed_at, Time, nil?: true
68
-
69
- # @!attribute processing_started_at
70
- #
71
- # @return [Time, nil]
72
- optional :processing_started_at, Time, nil?: true
73
-
74
- # @!attribute response_body
75
- #
76
- # @return [String, nil]
77
- optional :response_body, String, nil?: true
78
-
79
- # @!method initialize(id: nil, created_at: nil, delivery_attempts: nil, delivery_status: nil, error_message: nil, event_data: nil, event_type: nil, http_status_code: nil, processing_completed_at: nil, processing_started_at: nil, response_body: nil)
80
- # Some parameter documentations has been truncated, see
81
- # {Sentdm::Models::WebhookListEventsResponse} for more details.
82
- #
83
- # @param id [String]
84
- #
85
- # @param created_at [Time]
86
- #
87
- # @param delivery_attempts [Integer]
88
- #
89
- # @param delivery_status [String]
90
- #
91
- # @param error_message [String, nil]
92
- #
93
- # @param event_data [Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, Sentdm::Models::CallEvent] The exact event body that was delivered, or attempted, for this record. One of t
94
- #
95
- # @param event_type [String]
96
- #
97
- # @param http_status_code [Integer, nil]
98
- #
99
- # @param processing_completed_at [Time, nil]
100
- #
101
- # @param processing_started_at [Time, nil]
102
- #
103
- # @param response_body [String, nil]
104
-
105
- # The exact event body that was delivered, or attempted, for this record. One of
106
- # the six webhook envelopes:
107
- #
108
- # message — an outbound message changed status. message with event:
109
- # message.received — someone replied to you. templates — a template was approved,
110
- # rejected, paused or similar. channel — one of your markets moved in provisioning
111
- # or compliance. contact — a consent signal: opt-in, opt-out or help. link — a
112
- # tracked short link was clicked or a hosted file downloaded, or one expired or
113
- # was revoked.
114
- #
115
- # Read field and event to tell which, the same way your endpoint does. The two
116
- # message envelopes are the reason that is two fields and not one: they share a
117
- # field and differ by event.
118
- #
119
- # Treat the list as open. It has grown twice — channel and then link — and a
120
- # handler that rejects an envelope it does not recognise will break on the next
121
- # addition rather than ignore it.
122
- #
123
- # @see Sentdm::Models::WebhookListEventsResponse#event_data
124
- module EventData
125
- extend Sentdm::Internal::Type::Union
126
-
127
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
128
- # varies only in Payload.
129
- variant -> { Sentdm::MessageEvent }
130
-
131
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
132
- # varies only in Payload.
133
- variant -> { Sentdm::InboundMessageEvent }
134
-
135
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
136
- # varies only in Payload.
137
- variant -> { Sentdm::TemplateEvent }
138
-
139
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
140
- # varies only in Payload.
141
- variant -> { Sentdm::ChannelEvent }
142
-
143
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
144
- # varies only in Payload.
145
- variant -> { Sentdm::ContactEvent }
146
-
147
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
148
- # varies only in Payload.
149
- variant -> { Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload }
150
-
151
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares this shape and
152
- # varies only in Payload.
153
- variant -> { Sentdm::CallEvent }
154
-
155
- class SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload < Sentdm::Internal::Type::BaseModel
156
- # @!attribute event
157
- # The specific event within the family, for example message.delivered,
158
- # message.received or contact.opt_out. Absent on events that have no subtype, so
159
- # treat it as optional.
160
- #
161
- # @return [String, nil]
162
- optional :event, String, nil?: true
163
-
164
- # @!attribute field
165
- # The event family, for example message, templates or contact. Route on this
166
- # first, then on event for the specific change.
167
- #
168
- # @return [String, nil]
169
- optional :field, String
170
-
171
- # @!attribute payload
172
- # Body of a link event: something happened to a tracked link Sent published on the
173
- # customer's behalf. A link points either at a URL the customer supplied or at a
174
- # file Sent hosts for them; LinkKind says which. Delivered when an eligible
175
- # request is served, or when a published link reaches the end of its life.
176
- #
177
- # A click is a request, not a read receipt. link.clicked means the redirect was
178
- # served; link.downloaded means bytes went out. Neither proves a person saw
179
- # anything — messaging providers and link scanners fetch URLs on their own, which
180
- # is what TrafficClass exists to tell apart. Filter on it before reporting a
181
- # click-through rate; treat likely_human as a hint, never as delivery
182
- # confirmation.
183
- #
184
- # RecordId identifies the link; the X-Webhook-Event-ID header identifies the
185
- # delivery. One link is hit many times, so those are the two keys a subscriber
186
- # needs: group by the first, deduplicate on the second — exactly as on every other
187
- # family. The payload carries no event identifier of its own, for the same reason
188
- # none of the others do.
189
- #
190
- # Nothing here identifies the visitor. No IP address and no visitor token crosses
191
- # this boundary. Country, Device and Browser are coarse buckets derived at the
192
- # edge and are absent whenever the request did not supply enough to derive them.
193
- #
194
- # @return [Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload, nil]
195
- optional :payload,
196
- -> { Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload },
197
- nil?: true
198
-
199
- # @!attribute request_id
200
- # The event-specific body.
201
- #
202
- # @return [String, nil]
203
- optional :request_id, String, nil?: true
204
-
205
- # @!attribute timestamp
206
- # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
207
- # time, not the time the underlying change happened. Use the timestamp inside the
208
- # payload for the latter.
209
- #
210
- # @return [String, nil]
211
- optional :timestamp, String
212
-
213
- # @!method initialize(event: nil, field: nil, payload: nil, request_id: nil, timestamp: nil)
214
- # Some parameter documentations has been truncated, see
215
- # {Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload}
216
- # for more details.
217
- #
218
- # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
219
- # this shape and varies only in Payload.
220
- #
221
- # @param event [String, nil] The specific event within the family, for example message.delivered,
222
- #
223
- # @param field [String] The event family, for example message, templates or contact. Route on
224
- #
225
- # @param payload [Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload, nil] Body of a link event: something happened to a tracked link Sent published on the
226
- #
227
- # @param request_id [String, nil] The event-specific body.
228
- #
229
- # @param timestamp [String] When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
230
-
231
- # @see Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload#payload
232
- class Payload < Sentdm::Internal::Type::BaseModel
233
- # @!attribute record_id
234
- # The link's public identifier — the eight-character code in the short URL, for
235
- # example A78B2BU0. Unique across both kinds, and never reused, so it is the
236
- # stable key to group one link's events by.
237
- #
238
- # @return [String]
239
- required :record_id, String
240
-
241
- # @!attribute access_country
242
- # Where the request appeared to come from, as an ISO 3166-1 alpha-2 code. Named
243
- # separately from the country on a channel event, which is a destination market
244
- # the customer registered for — this one is a property of a single visitor and is
245
- # absent when the edge could not resolve it.
246
- #
247
- # @return [String, nil]
248
- optional :access_country, String, nil?: true
249
-
250
- # @!attribute access_outcome
251
- # How the request was served, when the edge recorded it. Free text describing the
252
- # outcome — show it to a human rather than branching on it.
253
- #
254
- # @return [String, nil]
255
- optional :access_outcome, String, nil?: true
256
-
257
- # @!attribute browser
258
- # The requesting browser family, for example chrome or safari, or unknown. Derived
259
- # from the user agent.
260
- #
261
- # @return [String, nil]
262
- optional :browser, String, nil?: true
263
-
264
- # @!attribute bytes_served
265
- # How many bytes were served, for a file access. A ranged request reports the
266
- # bytes in that range, not the size of the file, so several accesses of one file
267
- # can each report a part.
268
- #
269
- # @return [Integer, nil]
270
- optional :bytes_served, Integer, nil?: true
271
-
272
- # @!attribute channel
273
- # The channel the message carrying this link went out on: sms, whatsapp, or rcs.
274
- #
275
- # @return [String, nil]
276
- optional :channel, String, nil?: true
277
-
278
- # @!attribute customer_id
279
- # The organization the link belongs to. Always the parent account, never a sender
280
- # profile — read SenderProfileId for that.
281
- #
282
- # This family publishes the owner as an explicit pair rather than the single
283
- # account_id the other families use. The pair says which organization and which
284
- # profile without the subscriber deriving either, which is the trade: one more key
285
- # against not having to know that account_id silently becomes the profile when one
286
- # exists.
287
- #
288
- # @return [String, nil]
289
- optional :customer_id, String
290
-
291
- # @!attribute device
292
- # The requesting device class: mobile, tablet, desktop or unknown. Derived from
293
- # the user agent.
294
- #
295
- # @return [String, nil]
296
- optional :device, String, nil?: true
297
-
298
- # @!attribute link_kind
299
- # What the link points at: url for a destination the customer supplied, file for
300
- # media Sent hosts. Always present, and implied by the event — link.clicked is
301
- # always url and link.downloaded always file — but published as its own field so a
302
- # subscriber can branch on the kind without parsing the event name, the same
303
- # separation the channel family keeps between its event and its status.
304
- #
305
- # @return [String, nil]
306
- optional :link_kind, String
307
-
308
- # @!attribute message_id
309
- # The message the link was published in.
310
- #
311
- # The event can arrive before the message is readable through GET /v3/messages: a
312
- # provider may fetch a link within milliseconds of the send, and nothing here
313
- # waits for the message row. Retry the read rather than treating an unknown id as
314
- # an error.
315
- #
316
- # @return [String, nil]
317
- optional :message_id, String, nil?: true
318
-
319
- # @!attribute occurred_at
320
- # When the access or lifecycle change actually happened, in UTC
321
- # (yyyy-MM-ddTHH:mm:ssZ). The envelope's timestamp is when Sent emitted the event;
322
- # this is when the thing occurred, and the two differ by the ingest delay.
323
- #
324
- # @return [String, nil]
325
- optional :occurred_at, String
326
-
327
- # @!attribute reference_key
328
- # The caller-supplied label tying this link back to a position in the message, for
329
- # example body:0 for the first link in the body. Present when the link was created
330
- # with one.
331
- #
332
- # @return [String, nil]
333
- optional :reference_key, String, nil?: true
334
-
335
- # @!attribute referrer_host
336
- # The host of the page that linked here, when the request supplied one. The host
337
- # only — never a full referring URL.
338
- #
339
- # @return [String, nil]
340
- optional :referrer_host, String, nil?: true
341
-
342
- # @!attribute request_method
343
- # The HTTP method of the request that was served, for an access event. Omitted on
344
- # link.expired and link.revoked, which describe no request.
345
- #
346
- # @return [String, nil]
347
- optional :request_method, String, nil?: true
348
-
349
- # @!attribute sender_profile_id
350
- # The sender profile that owns the link, or null when the organization owns it
351
- # directly. Always on the wire so a handler reads one shape rather than branching
352
- # on whether the key arrived.
353
- #
354
- # sender_profile_id, not profile_id: the API already publishes
355
- # messaging_profile_id and sending_phone_number_profile_id for provider-side
356
- # profiles, which are a different thing entirely. The unqualified name would read
357
- # as one of those.
358
- #
359
- # @return [String, nil]
360
- optional :sender_profile_id, String, nil?: true
361
-
362
- # @!attribute status_code
363
- # The HTTP status Sent answered the request with: 302 for a link, 200 or 206 for a
364
- # file. Omitted on lifecycle events.
365
- #
366
- # @return [Integer, nil]
367
- optional :status_code, Integer, nil?: true
368
-
369
- # @!attribute traffic_class
370
- # A coarse guess at what made the request: likely_human, provider (a messaging
371
- # platform prefetching the link), bot, or unknown. Derived from the user agent, so
372
- # it is a hint for filtering noise rather than a fact to bill or report on.
373
- #
374
- # @return [String, nil]
375
- optional :traffic_class, String, nil?: true
376
-
377
- # @!method initialize(record_id:, access_country: nil, access_outcome: nil, browser: nil, bytes_served: nil, channel: nil, customer_id: nil, device: nil, link_kind: nil, message_id: nil, occurred_at: nil, reference_key: nil, referrer_host: nil, request_method: nil, sender_profile_id: nil, status_code: nil, traffic_class: nil)
378
- # Some parameter documentations has been truncated, see
379
- # {Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::Payload}
380
- # for more details.
381
- #
382
- # Body of a link event: something happened to a tracked link Sent published on the
383
- # customer's behalf. A link points either at a URL the customer supplied or at a
384
- # file Sent hosts for them; LinkKind says which. Delivered when an eligible
385
- # request is served, or when a published link reaches the end of its life.
386
- #
387
- # A click is a request, not a read receipt. link.clicked means the redirect was
388
- # served; link.downloaded means bytes went out. Neither proves a person saw
389
- # anything — messaging providers and link scanners fetch URLs on their own, which
390
- # is what TrafficClass exists to tell apart. Filter on it before reporting a
391
- # click-through rate; treat likely_human as a hint, never as delivery
392
- # confirmation.
393
- #
394
- # RecordId identifies the link; the X-Webhook-Event-ID header identifies the
395
- # delivery. One link is hit many times, so those are the two keys a subscriber
396
- # needs: group by the first, deduplicate on the second — exactly as on every other
397
- # family. The payload carries no event identifier of its own, for the same reason
398
- # none of the others do.
399
- #
400
- # Nothing here identifies the visitor. No IP address and no visitor token crosses
401
- # this boundary. Country, Device and Browser are coarse buckets derived at the
402
- # edge and are absent whenever the request did not supply enough to derive them.
403
- #
404
- # @param record_id [String] The link's public identifier — the eight-character code in the short URL, for ex
405
- #
406
- # @param access_country [String, nil] Where the request appeared to come from, as an ISO 3166-1 alpha-2 code. Named se
407
- #
408
- # @param access_outcome [String, nil] How the request was served, when the edge recorded it. Free text describing the
409
- #
410
- # @param browser [String, nil] The requesting browser family, for example chrome or safari, or
411
- #
412
- # @param bytes_served [Integer, nil] How many bytes were served, for a file access. A ranged request reports the byte
413
- #
414
- # @param channel [String, nil] The channel the message carrying this link went out on: sms, whatsapp, or
415
- #
416
- # @param customer_id [String] The organization the link belongs to. Always the parent account, never a sender
417
- #
418
- # @param device [String, nil] The requesting device class: mobile, tablet, desktop or
419
- #
420
- # @param link_kind [String] What the link points at: url for a destination the customer supplied, file for
421
- #
422
- # @param message_id [String, nil] The message the link was published in.
423
- #
424
- # @param occurred_at [String] When the access or lifecycle change actually happened, in UTC
425
- #
426
- # @param reference_key [String, nil] The caller-supplied label tying this link back to a position in the message, for
427
- #
428
- # @param referrer_host [String, nil] The host of the page that linked here, when the request supplied one. The host o
429
- #
430
- # @param request_method [String, nil] The HTTP method of the request that was served, for an access event. Omitted on
431
- #
432
- # @param sender_profile_id [String, nil] The sender profile that owns the link, or null when the organization owns it dir
433
- #
434
- # @param status_code [Integer, nil] The HTTP status Sent answered the request with: 302 for a link, 200 or
435
- #
436
- # @param traffic_class [String, nil] A coarse guess at what made the request: likely_human, provider (a messaging
437
- end
438
- end
439
-
440
- # @!method self.variants
441
- # @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent, Sentdm::Models::ChannelEvent, Sentdm::Models::ContactEvent, Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload, Sentdm::Models::CallEvent)]
442
- end
443
- end
444
- end
445
- end