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
@@ -0,0 +1,29 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class WebhookSenderProfile < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute event_filters
7
+ #
8
+ # @return [Hash{Symbol=>Array<String>}, nil]
9
+ optional :event_filters,
10
+ Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
11
+ nil?: true
12
+
13
+ # @!attribute event_types
14
+ #
15
+ # @return [Array<String>, nil]
16
+ optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
17
+
18
+ # @!method initialize(event_filters: nil, event_types: nil)
19
+ # The events a version 1 webhook's sender profile clones receive, as a response
20
+ # reports them.
21
+ #
22
+ # Its own type, field for field the same as the request's sender_profile. A
23
+ # response is not a request, whatever it carries.
24
+ #
25
+ # @param event_filters [Hash{Symbol=>Array<String>}, nil]
26
+ # @param event_types [Array<String>]
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,27 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class WebhookSenderProfileConfig < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute event_filters
7
+ #
8
+ # @return [Hash{Symbol=>Array<String>}, nil]
9
+ optional :event_filters,
10
+ Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
11
+ nil?: true
12
+
13
+ # @!attribute event_types
14
+ #
15
+ # @return [Array<String>, nil]
16
+ optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
17
+
18
+ # @!method initialize(event_filters: nil, event_types: nil)
19
+ # Request-only: the events an organization webhook's sender profile clones
20
+ # receive, one clone per existing and future profile. A version 1 webhook's
21
+ # responses report it as WebhookSenderProfileV3Response.
22
+ #
23
+ # @param event_filters [Hash{Symbol=>Array<String>}, nil]
24
+ # @param event_types [Array<String>]
25
+ end
26
+ end
27
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class WebhookTest < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute message
7
+ #
8
+ # @return [String, nil]
9
+ optional :message, String
10
+
11
+ # @!attribute success
12
+ #
13
+ # @return [Boolean, nil]
14
+ optional :success, Sentdm::Internal::Type::Boolean
15
+
16
+ # @!method initialize(message: nil, success: nil)
17
+ # @param message [String]
18
+ # @param success [Boolean]
19
+ end
20
+ end
21
+ end
@@ -59,8 +59,8 @@ module Sentdm
59
59
  # receive, one clone per existing and future profile. A version 1 webhook's
60
60
  # responses report it as WebhookSenderProfileV3Response.
61
61
  #
62
- # @return [Sentdm::Models::WebhookUpdateParams::SenderProfile, nil]
63
- optional :sender_profile, -> { Sentdm::WebhookUpdateParams::SenderProfile }, nil?: true
62
+ # @return [Sentdm::Models::WebhookSenderProfileConfig, nil]
63
+ optional :sender_profile, -> { Sentdm::WebhookSenderProfileConfig }, nil?: true
64
64
 
65
65
  # @!attribute timeout_seconds
66
66
  #
@@ -97,7 +97,7 @@ module Sentdm
97
97
  #
98
98
  # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
99
99
  #
100
- # @param sender_profile [Sentdm::Models::WebhookUpdateParams::SenderProfile, nil] Request-only: the events an organization webhook's sender profile clones receive
100
+ # @param sender_profile [Sentdm::Models::WebhookSenderProfileConfig, nil] Request-only: the events an organization webhook's sender profile clones receive
101
101
  #
102
102
  # @param timeout_seconds [Integer]
103
103
  #
@@ -106,28 +106,6 @@ module Sentdm
106
106
  # @param x_profile_id [String]
107
107
  #
108
108
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
109
-
110
- class SenderProfile < Sentdm::Internal::Type::BaseModel
111
- # @!attribute event_filters
112
- #
113
- # @return [Hash{Symbol=>Array<String>}, nil]
114
- optional :event_filters,
115
- Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
116
- nil?: true
117
-
118
- # @!attribute event_types
119
- #
120
- # @return [Array<String>, nil]
121
- optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
122
-
123
- # @!method initialize(event_filters: nil, event_types: nil)
124
- # Request-only: the events an organization webhook's sender profile clones
125
- # receive, one clone per existing and future profile. A version 1 webhook's
126
- # responses report it as WebhookSenderProfileV3Response.
127
- #
128
- # @param event_filters [Hash{Symbol=>Array<String>}, nil]
129
- # @param event_types [Array<String>]
130
- end
131
109
  end
