sentdm 0.19.0 → 0.20.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 (284) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +31 -1
  4. data/lib/sentdm/internal/type/base_model.rb +5 -5
  5. data/lib/sentdm/internal/type/enum.rb +25 -0
  6. data/lib/sentdm/models/api_meta.rb +34 -0
  7. data/lib/sentdm/models/api_response_of_contact.rb +46 -0
  8. data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
  9. data/lib/sentdm/models/api_response_of_user.rb +43 -0
  10. data/lib/sentdm/models/api_response_template.rb +43 -0
  11. data/lib/sentdm/models/api_response_webhook.rb +43 -0
  12. data/lib/sentdm/models/billing_contact_info.rb +47 -0
  13. data/lib/sentdm/models/brands_brand_data.rb +38 -0
  14. data/lib/sentdm/models/contact_delete_params.rb +2 -16
  15. data/lib/sentdm/models/contact_list_response.rb +12 -278
  16. data/lib/sentdm/models/contact_response.rb +126 -0
  17. data/lib/sentdm/models/destination_country.rb +21 -0
  18. data/lib/sentdm/models/error_detail.rb +42 -0
  19. data/lib/sentdm/models/me_retrieve_response.rb +12 -204
  20. data/lib/sentdm/models/message_retrieve_activities_response.rb +6 -74
  21. data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
  22. data/lib/sentdm/models/message_send_response.rb +6 -74
  23. data/lib/sentdm/models/mutation_request.rb +20 -0
  24. data/lib/sentdm/models/number_lookup_response.rb +6 -74
  25. data/lib/sentdm/models/pagination_meta.rb +80 -0
  26. data/lib/sentdm/models/payment_details.rb +44 -0
  27. data/lib/sentdm/models/profile_complete_response.rb +6 -74
  28. data/lib/sentdm/models/profile_create_params.rb +9 -423
  29. data/lib/sentdm/models/profile_delete_params.rb +2 -16
  30. data/lib/sentdm/models/profile_detail.rb +605 -0
  31. data/lib/sentdm/models/profile_list_response.rb +9 -753
  32. data/lib/sentdm/models/profile_settings.rb +66 -0
  33. data/lib/sentdm/models/profile_update_params.rb +9 -423
  34. data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +45 -0
  35. data/lib/sentdm/models/profiles/base_dto.rb +32 -0
  36. data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -165
  37. data/lib/sentdm/models/profiles/campaign_data.rb +123 -0
  38. data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
  39. data/lib/sentdm/models/profiles/campaign_list_response.rb +9 -420
  40. data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -165
  41. data/lib/sentdm/models/profiles/messaging_use_case_us.rb +28 -0
  42. data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +29 -0
  43. data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +248 -0
  44. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +34 -0
  45. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +48 -0
  46. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +38 -0
  47. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +81 -0
  48. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +34 -0
  49. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +39 -0
  50. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +116 -0
  51. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +75 -0
  52. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +58 -0
  53. data/lib/sentdm/models/tcr_brand_relationship.rb +18 -0
  54. data/lib/sentdm/models/tcr_vertical.rb +36 -0
  55. data/lib/sentdm/models/template.rb +90 -0
  56. data/lib/sentdm/models/template_body_content.rb +27 -0
  57. data/lib/sentdm/models/template_create_params.rb +3 -889
  58. data/lib/sentdm/models/template_definition.rb +66 -0
  59. data/lib/sentdm/models/template_list_response.rb +12 -242
  60. data/lib/sentdm/models/template_update_params.rb +3 -889
  61. data/lib/sentdm/models/template_variable.rb +80 -0
  62. data/lib/sentdm/models/user_list_response.rb +9 -154
  63. data/lib/sentdm/models/user_remove_params.rb +2 -16
  64. data/lib/sentdm/models/user_response.rb +82 -0
  65. data/lib/sentdm/models/webhook_event_type.rb +45 -0
  66. data/lib/sentdm/models/webhook_list_event_types_response.rb +9 -118
  67. data/lib/sentdm/models/webhook_list_events_response.rb +9 -153
  68. data/lib/sentdm/models/webhook_list_response.rb +12 -247
  69. data/lib/sentdm/models/webhook_response.rb +95 -0
  70. data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
  71. data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
  72. data/lib/sentdm/models/webhook_test_response.rb +6 -74
  73. data/lib/sentdm/models.rb +77 -0
  74. data/lib/sentdm/resources/contacts.rb +6 -6
  75. data/lib/sentdm/resources/profiles/campaigns.rb +6 -6
  76. data/lib/sentdm/resources/profiles.rb +12 -12
  77. data/lib/sentdm/resources/templates.rb +8 -8
  78. data/lib/sentdm/resources/users.rb +6 -6
  79. data/lib/sentdm/resources/webhooks.rb +8 -8
  80. data/lib/sentdm/version.rb +1 -1
  81. data/lib/sentdm.rb +40 -18
  82. data/rbi/sentdm/models/api_meta.rbi +55 -0
  83. data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
  84. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
  85. data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
  86. data/rbi/sentdm/models/api_response_template.rbi +74 -0
  87. data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
  88. data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
  89. data/rbi/sentdm/models/brands_brand_data.rbi +104 -0
  90. data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
  91. data/rbi/sentdm/models/contact_list_response.rbi +16 -505
  92. data/rbi/sentdm/models/contact_response.rbi +183 -0
  93. data/rbi/sentdm/models/destination_country.rbi +32 -0
  94. data/rbi/sentdm/models/error_detail.rbi +66 -0
  95. data/rbi/sentdm/models/me_retrieve_response.rbi +16 -335
  96. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +8 -154
  97. data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
  98. data/rbi/sentdm/models/message_send_response.rbi +8 -135
  99. data/rbi/sentdm/models/mutation_request.rbi +32 -0
  100. data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
  101. data/rbi/sentdm/models/pagination_meta.rbi +135 -0
  102. data/rbi/sentdm/models/payment_details.rbi +59 -0
  103. data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
  104. data/rbi/sentdm/models/profile_create_params.rbi +12 -810
  105. data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
  106. data/rbi/sentdm/models/profile_detail.rbi +874 -0
  107. data/rbi/sentdm/models/profile_list_response.rbi +14 -1400
  108. data/rbi/sentdm/models/profile_settings.rbi +86 -0
  109. data/rbi/sentdm/models/profile_update_params.rbi +12 -810
  110. data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +83 -0
  111. data/rbi/sentdm/models/profiles/base_dto.rbi +53 -0
  112. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -289
  113. data/rbi/sentdm/models/profiles/campaign_data.rbi +148 -0
  114. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
  115. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +11 -733
  116. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -289
  117. data/rbi/sentdm/models/profiles/messaging_use_case_us.rbi +73 -0
  118. data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +51 -0
  119. data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +425 -0
  120. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +56 -0
  121. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +87 -0
  122. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +72 -0
  123. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +104 -0
  124. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +57 -0
  125. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +59 -0
  126. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +180 -0
  127. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +95 -0
  128. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +81 -0
  129. data/rbi/sentdm/models/tcr_brand_relationship.rbi +30 -0
  130. data/rbi/sentdm/models/tcr_vertical.rbi +41 -0
  131. data/rbi/sentdm/models/template.rbi +129 -0
  132. data/rbi/sentdm/models/template_body_content.rbi +43 -0
  133. data/rbi/sentdm/models/template_create_params.rbi +4 -1701
  134. data/rbi/sentdm/models/template_definition.rbi +164 -0
  135. data/rbi/sentdm/models/template_list_response.rbi +16 -454
  136. data/rbi/sentdm/models/template_update_params.rbi +4 -1701
  137. data/rbi/sentdm/models/template_variable.rbi +120 -0
  138. data/rbi/sentdm/models/user_list_response.rbi +14 -271
  139. data/rbi/sentdm/models/user_remove_params.rbi +2 -19
  140. data/rbi/sentdm/models/user_response.rbi +118 -0
  141. data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
  142. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +12 -247
  143. data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
  144. data/rbi/sentdm/models/webhook_list_response.rbi +16 -462
  145. data/rbi/sentdm/models/webhook_response.rbi +140 -0
  146. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
  147. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
  148. data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
  149. data/rbi/sentdm/models.rbi +77 -0
  150. data/rbi/sentdm/resources/contacts.rbi +3 -3
  151. data/rbi/sentdm/resources/profiles/campaigns.rbi +4 -4
  152. data/rbi/sentdm/resources/profiles.rbi +9 -13
  153. data/rbi/sentdm/resources/templates.rbi +5 -6
  154. data/rbi/sentdm/resources/users.rbi +3 -3
  155. data/rbi/sentdm/resources/webhooks.rbi +4 -4
  156. data/sig/sentdm/models/api_meta.rbs +27 -0
  157. data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
  158. data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
  159. data/sig/sentdm/models/api_response_of_user.rbs +39 -0
  160. data/sig/sentdm/models/api_response_template.rbs +39 -0
  161. data/sig/sentdm/models/api_response_webhook.rbs +39 -0
  162. data/sig/sentdm/models/billing_contact_info.rbs +30 -0
  163. data/sig/sentdm/models/brands_brand_data.rbs +30 -0
  164. data/sig/sentdm/models/contact_delete_params.rbs +6 -10
  165. data/sig/sentdm/models/contact_list_response.rbs +20 -256
  166. data/sig/sentdm/models/contact_response.rbs +111 -0
  167. data/sig/sentdm/models/destination_country.rbs +19 -0
  168. data/sig/sentdm/models/error_detail.rbs +39 -0
  169. data/sig/sentdm/models/me_retrieve_response.rbs +18 -176
  170. data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -71
  171. data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
  172. data/sig/sentdm/models/message_send_response.rbs +9 -71
  173. data/sig/sentdm/models/mutation_request.rbs +15 -0
  174. data/sig/sentdm/models/number_lookup_response.rbs +9 -71
  175. data/sig/sentdm/models/pagination_meta.rbs +67 -0
  176. data/sig/sentdm/models/payment_details.rbs +30 -0
  177. data/sig/sentdm/models/profile_complete_response.rbs +9 -71
  178. data/sig/sentdm/models/profile_create_params.rbs +12 -363
  179. data/sig/sentdm/models/profile_delete_params.rbs +6 -10
  180. data/sig/sentdm/models/profile_detail.rbs +474 -0
  181. data/sig/sentdm/models/profile_list_response.rbs +15 -645
  182. data/sig/sentdm/models/profile_settings.rbs +50 -0
  183. data/sig/sentdm/models/profile_update_params.rbs +12 -363
  184. data/sig/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbs +41 -0
  185. data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
  186. data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -138
  187. data/sig/sentdm/models/profiles/campaign_data.rbs +82 -0
  188. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
  189. data/sig/sentdm/models/profiles/campaign_list_response.rbs +13 -396
  190. data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -138
  191. data/sig/sentdm/models/profiles/messaging_use_case_us.rbs +40 -0
  192. data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +27 -0
  193. data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +299 -0
  194. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +24 -0
  195. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +35 -0
  196. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +32 -0
  197. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +75 -0
  198. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +30 -0
  199. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +30 -0
  200. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbs +89 -0
  201. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbs +55 -0
  202. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbs +45 -0
  203. data/sig/sentdm/models/tcr_brand_relationship.rbs +22 -0
  204. data/sig/sentdm/models/tcr_vertical.rbs +58 -0
  205. data/sig/sentdm/models/template.rbs +79 -0
  206. data/sig/sentdm/models/template_body_content.rbs +30 -0
  207. data/sig/sentdm/models/template_create_params.rbs +6 -853
  208. data/sig/sentdm/models/template_definition.rbs +45 -0
  209. data/sig/sentdm/models/template_list_response.rbs +19 -225
  210. data/sig/sentdm/models/template_update_params.rbs +4 -851
  211. data/sig/sentdm/models/template_variable.rbs +84 -0
  212. data/sig/sentdm/models/user_list_response.rbs +15 -151
  213. data/sig/sentdm/models/user_remove_params.rbs +6 -10
  214. data/sig/sentdm/models/user_response.rbs +72 -0
  215. data/sig/sentdm/models/webhook_event_type.rbs +51 -0
  216. data/sig/sentdm/models/webhook_list_event_types_response.rbs +15 -130
  217. data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
  218. data/sig/sentdm/models/webhook_list_response.rbs +20 -248
  219. data/sig/sentdm/models/webhook_response.rbs +103 -0
  220. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
  221. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
  222. data/sig/sentdm/models/webhook_test_response.rbs +9 -71
  223. data/sig/sentdm/models.rbs +68 -0
  224. data/sig/sentdm/resources/contacts.rbs +3 -3
  225. data/sig/sentdm/resources/profiles/campaigns.rbs +4 -4
  226. data/sig/sentdm/resources/profiles.rbs +9 -9
  227. data/sig/sentdm/resources/templates.rbs +5 -5
  228. data/sig/sentdm/resources/users.rbs +3 -3
  229. data/sig/sentdm/resources/webhooks.rbs +4 -4
  230. metadata +121 -55
  231. data/lib/sentdm/models/contact_create_response.rb +0 -236
  232. data/lib/sentdm/models/contact_retrieve_response.rb +0 -236
  233. data/lib/sentdm/models/contact_update_response.rb +0 -236
  234. data/lib/sentdm/models/profile_create_response.rb +0 -781
  235. data/lib/sentdm/models/profile_retrieve_response.rb +0 -783
  236. data/lib/sentdm/models/profile_update_response.rb +0 -781
  237. data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -459
  238. data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -459
  239. data/lib/sentdm/models/template_create_response.rb +0 -197
  240. data/lib/sentdm/models/template_retrieve_response.rb +0 -197
  241. data/lib/sentdm/models/template_update_response.rb +0 -197
  242. data/lib/sentdm/models/user_invite_response.rb +0 -189
  243. data/lib/sentdm/models/user_retrieve_response.rb +0 -189
  244. data/lib/sentdm/models/user_update_role_response.rb +0 -189
  245. data/lib/sentdm/models/webhook_create_response.rb +0 -204
  246. data/lib/sentdm/models/webhook_retrieve_response.rb +0 -204
  247. data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -204
  248. data/lib/sentdm/models/webhook_update_response.rb +0 -204
  249. data/rbi/sentdm/models/contact_create_response.rbi +0 -390
  250. data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -392
  251. data/rbi/sentdm/models/contact_update_response.rbi +0 -390
  252. data/rbi/sentdm/models/profile_create_response.rbi +0 -1439
  253. data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1443
  254. data/rbi/sentdm/models/profile_update_response.rbi +0 -1439
  255. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -814
  256. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -814
  257. data/rbi/sentdm/models/template_create_response.rbi +0 -339
  258. data/rbi/sentdm/models/template_retrieve_response.rbi +0 -345
  259. data/rbi/sentdm/models/template_update_response.rbi +0 -339
  260. data/rbi/sentdm/models/user_invite_response.rbi +0 -323
  261. data/rbi/sentdm/models/user_retrieve_response.rbi +0 -323
  262. data/rbi/sentdm/models/user_update_role_response.rbi +0 -328
  263. data/rbi/sentdm/models/webhook_create_response.rbi +0 -348
  264. data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -350
  265. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -366
  266. data/rbi/sentdm/models/webhook_update_response.rbi +0 -348
  267. data/sig/sentdm/models/contact_create_response.rbs +0 -209
  268. data/sig/sentdm/models/contact_retrieve_response.rbs +0 -209
  269. data/sig/sentdm/models/contact_update_response.rbs +0 -209
  270. data/sig/sentdm/models/profile_create_response.rbs +0 -662
  271. data/sig/sentdm/models/profile_retrieve_response.rbs +0 -662
  272. data/sig/sentdm/models/profile_update_response.rbs +0 -662
  273. data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -424
  274. data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -424
  275. data/sig/sentdm/models/template_create_response.rbs +0 -177
  276. data/sig/sentdm/models/template_retrieve_response.rbs +0 -177
  277. data/sig/sentdm/models/template_update_response.rbs +0 -177
  278. data/sig/sentdm/models/user_invite_response.rbs +0 -170
  279. data/sig/sentdm/models/user_retrieve_response.rbs +0 -170
  280. data/sig/sentdm/models/user_update_role_response.rbs +0 -170
  281. data/sig/sentdm/models/webhook_create_response.rbs +0 -201
  282. data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -201
  283. data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -201
  284. data/sig/sentdm/models/webhook_update_response.rbs +0 -201