132
110
  end
133
111
  end
@@ -0,0 +1,26 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class WebhooksList < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute pagination
7
+ # Pagination metadata for list responses
8
+ #
9
+ # @return [Sentdm::Models::PaginationMeta, nil]
10
+ optional :pagination, -> { Sentdm::PaginationMeta }
11
+
12
+ # @!attribute webhooks
13
+ # The webhooks on this page.
14
+ #
15
+ # @return [Array<Sentdm::Models::WebhookResponse>, nil]
16
+ optional :webhooks, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookResponse] }
17
+
18
+ # @!method initialize(pagination: nil, webhooks: nil)
19
+ # A paginated list of webhooks.
20
+ #
21
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
22
+ #
23
+ # @param webhooks [Array<Sentdm::Models::WebhookResponse>] The webhooks on this page.
24
+ end
25
+ end
26
+ end
data/lib/sentdm/models.rb CHANGED
@@ -39,44 +39,124 @@ module Sentdm
39
39
  mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
40
40
  end
41
41
 
42
+ Account = Sentdm::Models::Account
43
+
44
+ AccountChannels = Sentdm::Models::AccountChannels
45
+
46
+ AccountProfile = Sentdm::Models::AccountProfile
47
+
48
+ AccountRcsChannel = Sentdm::Models::AccountRcsChannel
49
+
50
+ AccountSMSChannel = Sentdm::Models::AccountSMSChannel
51
+
52
+ AccountWhatsappChannel = Sentdm::Models::AccountWhatsappChannel
53
+
42
54
  APIMeta = Sentdm::Models::APIMeta
43
55
 
56
+ APIResponseOfAccount = Sentdm::Models::APIResponseOfAccount
57
+
58
+ APIResponseOfCancelledMessage = Sentdm::Models::APIResponseOfCancelledMessage
59
+
60
+ APIResponseOfChannelsState = Sentdm::Models::APIResponseOfChannelsState
61
+
62
+ APIResponseOfComplianceRequirements = Sentdm::Models::APIResponseOfComplianceRequirements
63
+
44
64
  APIResponseOfContact = Sentdm::Models::APIResponseOfContact
45
65
 
46
66
  APIResponseOfContactMessageSummary = Sentdm::Models::APIResponseOfContactMessageSummary
47
67
 
68
+ APIResponseOfContactsList = Sentdm::Models::APIResponseOfContactsList
69
+
48
70
  APIResponseOfConversationMessagesList = Sentdm::Models::APIResponseOfConversationMessagesList
49
71
 
72
+ APIResponseOfMessage = Sentdm::Models::APIResponseOfMessage
73
+
74
+ APIResponseOfMessageActivities = Sentdm::Models::APIResponseOfMessageActivities
75
+
76
+ APIResponseOfNumberLookupResult = Sentdm::Models::APIResponseOfNumberLookupResult
77
+
78
+ APIResponseOfProfileCompletionAccepted = Sentdm::Models::APIResponseOfProfileCompletionAccepted
79
+
80
+ APIResponseOfProfileCompletionResult = Sentdm::Models::APIResponseOfProfileCompletionResult
81
+
50
82
  APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
51
83
 
84
+ APIResponseOfProfilesList = Sentdm::Models::APIResponseOfProfilesList
85
+
86
+ APIResponseOfSenderProfile = Sentdm::Models::APIResponseOfSenderProfile
87
+
88
+ APIResponseOfSenderProfilesList = Sentdm::Models::APIResponseOfSenderProfilesList
89
+
90
+ APIResponseOfTemplatesList = Sentdm::Models::APIResponseOfTemplatesList
91
+
52
92
  APIResponseOfUser = Sentdm::Models::APIResponseOfUser
53
93
 
94
+ APIResponseOfUsersList = Sentdm::Models::APIResponseOfUsersList
95
+
96
+ APIResponseOfWebhookEventsList = Sentdm::Models::APIResponseOfWebhookEventsList
97
+
98
+ APIResponseOfWebhookEventTypesList = Sentdm::Models::APIResponseOfWebhookEventTypesList
99
+
100
+ APIResponseOfWebhookSecret = Sentdm::Models::APIResponseOfWebhookSecret
101
+
102
+ APIResponseOfWebhooksList = Sentdm::Models::APIResponseOfWebhooksList
103
+
104
+ APIResponseOfWebhookTest = Sentdm::Models::APIResponseOfWebhookTest
105
+
54
106
  APIResponseTemplate = Sentdm::Models::APIResponseTemplate
55
107
 
56
108
  APIResponseWebhook = Sentdm::Models::APIResponseWebhook
57
109
 
58
110
  AuthenticationConfig = Sentdm::Models::AuthenticationConfig
59
111
 
112
+ BillingContact = Sentdm::Models::BillingContact
113
+
60
114
  BillingContactInfo = Sentdm::Models::BillingContactInfo
61
115
 
116
+ BrandBusiness = Sentdm::Models::BrandBusiness
117
+
62
118
  BrandBusinessInfo = Sentdm::Models::BrandBusinessInfo
63
119
 
120
+ BrandCompliance = Sentdm::Models::BrandCompliance
121
+
64
122
  BrandComplianceInfo = Sentdm::Models::BrandComplianceInfo
65
123
 
124
+ BrandContact = Sentdm::Models::BrandContact
125
+
66
126
  BrandContactInfo = Sentdm::Models::BrandContactInfo
67
127
 
68
128
  BrandsBrandData = Sentdm::Models::BrandsBrandData
69
129
 
130
+ BrandWithKYC = Sentdm::Models::BrandWithKYC
131
+
70
132
  CallEvent = Sentdm::Models::CallEvent
71
133
 
72
134
  CallEventPayload = Sentdm::Models::CallEventPayload
73
135
 
136
+ CancelledMessage = Sentdm::Models::CancelledMessage
137
+
74
138
  ChannelEvent = Sentdm::Models::ChannelEvent
75
139
 
76
140
  ChannelEventPayload = Sentdm::Models::ChannelEventPayload
77
141
 
142
+ ChannelListParams = Sentdm::Models::ChannelListParams
143
+
78
144
  Channels = Sentdm::Models::Channels
79
145
 
146
+ ChannelScore = Sentdm::Models::ChannelScore
147
+
148
+ ChannelsState = Sentdm::Models::ChannelsState
149
+
150
+ ComplianceAttachmentTemplate = Sentdm::Models::ComplianceAttachmentTemplate
151
+
152
+ ComplianceRequirement = Sentdm::Models::ComplianceRequirement
153
+
154
+ ComplianceRequirements = Sentdm::Models::ComplianceRequirements
155
+
156
+ ComplianceRetrieveRequirementsParams = Sentdm::Models::ComplianceRetrieveRequirementsParams
157
+
158
+ ComplianceSetupStep = Sentdm::Models::ComplianceSetupStep
159
+
80
160
  ContactCreateParams = Sentdm::Models::ContactCreateParams
81
161
 
82
162
  ContactDeleteParams = Sentdm::Models::ContactDeleteParams
@@ -95,6 +175,8 @@ module Sentdm
95
175
 
96
176
  ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
97
177
 
178
+ ContactsList = Sentdm::Models::ContactsList
179
+
98
180
  ContactUpdateParams = Sentdm::Models::ContactUpdateParams
99
181
 
100
182
  ConversationListMessagesParams = Sentdm::Models::ConversationListMessagesParams
@@ -105,18 +187,46 @@ module Sentdm
105
187
 
106
188
  DestinationCountry = Sentdm::Models::DestinationCountry
107
189
 
190
+ EntityType = Sentdm::Models::EntityType
191
+
108
192
  ErrorDetail = Sentdm::Models::ErrorDetail
109
193
 
194
+ InboundMedia = Sentdm::Models::InboundMedia
195
+
110
196
  InboundMessageEvent = Sentdm::Models::InboundMessageEvent
111
197
 
112
198
  InboundMessageEventPayload = Sentdm::Models::InboundMessageEventPayload
113
199
 
200
+ LinkEvent = Sentdm::Models::LinkEvent
201
+
202
+ LinkEventPayload = Sentdm::Models::LinkEventPayload
203
+
114
204
  MeRetrieveParams = Sentdm::Models::MeRetrieveParams