@@ -24,8 +24,8 @@ module Sentdm
24
24
  # Complete definition of a message template including header, body, footer, and
25
25
  # buttons
26
26
  #
27
- # @return [Sentdm::Models::TemplateCreateParams::Definition, nil]
28
- optional :definition, -> { Sentdm::TemplateCreateParams::Definition }
27
+ # @return [Sentdm::Models::TemplateDefinition, nil]
28
+ optional :definition, -> { Sentdm::TemplateDefinition }
29
29
 
30
30
  # @!attribute language
31
31
  # Template language code (e.g., en_US) (optional, auto-detected if not provided)
@@ -64,7 +64,7 @@ module Sentdm
64
64
  #
65
65
  # @param creation_source [String, nil] Source of template creation (default: from-api)
66
66
  #
67
- # @param definition [Sentdm::Models::TemplateCreateParams::Definition] Complete definition of a message template including header, body, footer, and bu
67
+ # @param definition [Sentdm::Models::TemplateDefinition] Complete definition of a message template including header, body, footer, and bu
68
68
  #
69
69
  # @param language [String, nil] Template language code (e.g., en_US) (optional, auto-detected if not provided)
70
70
  #
@@ -77,892 +77,6 @@ module Sentdm
77
77
  # @param x_profile_id [String]