115
205
 
206
+ Message = Sentdm::Models::Message
207
+
208
+ MessageActivities = Sentdm::Models::MessageActivities
209
+
210
+ MessageActivity = Sentdm::Models::MessageActivity
211
+
212
+ MessageBody = Sentdm::Models::MessageBody
213
+
214
+ MessageButton = Sentdm::Models::MessageButton
215
+
216
+ MessageCancelParams = Sentdm::Models::MessageCancelParams
217
+
218
+ MessageChannelOptions = Sentdm::Models::MessageChannelOptions
219
+
116
220
  MessageEvent = Sentdm::Models::MessageEvent
117
221
 
118
222
  MessageEventPayload = Sentdm::Models::MessageEventPayload
119
223
 
224
+ MessageHeaderMedia = Sentdm::Models::MessageHeaderMedia
225
+
226
+ MessageMedia = Sentdm::Models::MessageMedia
227
+
228
+ MessageRecipient = Sentdm::Models::MessageRecipient
229
+
120
230
  MessageResendParams = Sentdm::Models::MessageResendParams
121
231
 
122
232
  MessageRetrieveActivitiesParams = Sentdm::Models::MessageRetrieveActivitiesParams
@@ -127,16 +237,30 @@ module Sentdm
127
237
 
128
238
  MessageSendResponse = Sentdm::Models::MessageSendResponse
129
239
 
240
+ MessageSendResult = Sentdm::Models::MessageSendResult
241
+
242
+ MessageStatusEvent = Sentdm::Models::MessageStatusEvent
243
+
244
+ MmsMarket = Sentdm::Models::MmsMarket
245
+
130
246
  MutationRequest = Sentdm::Models::MutationRequest
131
247
 
132
248
  NumberLookupParams = Sentdm::Models::NumberLookupParams
133
249
 
250
+ NumberLookupResult = Sentdm::Models::NumberLookupResult
251
+
252
+ PaginationCursors = Sentdm::Models::PaginationCursors
253
+
134
254
  PaginationMeta = Sentdm::Models::PaginationMeta
135
255
 
136
256
  PaymentDetails = Sentdm::Models::PaymentDetails
137
257
 
138
258
  ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
139
259
 
260
+ ProfileCompletionAccepted = Sentdm::Models::ProfileCompletionAccepted
261
+
262
+ ProfileCompletionResult = Sentdm::Models::ProfileCompletionResult
263
+
140
264
  ProfileCreateParams = Sentdm::Models::ProfileCreateParams
141
265
 
142
266
  ProfileDeleteParams = Sentdm::Models::ProfileDeleteParams
@@ -151,10 +275,44 @@ module Sentdm
151
275
 
152
276
  ProfileSettings = Sentdm::Models::ProfileSettings
153
277
 
278
+ ProfilesList = Sentdm::Models::ProfilesList
279
+
154
280
  ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
155
281
 
282
+ SenderProfile = Sentdm::Models::SenderProfile
283
+
284
+ SenderProfileBilling = Sentdm::Models::SenderProfileBilling
285
+
286
+ SenderProfileBillingRequest = Sentdm::Models::SenderProfileBillingRequest
287
+
288
+ SenderProfileChannels = Sentdm::Models::SenderProfileChannels
289
+
290
+ SenderProfileCreateParams = Sentdm::Models::SenderProfileCreateParams
291
+
292
+ SenderProfileDeleteParams = Sentdm::Models::SenderProfileDeleteParams
293
+
294
+ SenderProfileListParams = Sentdm::Models::SenderProfileListParams
295
+
296
+ SenderProfileRcs = Sentdm::Models::SenderProfileRcs
297
+
298
+ SenderProfileRetrieveParams = Sentdm::Models::SenderProfileRetrieveParams
299
+
300
+ SenderProfilesList = Sentdm::Models::SenderProfilesList
301
+
302
+ SenderProfileSMS = Sentdm::Models::SenderProfileSMS
303
+
304
+ SenderProfileUpdateParams = Sentdm::Models::SenderProfileUpdateParams
305
+
306
+ SenderProfileWhatsapp = Sentdm::Models::SenderProfileWhatsapp
307
+
308
+ TcrBrandIdentityStatus = Sentdm::Models::TcrBrandIdentityStatus
309
+
156
310
  TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
157
311
 
312
+ TcrBrandStatus = Sentdm::Models::TcrBrandStatus
313
+
314
+ TcrCampaignStatus = Sentdm::Models::TcrCampaignStatus
315
+
158
316
  TcrVertical = Sentdm::Models::TcrVertical
159
317
 
160
318
  Template = Sentdm::Models::Template
@@ -181,14 +339,26 @@ module Sentdm
181
339
 
182
340
  TemplateHeader = Sentdm::Models::TemplateHeader
183
341
 
342
+ TemplateHeaderLocation = Sentdm::Models::TemplateHeaderLocation
343
+
184
344
  TemplateListParams = Sentdm::Models::TemplateListParams
185
345
 
346
+ TemplateMediaItem = Sentdm::Models::TemplateMediaItem
347
+
348
+ TemplateMmsBodyContent = Sentdm::Models::TemplateMmsBodyContent
349
+
350
+ TemplateRef = Sentdm::Models::TemplateRef
351
+
186
352
  TemplateRetrieveParams = Sentdm::Models::TemplateRetrieveParams
187
353
 
354
+ TemplatesList = Sentdm::Models::TemplatesList
355
+
188
356
  TemplateUpdateParams = Sentdm::Models::TemplateUpdateParams
189
357
 
190
358
  TemplateVariable = Sentdm::Models::TemplateVariable
191
359
 
360
+ TemplateVariableProps = Sentdm::Models::TemplateVariableProps
361
+
192
362
  UserInviteParams = Sentdm::Models::UserInviteParams
193
363
 
194
364
  UserListParams = Sentdm::Models::UserListParams
@@ -199,6 +369,8 @@ module Sentdm
199
369
 
200
370
  UserRetrieveParams = Sentdm::Models::UserRetrieveParams
201
371
 
372
+ UsersList = Sentdm::Models::UsersList
373
+
202
374
  UserUpdateRoleParams = Sentdm::Models::UserUpdateRoleParams
203
375
 
204
376
  Voice = Sentdm::Models::Voice
@@ -207,8 +379,14 @@ module Sentdm
207
379
 
208
380
  WebhookDeleteParams = Sentdm::Models::WebhookDeleteParams
209
381
 
382
+ WebhookDelivery = Sentdm::Models::WebhookDelivery
383
+
384
+ WebhookEventsList = Sentdm::Models::WebhookEventsList
385
+
210
386
  WebhookEventType = Sentdm::Models::WebhookEventType
211
387
 
388
+ WebhookEventTypesList = Sentdm::Models::WebhookEventTypesList
389
+
212
390
  WebhookListEventsParams = Sentdm::Models::WebhookListEventsParams
213
391
 
214
392
  WebhookListEventTypesParams = Sentdm::Models::WebhookListEventTypesParams
@@ -221,6 +399,16 @@ module Sentdm
221
399
 
222
400
  WebhookRotateSecretParams = Sentdm::Models::WebhookRotateSecretParams
223
401
 
402
+ WebhookSecret = Sentdm::Models::WebhookSecret
403
+
404
+ WebhookSenderProfile = Sentdm::Models::WebhookSenderProfile
405
+
406
+ WebhookSenderProfileConfig = Sentdm::Models::WebhookSenderProfileConfig
407
+
408
+ WebhooksList = Sentdm::Models::WebhooksList
409
+
410
+ WebhookTest = Sentdm::Models::WebhookTest
411
+
224
412
  WebhookTestParams = Sentdm::Models::WebhookTestParams
225
413
 
226
414
  WebhookToggleStatusParams = Sentdm::Models::WebhookToggleStatusParams