78
78
  #
79
79
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
80
-
81
- class Definition < Sentdm::Internal::Type::BaseModel
82
- # @!attribute body
83
- # Body section of a message template with channel-specific content
84
- #
85
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body]
86
- required :body, -> { Sentdm::TemplateCreateParams::Definition::Body }
87
-
88
- # @!attribute authentication_config
89
- # Configuration for AUTHENTICATION category templates
90
- #
91
- # @return [Sentdm::Models::TemplateCreateParams::Definition::AuthenticationConfig, nil]
92
- optional :authentication_config,
93
- -> { Sentdm::TemplateCreateParams::Definition::AuthenticationConfig },
94
- api_name: :authenticationConfig,
95
- nil?: true
96
-
97
- # @!attribute buttons
98
- # Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
99
- #
100
- # @return [Array<Sentdm::Models::TemplateCreateParams::Definition::Button>, nil]
101
- optional :buttons,
102
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateCreateParams::Definition::Button] },
103
- nil?: true
104
-
105
- # @!attribute definition_version
106
- # The version of the template definition format
107
- #
108
- # @return [String, nil]
109
- optional :definition_version, String, api_name: :definitionVersion, nil?: true
110
-
111
- # @!attribute footer
112
- # Footer section of a message template
113
- #
114
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Footer, nil]
115
- optional :footer, -> { Sentdm::TemplateCreateParams::Definition::Footer }, nil?: true
116
-
117
- # @!attribute header
118
- # Header section of a message template
119
- #
120
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Header, nil]
121
- optional :header, -> { Sentdm::TemplateCreateParams::Definition::Header }, nil?: true
122
-
123
- # @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
124
- # Complete definition of a message template including header, body, footer, and
125
- # buttons
126
- #
127
- # @param body [Sentdm::Models::TemplateCreateParams::Definition::Body] Body section of a message template with channel-specific content
128
- #
129
- # @param authentication_config [Sentdm::Models::TemplateCreateParams::Definition::AuthenticationConfig, nil] Configuration for AUTHENTICATION category templates
130
- #
131
- # @param buttons [Array<Sentdm::Models::TemplateCreateParams::Definition::Button>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
132
- #
133
- # @param definition_version [String, nil] The version of the template definition format
134
- #
135
- # @param footer [Sentdm::Models::TemplateCreateParams::Definition::Footer, nil] Footer section of a message template
136
- #
137
- # @param header [Sentdm::Models::TemplateCreateParams::Definition::Header, nil] Header section of a message template
138
-
139
- # @see Sentdm::Models::TemplateCreateParams::Definition#body
140
- class Body < Sentdm::Internal::Type::BaseModel
141
- # @!attribute multi_channel
142
- # Content that will be used for all channels (SMS and WhatsApp) unless
143
- # channel-specific content is provided
144
- #
145
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::MultiChannel, nil]
146
- optional :multi_channel,
147
- -> { Sentdm::TemplateCreateParams::Definition::Body::MultiChannel },
148
- api_name: :multiChannel,
149
- nil?: true
150
-
151
- # @!attribute rcs
152
- # RCS-specific content that overrides multi-channel content for RCS messages
153
- #
154
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::Rcs, nil]
155
- optional :rcs, -> { Sentdm::TemplateCreateParams::Definition::Body::Rcs }, nil?: true
156
-
157
- # @!attribute sms
158
- # SMS-specific content that overrides multi-channel content for SMS messages
159
- #
160
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::SMS, nil]
161
- optional :sms, -> { Sentdm::TemplateCreateParams::Definition::Body::SMS }, nil?: true
162
-
163
- # @!attribute whatsapp
164
- # WhatsApp-specific content that overrides multi-channel content for WhatsApp
165
- # messages
166
- #
167
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::Whatsapp, nil]
168
- optional :whatsapp, -> { Sentdm::TemplateCreateParams::Definition::Body::Whatsapp }, nil?: true
169
-
170
- # @!method initialize(multi_channel: nil, rcs: nil, sms: nil, whatsapp: nil)
171
- # Some parameter documentations has been truncated, see
172
- # {Sentdm::Models::TemplateCreateParams::Definition::Body} for more details.
173
- #
174
- # Body section of a message template with channel-specific content
175
- #
176
- # @param multi_channel [Sentdm::Models::TemplateCreateParams::Definition::Body::MultiChannel, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
177
- #
178
- # @param rcs [Sentdm::Models::TemplateCreateParams::Definition::Body::Rcs, nil] RCS-specific content that overrides multi-channel content for RCS messages
179
- #
180
- # @param sms [Sentdm::Models::TemplateCreateParams::Definition::Body::SMS, nil] SMS-specific content that overrides multi-channel content for SMS messages
181
- #
182
- # @param whatsapp [Sentdm::Models::TemplateCreateParams::Definition::Body::Whatsapp, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
183
-
184
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body#multi_channel
185
- class MultiChannel < Sentdm::Internal::Type::BaseModel
186
- # @!attribute template
187
- #
188
- # @return [String]
189
- required :template, String
190
-
191
- # @!attribute type
192
- #
193
- # @return [String, nil]
194
- optional :type, String, nil?: true
195
-
196
- # @!attribute variables
197
- #
198
- # @return [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::MultiChannel::Variable>, nil]
199
- optional :variables,
200
- -> {
201
- Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateCreateParams::Definition::Body::MultiChannel::Variable]
202
- },
203
- nil?: true
204
-
205
- # @!method initialize(template:, type: nil, variables: nil)
206
- # Content that will be used for all channels (SMS and WhatsApp) unless
207
- # channel-specific content is provided
208
- #
209
- # @param template [String]
210
- # @param type [String, nil]
211
- # @param variables [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::MultiChannel::Variable>, nil]
212
-
213
- class Variable < Sentdm::Internal::Type::BaseModel
214
- # @!attribute name
215
- #
216
- # @return [String]
217
- required :name, String
218
-
219
- # @!attribute props
220
- #
221
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::MultiChannel::Variable::Props]
222
- required :props, -> { Sentdm::TemplateCreateParams::Definition::Body::MultiChannel::Variable::Props }
223
-
224
- # @!attribute type
225
- #
226
- # @return [String]
227
- required :type, String
228
-
229
- # @!attribute id
230
- #
231
- # @return [Integer, nil]
232
- optional :id, Integer
233
-
234
- # @!method initialize(name:, props:, type:, id: nil)
235
- # @param name [String]
236
- # @param props [Sentdm::Models::TemplateCreateParams::Definition::Body::MultiChannel::Variable::Props]
237
- # @param type [String]
238
- # @param id [Integer]
239
-
240
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body::MultiChannel::Variable#props
241
- class Props < Sentdm::Internal::Type::BaseModel
242
- # @!attribute media_type
243
- #
244
- # @return [String]
245
- required :media_type, String, api_name: :mediaType
246
-
247
- # @!attribute sample
248
- #
249
- # @return [String]
250
- required :sample, String
251
-
252
- # @!attribute url
253
- #
254
- # @return [String]
255
- required :url, String
256
-
257
- # @!attribute variable_type
258
- #
259
- # @return [String]
260
- required :variable_type, String, api_name: :variableType
261
-
262
- # @!attribute alt
263
- #
264
- # @return [String, nil]
265
- optional :alt, String, nil?: true
266
-
267
- # @!attribute regex
268
- #
269
- # @return [String, nil]
270
- optional :regex, String, nil?: true
271
-
272
- # @!attribute short_url
273
- #
274
- # @return [String, nil]
275
- optional :short_url, String, api_name: :shortUrl, nil?: true
276
-
277
- # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
278
- # @param media_type [String]
279
- # @param sample [String]
280
- # @param url [String]
281
- # @param variable_type [String]
282
- # @param alt [String, nil]
283
- # @param regex [String, nil]
284
- # @param short_url [String, nil]
285
- end
286
- end
287
- end
288
-
289
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body#rcs
290
- class Rcs < Sentdm::Internal::Type::BaseModel
291
- # @!attribute template
292
- #
293
- # @return [String]
294
- required :template, String
295
-
296
- # @!attribute type
297
- #
298
- # @return [String, nil]
299
- optional :type, String, nil?: true
300
-
301
- # @!attribute variables
302
- #
303
- # @return [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::Rcs::Variable>, nil]
304
- optional :variables,
305
- -> {
306
- Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateCreateParams::Definition::Body::Rcs::Variable]
307
- },
308
- nil?: true
309
-
310
- # @!method initialize(template:, type: nil, variables: nil)
311
- # RCS-specific content that overrides multi-channel content for RCS messages
312
- #
313
- # @param template [String]
314
- # @param type [String, nil]
315
- # @param variables [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::Rcs::Variable>, nil]
316
-
317
- class Variable < Sentdm::Internal::Type::BaseModel
318
- # @!attribute name
319
- #
320
- # @return [String]
321
- required :name, String
322
-
323
- # @!attribute props
324
- #
325
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::Rcs::Variable::Props]
326
- required :props, -> { Sentdm::TemplateCreateParams::Definition::Body::Rcs::Variable::Props }
327
-
328
- # @!attribute type
329
- #
330
- # @return [String]
331
- required :type, String
332
-
333
- # @!attribute id
334
- #
335
- # @return [Integer, nil]
336
- optional :id, Integer
337
-
338
- # @!method initialize(name:, props:, type:, id: nil)
339
- # @param name [String]
340
- # @param props [Sentdm::Models::TemplateCreateParams::Definition::Body::Rcs::Variable::Props]
341
- # @param type [String]
342
- # @param id [Integer]
343
-
344
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body::Rcs::Variable#props
345
- class Props < Sentdm::Internal::Type::BaseModel
346
- # @!attribute media_type
347
- #
348
- # @return [String]
349
- required :media_type, String, api_name: :mediaType
350
-
351
- # @!attribute sample
352
- #
353
- # @return [String]
354
- required :sample, String
355
-
356
- # @!attribute url
357
- #
358
- # @return [String]
359
- required :url, String
360
-
361
- # @!attribute variable_type
362
- #
363
- # @return [String]
364
- required :variable_type, String, api_name: :variableType
365
-
366
- # @!attribute alt
367
- #
368
- # @return [String, nil]
369
- optional :alt, String, nil?: true
370
-
371
- # @!attribute regex
372
- #
373
- # @return [String, nil]
374
- optional :regex, String, nil?: true
375
-
376
- # @!attribute short_url
377
- #
378
- # @return [String, nil]
379
- optional :short_url, String, api_name: :shortUrl, nil?: true
380
-
381
- # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
382
- # @param media_type [String]
383
- # @param sample [String]
384
- # @param url [String]
385
- # @param variable_type [String]
386
- # @param alt [String, nil]
387
- # @param regex [String, nil]
388
- # @param short_url [String, nil]
389
- end
390
- end
391
- end
392
-
393
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body#sms
394
- class SMS < Sentdm::Internal::Type::BaseModel
395
- # @!attribute template
396
- #
397
- # @return [String]
398
- required :template, String
399
-
400
- # @!attribute type
401
- #
402
- # @return [String, nil]
403
- optional :type, String, nil?: true
404
-
405
- # @!attribute variables
406
- #
407
- # @return [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable>, nil]
408
- optional :variables,
409
- -> {
410
- Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateCreateParams::Definition::Body::SMS::Variable]
411
- },
412
- nil?: true
413
-
414
- # @!method initialize(template:, type: nil, variables: nil)
415
- # SMS-specific content that overrides multi-channel content for SMS messages
416
- #
417
- # @param template [String]
418
- # @param type [String, nil]
419
- # @param variables [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable>, nil]
420
-
421
- class Variable < Sentdm::Internal::Type::BaseModel
422
- # @!attribute name
423
- #
424
- # @return [String]
425
- required :name, String
426
-
427
- # @!attribute props
428
- #
429
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable::Props]
430
- required :props, -> { Sentdm::TemplateCreateParams::Definition::Body::SMS::Variable::Props }
431
-
432
- # @!attribute type
433
- #
434
- # @return [String]
435
- required :type, String
436
-
437
- # @!attribute id
438
- #
439
- # @return [Integer, nil]
440
- optional :id, Integer
441
-
442
- # @!method initialize(name:, props:, type:, id: nil)
443
- # @param name [String]
444
- # @param props [Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable::Props]
445
- # @param type [String]
446
- # @param id [Integer]
447
-
448
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body::SMS::Variable#props
449
- class Props < Sentdm::Internal::Type::BaseModel
450
- # @!attribute media_type
451
- #
452
- # @return [String]
453
- required :media_type, String, api_name: :mediaType
454
-
455
- # @!attribute sample
456
- #
457
- # @return [String]
458
- required :sample, String
459
-
460
- # @!attribute url
461
- #
462
- # @return [String]
463
- required :url, String
464
-
465
- # @!attribute variable_type
466
- #
467
- # @return [String]
468
- required :variable_type, String, api_name: :variableType
469
-
470
- # @!attribute alt
471
- #
472
- # @return [String, nil]
473
- optional :alt, String, nil?: true
474
-
475
- # @!attribute regex
476
- #
477
- # @return [String, nil]
478
- optional :regex, String, nil?: true
479
-
480
- # @!attribute short_url
481
- #
482
- # @return [String, nil]
483
- optional :short_url, String, api_name: :shortUrl, nil?: true
484
-
485
- # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
486
- # @param media_type [String]
487
- # @param sample [String]
488
- # @param url [String]
489
- # @param variable_type [String]
490
- # @param alt [String, nil]
491
- # @param regex [String, nil]
492
- # @param short_url [String, nil]
493
- end
494
- end
495
- end
496
-
497
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body#whatsapp
498
- class Whatsapp < Sentdm::Internal::Type::BaseModel
499
- # @!attribute template
500
- #
501
- # @return [String]
502
- required :template, String
503
-
504
- # @!attribute type
505
- #
506
- # @return [String, nil]
507
- optional :type, String, nil?: true
508
-
509
- # @!attribute variables
510
- #
511
- # @return [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::Whatsapp::Variable>, nil]
512
- optional :variables,
513
- -> {
514
- Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateCreateParams::Definition::Body::Whatsapp::Variable]
515
- },
516
- nil?: true
517
-
518
- # @!method initialize(template:, type: nil, variables: nil)
519
- # WhatsApp-specific content that overrides multi-channel content for WhatsApp
520
- # messages
521
- #
522
- # @param template [String]
523
- # @param type [String, nil]
524
- # @param variables [Array<Sentdm::Models::TemplateCreateParams::Definition::Body::Whatsapp::Variable>, nil]
525
-
526
- class Variable < Sentdm::Internal::Type::BaseModel
527
- # @!attribute name
528
- #
529
- # @return [String]
530
- required :name, String
531
-
532
- # @!attribute props
533
- #
534
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Body::Whatsapp::Variable::Props]
535
- required :props, -> { Sentdm::TemplateCreateParams::Definition::Body::Whatsapp::Variable::Props }
536
-
537
- # @!attribute type
538
- #
539
- # @return [String]
540
- required :type, String
541
-
542
- # @!attribute id
543
- #
544
- # @return [Integer, nil]
545
- optional :id, Integer
546
-
547
- # @!method initialize(name:, props:, type:, id: nil)
548
- # @param name [String]
549
- # @param props [Sentdm::Models::TemplateCreateParams::Definition::Body::Whatsapp::Variable::Props]
550
- # @param type [String]
551
- # @param id [Integer]
552
-
553
- # @see Sentdm::Models::TemplateCreateParams::Definition::Body::Whatsapp::Variable#props
554
- class Props < Sentdm::Internal::Type::BaseModel
555
- # @!attribute media_type
556
- #
557
- # @return [String]
558
- required :media_type, String, api_name: :mediaType
559
-
560
- # @!attribute sample
561
- #
562
- # @return [String]
563
- required :sample, String
564
-
565
- # @!attribute url
566
- #
567
- # @return [String]
568
- required :url, String
569
-
570
- # @!attribute variable_type
571
- #
572
- # @return [String]
573
- required :variable_type, String, api_name: :variableType
574
-
575
- # @!attribute alt
576
- #
577
- # @return [String, nil]
578
- optional :alt, String, nil?: true
579
-
580
- # @!attribute regex
581
- #
582
- # @return [String, nil]
583
- optional :regex, String, nil?: true
584
-
585
- # @!attribute short_url
586
- #
587
- # @return [String, nil]
588
- optional :short_url, String, api_name: :shortUrl, nil?: true
589
-
590
- # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
591
- # @param media_type [String]
592
- # @param sample [String]
593
- # @param url [String]
594
- # @param variable_type [String]
595
- # @param alt [String, nil]
596
- # @param regex [String, nil]
597
- # @param short_url [String, nil]
598
- end
599
- end
600
- end
601
- end
602
-
603
- # @see Sentdm::Models::TemplateCreateParams::Definition#authentication_config
604
- class AuthenticationConfig < Sentdm::Internal::Type::BaseModel
605
- # @!attribute add_security_recommendation
606
- # Whether to add the security recommendation text: "For your security, do not
607
- # share this code."
608
- #
609
- # @return [Boolean, nil]
610
- optional :add_security_recommendation,
611
- Sentdm::Internal::Type::Boolean,
612
- api_name: :addSecurityRecommendation
613
-
614
- # @!attribute code_expiration_minutes
615
- # Code expiration time in minutes (1-90). If set, adds footer: "This code expires
616
- # in X minutes."
617
- #
618
- # @return [Integer, nil]
619
- optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
620
-
621
- # @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
622
- # Some parameter documentations has been truncated, see
623
- # {Sentdm::Models::TemplateCreateParams::Definition::AuthenticationConfig} for
624
- # more details.
625
- #
626
- # Configuration for AUTHENTICATION category templates
627
- #
628
- # @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
629
- #
630
- # @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
631
- end
632
-
633
- class Button < Sentdm::Internal::Type::BaseModel
634
- # @!attribute props
635
- # Properties specific to the button type
636
- #
637
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Button::Props]
638
- required :props, -> { Sentdm::TemplateCreateParams::Definition::Button::Props }
639
-
640
- # @!attribute type
641
- # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
642
- #
643
- # @return [String]
644
- required :type, String
645
-
646
- # @!attribute id
647
- # The unique identifier of the button (1-based index)
648
- #
649
- # @return [Integer, nil]
650
- optional :id, Integer
651
-
652
- # @!method initialize(props:, type:, id: nil)
653
- # Some parameter documentations has been truncated, see
654
- # {Sentdm::Models::TemplateCreateParams::Definition::Button} for more details.
655
- #
656
- # Interactive button in a message template
657
- #
658
- # @param props [Sentdm::Models::TemplateCreateParams::Definition::Button::Props] Properties specific to the button type
659
- #
660
- # @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
661
- #
662
- # @param id [Integer] The unique identifier of the button (1-based index)
663
-
664
- # @see Sentdm::Models::TemplateCreateParams::Definition::Button#props
665
- class Props < Sentdm::Internal::Type::BaseModel
666
- # @!attribute active_for
667
- #
668
- # @return [Integer]
669
- required :active_for, Integer, api_name: :activeFor
670
-
671
- # @!attribute country_code
672
- #
673
- # @return [String]
674
- required :country_code, String, api_name: :countryCode
675
-
676
- # @!attribute offer_code
677
- #
678
- # @return [String]
679
- required :offer_code, String, api_name: :offerCode
680
-
681
- # @!attribute phone_number
682
- #
683
- # @return [String]
684
- required :phone_number, String, api_name: :phoneNumber
685
-
686
- # @!attribute quick_reply_type
687
- #
688
- # @return [String]
689
- required :quick_reply_type, String, api_name: :quickReplyType
690
-
691
- # @!attribute text
692
- #
693
- # @return [String]
694
- required :text, String
695
-
696
- # @!attribute url
697
- #
698
- # @return [String]
699
- required :url, String
700
-
701
- # @!attribute url_type
702
- #
703
- # @return [String]
704
- required :url_type, String, api_name: :urlType
705
-
706
- # @!attribute autofill_text
707
- #
708
- # @return [String, nil]
709
- optional :autofill_text, String, api_name: :autofillText, nil?: true
710
-
711
- # @!attribute otp_type
712
- #
713
- # @return [String, nil]
714
- optional :otp_type, String, api_name: :otpType, nil?: true
715
-
716
- # @!attribute package_name
717
- #
718
- # @return [String, nil]
719
- optional :package_name, String, api_name: :packageName, nil?: true
720
-
721
- # @!attribute signature_hash
722
- #
723
- # @return [String, nil]
724
- optional :signature_hash, String, api_name: :signatureHash, nil?: true
725
-
726
- # @!method initialize(active_for:, country_code:, offer_code:, phone_number:, quick_reply_type:, text:, url:, url_type:, autofill_text: nil, otp_type: nil, package_name: nil, signature_hash: nil)
727
- # Properties specific to the button type
728
- #
729
- # @param active_for [Integer]
730
- # @param country_code [String]
731
- # @param offer_code [String]
732
- # @param phone_number [String]
733
- # @param quick_reply_type [String]
734
- # @param text [String]
735
- # @param url [String]
736
- # @param url_type [String]
737
- # @param autofill_text [String, nil]
738
- # @param otp_type [String, nil]
739
- # @param package_name [String, nil]
740
- # @param signature_hash [String, nil]
741
- end
742
- end
743
-
744
- # @see Sentdm::Models::TemplateCreateParams::Definition#footer
745
- class Footer < Sentdm::Internal::Type::BaseModel
746
- # @!attribute template
747
- # The footer template text with optional variable placeholders
748
- #
749
- # @return [String]
750
- required :template, String
751
-
752
- # @!attribute type
753
- # The type of footer (typically "text")
754
- #
755
- # @return [String, nil]
756
- optional :type, String, nil?: true
757
-
758
- # @!attribute variables
759
- # List of variables used in the footer template
760
- #
761
- # @return [Array<Sentdm::Models::TemplateCreateParams::Definition::Footer::Variable>, nil]
762
- optional :variables,
763
- -> {
764
- Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateCreateParams::Definition::Footer::Variable]
765
- },
766
- nil?: true
767
-
768
- # @!method initialize(template:, type: nil, variables: nil)
769
- # Footer section of a message template
770
- #
771
- # @param template [String] The footer template text with optional variable placeholders
772
- #
773
- # @param type [String, nil] The type of footer (typically "text")
774
- #
775
- # @param variables [Array<Sentdm::Models::TemplateCreateParams::Definition::Footer::Variable>, nil] List of variables used in the footer template
776
-
777
- class Variable < Sentdm::Internal::Type::BaseModel
778
- # @!attribute name
779
- #
780
- # @return [String]
781
- required :name, String
782
-
783
- # @!attribute props
784
- #
785
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Footer::Variable::Props]
786
- required :props, -> { Sentdm::TemplateCreateParams::Definition::Footer::Variable::Props }
787
-
788
- # @!attribute type
789
- #
790
- # @return [String]
791
- required :type, String
792
-
793
- # @!attribute id
794
- #
795
- # @return [Integer, nil]
796
- optional :id, Integer
797
-
798
- # @!method initialize(name:, props:, type:, id: nil)
799
- # @param name [String]
800
- # @param props [Sentdm::Models::TemplateCreateParams::Definition::Footer::Variable::Props]
801
- # @param type [String]
802
- # @param id [Integer]
803
-
804
- # @see Sentdm::Models::TemplateCreateParams::Definition::Footer::Variable#props
805
- class Props < Sentdm::Internal::Type::BaseModel
806
- # @!attribute media_type
807
- #
808
- # @return [String]
809
- required :media_type, String, api_name: :mediaType
810
-
811
- # @!attribute sample
812
- #
813
- # @return [String]
814
- required :sample, String
815
-
816
- # @!attribute url
817
- #
818
- # @return [String]
819
- required :url, String
820
-
821
- # @!attribute variable_type
822
- #
823
- # @return [String]
824
- required :variable_type, String, api_name: :variableType
825
-
826
- # @!attribute alt
827
- #
828
- # @return [String, nil]
829
- optional :alt, String, nil?: true
830
-
831
- # @!attribute regex
832
- #
833
- # @return [String, nil]
834
- optional :regex, String, nil?: true
835
-
836
- # @!attribute short_url
837
- #
838
- # @return [String, nil]
839
- optional :short_url, String, api_name: :shortUrl, nil?: true
840
-
841
- # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
842
- # @param media_type [String]
843
- # @param sample [String]
844
- # @param url [String]
845
- # @param variable_type [String]
846
- # @param alt [String, nil]
847
- # @param regex [String, nil]
848
- # @param short_url [String, nil]
849
- end
850
- end
851
- end
852
-
853
- # @see Sentdm::Models::TemplateCreateParams::Definition#header
854
- class Header < Sentdm::Internal::Type::BaseModel
855
- # @!attribute template
856
- # The header template text with optional variable placeholders (e.g., "Welcome to
857
- # {{0:variable}}")
858
- #
859
- # @return [String]
860
- required :template, String
861
-
862
- # @!attribute type
863
- # The type of header (e.g., "text", "image", "video", "document")
864
- #
865
- # @return [String, nil]
866
- optional :type, String, nil?: true
867
-
868
- # @!attribute variables
869
- # List of variables used in the header template
870
- #
871
- # @return [Array<Sentdm::Models::TemplateCreateParams::Definition::Header::Variable>, nil]
872
- optional :variables,
873
- -> {
874
- Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateCreateParams::Definition::Header::Variable]
875
- },
876
- nil?: true
877
-
878
- # @!method initialize(template:, type: nil, variables: nil)
879
- # Some parameter documentations has been truncated, see
880
- # {Sentdm::Models::TemplateCreateParams::Definition::Header} for more details.
881
- #
882
- # Header section of a message template
883
- #
884
- # @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
885
- #
886
- # @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
887
- #
888
- # @param variables [Array<Sentdm::Models::TemplateCreateParams::Definition::Header::Variable>, nil] List of variables used in the header template
889
-
890
- class Variable < Sentdm::Internal::Type::BaseModel
891
- # @!attribute name
892
- #
893
- # @return [String]
894
- required :name, String
895
-
896
- # @!attribute props
897
- #
898
- # @return [Sentdm::Models::TemplateCreateParams::Definition::Header::Variable::Props]
899
- required :props, -> { Sentdm::TemplateCreateParams::Definition::Header::Variable::Props }
900
-
901
- # @!attribute type
902
- #
903
- # @return [String]
904
- required :type, String
905
-
906
- # @!attribute id
907
- #
908
- # @return [Integer, nil]
909
- optional :id, Integer
910
-
911
- # @!method initialize(name:, props:, type:, id: nil)
912
- # @param name [String]
913
- # @param props [Sentdm::Models::TemplateCreateParams::Definition::Header::Variable::Props]
914
- # @param type [String]
915
- # @param id [Integer]
916
-
917
- # @see Sentdm::Models::TemplateCreateParams::Definition::Header::Variable#props
918
- class Props < Sentdm::Internal::Type::BaseModel
919
- # @!attribute media_type
920
- #
921
- # @return [String]
922
- required :media_type, String, api_name: :mediaType
923
-
924
- # @!attribute sample
925
- #
926
- # @return [String]
927
- required :sample, String
928
-
929
- # @!attribute url
930
- #
931
- # @return [String]
932
- required :url, String
933
-
934
- # @!attribute variable_type
935
- #
936
- # @return [String]
937
- required :variable_type, String, api_name: :variableType
938
-
939
- # @!attribute alt
940
- #
941
- # @return [String, nil]
942
- optional :alt, String, nil?: true
943
-
944
- # @!attribute regex
945
- #
946
- # @return [String, nil]
947
- optional :regex, String, nil?: true
948
-
949
- # @!attribute short_url
950
- #
951
- # @return [String, nil]
952
- optional :short_url, String, api_name: :shortUrl, nil?: true
953
-
954
- # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
955
- # @param media_type [String]
956
- # @param sample [String]
957
- # @param url [String]
958
- # @param variable_type [String]
959
- # @param alt [String, nil]
960
- # @param regex [String, nil]
961
- # @param short_url [String, nil]
962
- end
963
- end
964
- end
965
- end
966
80
  end
967
81
  end
968
82
  end