@@ -0,0 +1,177 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Resources
5
+ class Channels
6
+ # The senders you send from, one per channel.
7
+ #
8
+ # **SMS is a list of markets**, each keyed by `(country, number_type)` — a
9
+ # customer can hold `us/10dlc` and `gb/alphanumeric` at once, so a market is
10
+ # addressed by the pair rather than by country alone. **WhatsApp and RCS are
11
+ # single**: a customer has one business account and one agent. **Voice is per
12
+ # number**: each number you hold can carry phone calls on its own
13
+ # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
14
+ # with its calls, one of them is the default line for calls placed from your app,
15
+ # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
16
+ # numbers with `GET /v3/channels/voice` and change one with
17
+ # `PATCH /v3/channels/voice/{number}`.
18
+ #
19
+ # ## Compliance lives on the market
20
+ #
21
+ # Adding a market records everything that market registers with, in its
22
+ # `compliance` object. Only **US `TEN_DLC`** registers with a regime — The
23
+ # Campaign Registry — and it is the only market whose compliance carries `brand`
24
+ # and `campaign`. Everywhere else compliance is documents, and many markets ask
25
+ # for none at all.
26
+ #
27
+ # `GET` and `PATCH` on a market return and accept the same shape, so what comes
28
+ # back can be sent back: an omitted key is left alone, and a key reported in
29
+ # `requirements` is the path into the body that clears it.
30
+ #
31
+ # Call `GET /v3/compliance/requirements` first — it answers what a market demands
32
+ # before you hold it, with a body you can fill in and post.
33
+ class Rcs
34
+ # Some parameter documentations has been truncated, see
35
+ # {Sentdm::Models::Channels::RcCreateParams} for more details.
36
+ #
37
+ # Asks for an RCS agent and records the order form the carriers vet it against.
38
+ # Always `202`: an agent is approved by the carriers, not by this call, and
39
+ # nothing here can make that happen sooner.
40
+ #
41
+ # ## What it asks for
42
+ #
43
+ # The RCS Agent Order Form — the same one our team fills in on your behalf today,
44
+ # so nothing has to be collected from you twice. **All fields are required** and
45
+ # must be submitted together so the carrier review has everything it needs. The
46
+ # only exception is `opt_in_screenshot_url`.
47
+ #
48
+ # **Agent identity:** `display_name`, `description`, `agent_use_case` (must be one
49
+ # of the accepted use cases; the error names the set), `brand_color` (six-digit
50
+ # hex, `#RRGGBB`).
51
+ #
52
+ # **Brand identity:** `brand_name` — the brand this agent presents. Not taken from
53
+ # `compliance.brand`: a business may present a different brand on RCS than the one
54
+ # its 10DLC registration is filed against, and the carriers vet this one.
55
+ # `privacy_policy_url`, `terms_and_conditions_url`, `website_url`, `logo_url`, and
56
+ # `banner_url` must be absolute `http(s)` URLs that the carriers can fetch without
57
+ # authentication. The form specifies 224×224 px and 50 KB for the logo and
58
+ # 1440×448 px and 200 KB for the banner; these cannot be checked without the image
59
+ # bytes.
60
+ #
61
+ # **Contact details:** `brand_phone_number`, `customer_support_phone_number`,
62
+ # `brand_email`, `customer_support_email`, `contact_name_and_title`.
63
+ #
64
+ # **Company:** `company_ein`, `entity_type`, `official_address` (street, city,
65
+ # state, postal_code, country), `brief_company_description`.
66
+ #
67
+ # **Consent and messages:** `opt_in_process_description`, `start_message`,
68
+ # `help_message`, `stop_message`, `sample_messages` (at least one example
69
+ # message).
70
+ #
71
+ # **Optional:** `opt_in_screenshot_url` (validated as an http(s) URL if supplied).
72
+ #
73
+ # Anything supplied is checked against accepted values rather than passed through:
74
+ # a value the provider rejects would otherwise surface days later, to somebody who
75
+ # cannot fix it without asking you.
76
+ #
77
+ # **A customer has one agent.** Asking again while you have one is `409`.
78
+ #
79
+ # ## What comes back, and what does not
80
+ #
81
+ # Returns **the agent** — the form as stored, plus `id` and `status`. Not your
82
+ # other channels, which this call cannot have changed.
83
+ #
84
+ # `status` is `PROVISIONING` until the agent is handed to the carriers and
85
+ # approved. **`GET /v3/channels` reports `rcs: null` until then** — a channel row
86
+ # is what routing reads to decide you are sendable, and writing one for an
87
+ # unapproved agent would claim a channel that cannot carry traffic.
88
+ #
89
+ # Send `x-profile-id` with an organization key to ask for one of your profiles'
90
+ # agents.
91
+ #
92
+ # @overload create(agent_use_case: nil, banner_url: nil, brand_color: nil, brand_email: nil, brand_name: nil, brand_phone_number: nil, brief_company_description: nil, company_ein: nil, contact_name_and_title: nil, customer_support_email: nil, customer_support_phone_number: nil, description: nil, display_name: nil, entity_type: nil, help_message: nil, logo_url: nil, official_address: nil, opt_in_process_description: nil, opt_in_screenshot_url: nil, privacy_policy_url: nil, sample_messages: nil, sandbox: nil, start_message: nil, stop_message: nil, terms_and_conditions_url: nil, website_url: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
93
+ #
94
+ # @param agent_use_case [Symbol, Sentdm::Models::Channels::RcCreateParams::AgentUseCase] Body param: Which kind of traffic the agent carries. One of the accepted use cas
95
+ #
96
+ # @param banner_url [String] Body param
97
+ #
98
+ # @param brand_color [String] Body param: Primary brand colour, as #RRGGBB. Three-digit shorthand is refused:
99
+ #
100
+ # @param brand_email [String] Body param
101
+ #
102
+ # @param brand_name [String] Body param: The brand this agent presents over RCS.
103
+ #
104
+ # @param brand_phone_number [String] Body param: The brand's own number. Also becomes the agent's canonical sending n
105
+ #
106
+ # @param brief_company_description [String] Body param
107
+ #
108
+ # @param company_ein [String] Body param
109
+ #
110
+ # @param contact_name_and_title [String] Body param
111
+ #
112
+ # @param customer_support_email [String] Body param
113
+ #
114
+ # @param customer_support_phone_number [String] Body param
115
+ #
116
+ # @param description [String] Body param: What the agent is for, shown to recipients. Capped by the carriers,
117
+ #
118
+ # @param display_name [String] Body param: The name the agent shows in the messaging client.
119
+ #
120
+ # @param entity_type [String] Body param
121
+ #
122
+ # @param help_message [String] Body param
123
+ #
124
+ # @param logo_url [String] Body param: Publicly reachable logo. It has to be fetchable without authenticati
125
+ #
126
+ # @param official_address [Sentdm::Models::Channels::RcsAddress] Body param: The registered address of the company behind the agent.
127
+ #
128
+ # @param opt_in_process_description [String] Body param: How recipients opt in, in prose. The carriers read this one.
129
+ #
130
+ # @param opt_in_screenshot_url [String, nil] Body param: A screenshot of the opt-in, as a publicly fetchable URL.
131
+ #
132
+ # @param privacy_policy_url [String] Body param: Required by US carriers. Must be an absolute http(s) URL they can fe
133
+ #
134
+ # @param sample_messages [Array<String>] Body param: Examples of what the agent will send, for the review.
135
+ #
136
+ # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
137
+ #
138
+ # @param start_message [String] Body param
139
+ #
140
+ # @param stop_message [String] Body param
141
+ #
142
+ # @param terms_and_conditions_url [String] Body param
143
+ #
144
+ # @param website_url [String] Body param: The brand's own site.
145
+ #
146
+ # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
147
+ #
148
+ # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
149
+ #
150
+ # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
151
+ #
152
+ # @return [Sentdm::Models::Channels::APIResponseOfRcsAgent]
153
+ #
154
+ # @see Sentdm::Models::Channels::RcCreateParams
155
+ def create(params = {})
156
+ parsed, options = Sentdm::Channels::RcCreateParams.dump_request(params)
157
+ header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
158
+ @client.request(
159
+ method: :post,
160
+ path: "v3/channels/rcs",
161
+ headers: parsed.slice(*header_params.keys).transform_keys(header_params),
162
+ body: parsed.except(*header_params.keys),
163
+ model: Sentdm::Channels::APIResponseOfRcsAgent,
164
+ options: options
165
+ )
166
+ end
167
+
168
+ # @api private
169
+ #
170
+ # @param client [Sentdm::Client]
171
+ def initialize(client:)
172
+ @client = client
173
+ end
174
+ end
175
+ end
176
+ end
177
+ end