sentdm 0.3.1 → 0.5.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 (292) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +16 -0
  3. data/README.md +1 -27
  4. data/lib/sentdm/client.rb +5 -9
  5. data/lib/sentdm/internal/type/base_model.rb +5 -5
  6. data/lib/sentdm/models/api_meta.rb +1 -9
  7. data/lib/sentdm/models/{api_response_contact.rb → api_response_of_contact.rb} +4 -4
  8. data/lib/sentdm/models/base_dto.rb +30 -0
  9. data/lib/sentdm/models/billing_contact_info.rb +47 -0
  10. data/lib/sentdm/models/brands_brand_data.rb +274 -0
  11. data/lib/sentdm/models/contact_create_params.rb +13 -6
  12. data/lib/sentdm/models/contact_delete_params.rb +9 -2
  13. data/lib/sentdm/models/contact_list_params.rb +10 -2
  14. data/lib/sentdm/models/contact_list_response.rb +3 -3
  15. data/lib/sentdm/models/{contact.rb → contact_response.rb} +1 -1
  16. data/lib/sentdm/models/contact_retrieve_params.rb +7 -1
  17. data/lib/sentdm/models/contact_update_params.rb +13 -6
  18. data/lib/sentdm/models/me_retrieve_params.rb +7 -1
  19. data/lib/sentdm/models/me_retrieve_response.rb +152 -7
  20. data/lib/sentdm/models/message_retrieve_activities_params.rb +7 -1
  21. data/lib/sentdm/models/message_retrieve_activities_response.rb +19 -5
  22. data/lib/sentdm/models/message_retrieve_status_params.rb +7 -1
  23. data/lib/sentdm/models/message_retrieve_status_response.rb +8 -1
  24. data/lib/sentdm/models/message_send_params.rb +17 -10
  25. data/lib/sentdm/models/mutation_request_base.rb +20 -0
  26. data/lib/sentdm/models/{lookup_retrieve_phone_info_params.rb → number_lookup_params.rb} +9 -3
  27. data/lib/sentdm/models/{lookup_retrieve_phone_info_response.rb → number_lookup_response.rb} +21 -21
  28. data/lib/sentdm/models/payment_details.rb +44 -0
  29. data/lib/sentdm/models/{profile_complete_params.rb → profile_complete_setup_params.rb} +16 -9
  30. data/lib/sentdm/models/{profile_complete_response.rb → profile_complete_setup_response.rb} +1 -1
  31. data/lib/sentdm/models/profile_create_params.rb +111 -11
  32. data/lib/sentdm/models/profile_delete_params.rb +18 -18
  33. data/lib/sentdm/models/profile_detail.rb +483 -68
  34. data/lib/sentdm/models/profile_list_params.rb +7 -1
  35. data/lib/sentdm/models/profile_retrieve_params.rb +7 -1
  36. data/lib/sentdm/models/profile_update_params.rb +60 -22
  37. data/lib/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rb → profiles/api_response_of_tcr_campaign_with_use_cases.rb} +6 -6
  38. data/lib/sentdm/models/profiles/campaign_create_params.rb +57 -0
  39. data/lib/sentdm/models/{brands → profiles}/campaign_data.rb +28 -7
  40. data/lib/sentdm/models/profiles/campaign_delete_params.rb +50 -0
  41. data/lib/sentdm/models/profiles/campaign_list_params.rb +28 -0
  42. data/lib/sentdm/models/{brands → profiles}/campaign_list_response.rb +5 -5
  43. data/lib/sentdm/models/profiles/campaign_update_params.rb +64 -0
  44. data/lib/sentdm/models/{brands → profiles}/messaging_use_case_us.rb +1 -1
  45. data/lib/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rb +15 -15
  46. data/lib/sentdm/models/template_create_params.rb +17 -10
  47. data/lib/sentdm/models/template_definition.rb +255 -15
  48. data/lib/sentdm/models/template_delete_params.rb +13 -6
  49. data/lib/sentdm/models/template_list_params.rb +18 -2
  50. data/lib/sentdm/models/template_retrieve_params.rb +7 -1
  51. data/lib/sentdm/models/template_update_params.rb +17 -10
  52. data/lib/sentdm/models/template_variable.rb +7 -1
  53. data/lib/sentdm/models/user_invite_params.rb +13 -6
  54. data/lib/sentdm/models/user_list_params.rb +7 -1
  55. data/lib/sentdm/models/user_remove_params.rb +17 -17
  56. data/lib/sentdm/models/user_retrieve_params.rb +7 -1
  57. data/lib/sentdm/models/user_update_role_params.rb +15 -16
  58. data/lib/sentdm/models/webhook_create_params.rb +13 -6
  59. data/lib/sentdm/models/webhook_delete_params.rb +7 -1
  60. data/lib/sentdm/models/webhook_list_event_types_params.rb +7 -1
  61. data/lib/sentdm/models/webhook_list_events_params.rb +7 -1
  62. data/lib/sentdm/models/webhook_list_params.rb +7 -1
  63. data/lib/sentdm/models/webhook_retrieve_params.rb +7 -1
  64. data/lib/sentdm/models/webhook_rotate_secret_params.rb +8 -2
  65. data/lib/sentdm/models/webhook_test_params.rb +13 -6
  66. data/lib/sentdm/models/webhook_toggle_status_params.rb +13 -6
  67. data/lib/sentdm/models/webhook_update_params.rb +13 -6
  68. data/lib/sentdm/models.rb +14 -38
  69. data/lib/sentdm/resources/contacts.rb +49 -26
  70. data/lib/sentdm/resources/me.rb +24 -5
  71. data/lib/sentdm/resources/messages.rb +24 -8
  72. data/lib/sentdm/resources/numbers.rb +44 -0
  73. data/lib/sentdm/resources/profiles/campaigns.rb +160 -0
  74. data/lib/sentdm/resources/profiles.rb +125 -36
  75. data/lib/sentdm/resources/templates.rb +47 -24
  76. data/lib/sentdm/resources/users.rb +40 -23
  77. data/lib/sentdm/resources/webhooks.rb +92 -34
  78. data/lib/sentdm/version.rb +1 -1
  79. data/lib/sentdm.rb +22 -35
  80. data/rbi/sentdm/client.rbi +4 -7
  81. data/rbi/sentdm/models/api_meta.rbi +4 -18
  82. data/rbi/sentdm/models/{api_response_brand_with_kyc.rbi → api_response_of_contact.rbi} +6 -6
  83. data/rbi/sentdm/models/base_dto.rbi +49 -0
  84. data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
  85. data/rbi/sentdm/models/brands_brand_data.rbi +406 -0
  86. data/rbi/sentdm/models/contact_create_params.rbi +19 -10
  87. data/rbi/sentdm/models/contact_delete_params.rbi +10 -1
  88. data/rbi/sentdm/models/contact_list_params.rbi +11 -0
  89. data/rbi/sentdm/models/contact_list_response.rbi +4 -4
  90. data/rbi/sentdm/models/{contact.rbi → contact_response.rbi} +4 -2
  91. data/rbi/sentdm/models/contact_retrieve_params.rbi +13 -2
  92. data/rbi/sentdm/models/contact_update_params.rbi +19 -10
  93. data/rbi/sentdm/models/me_retrieve_params.rbi +16 -5
  94. data/rbi/sentdm/models/me_retrieve_response.rbi +316 -16
  95. data/rbi/sentdm/models/message_retrieve_activities_params.rbi +13 -2
  96. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +18 -6
  97. data/rbi/sentdm/models/message_retrieve_status_params.rbi +13 -2
  98. data/rbi/sentdm/models/message_retrieve_status_response.rbi +6 -0
  99. data/rbi/sentdm/models/message_send_params.rbi +22 -13
  100. data/rbi/sentdm/models/mutation_request_base.rbi +32 -0
  101. data/rbi/sentdm/models/{lookup_retrieve_phone_info_params.rbi → number_lookup_params.rbi} +15 -7
  102. data/rbi/sentdm/models/{lookup_retrieve_phone_info_response.rbi → number_lookup_response.rbi} +16 -33
  103. data/rbi/sentdm/models/payment_details.rbi +59 -0
  104. data/rbi/sentdm/models/{profile_complete_params.rbi → profile_complete_setup_params.rbi} +21 -12
  105. data/rbi/sentdm/models/{profile_complete_response.rbi → profile_complete_setup_response.rbi} +1 -1
  106. data/rbi/sentdm/models/profile_create_params.rbi +189 -15
  107. data/rbi/sentdm/models/profile_delete_params.rbi +36 -24
  108. data/rbi/sentdm/models/profile_detail.rbi +725 -111
  109. data/rbi/sentdm/models/profile_list_params.rbi +16 -5
  110. data/rbi/sentdm/models/profile_retrieve_params.rbi +13 -2
  111. data/rbi/sentdm/models/profile_update_params.rbi +97 -30
  112. data/rbi/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rbi → profiles/api_response_of_tcr_campaign_with_use_cases.rbi} +7 -7
  113. data/rbi/sentdm/models/{brands → profiles}/campaign_create_params.rbi +29 -20
  114. data/rbi/sentdm/models/{brands → profiles}/campaign_data.rbi +51 -16
  115. data/rbi/sentdm/models/{brands → profiles}/campaign_delete_params.rbi +23 -12
  116. data/rbi/sentdm/models/profiles/campaign_list_params.rbi +51 -0
  117. data/rbi/sentdm/models/{brands → profiles}/campaign_list_response.rbi +7 -5
  118. data/rbi/sentdm/models/{brands → profiles}/campaign_update_params.rbi +29 -20
  119. data/rbi/sentdm/models/{brands → profiles}/messaging_use_case_us.rbi +20 -16
  120. data/rbi/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rbi +35 -29
  121. data/rbi/sentdm/models/template_create_params.rbi +22 -13
  122. data/rbi/sentdm/models/template_definition.rbi +405 -74
  123. data/rbi/sentdm/models/template_delete_params.rbi +19 -10
  124. data/rbi/sentdm/models/template_list_params.rbi +19 -0
  125. data/rbi/sentdm/models/template_retrieve_params.rbi +13 -2
  126. data/rbi/sentdm/models/template_update_params.rbi +22 -13
  127. data/rbi/sentdm/models/template_variable.rbi +6 -0
  128. data/rbi/sentdm/models/user_invite_params.rbi +19 -10
  129. data/rbi/sentdm/models/user_list_params.rbi +16 -5
  130. data/rbi/sentdm/models/user_remove_params.rbi +35 -23
  131. data/rbi/sentdm/models/user_retrieve_params.rbi +13 -2
  132. data/rbi/sentdm/models/user_update_role_params.rbi +23 -25
  133. data/rbi/sentdm/models/webhook_create_params.rbi +19 -10
  134. data/rbi/sentdm/models/webhook_delete_params.rbi +13 -2
  135. data/rbi/sentdm/models/webhook_list_event_types_params.rbi +16 -5
  136. data/rbi/sentdm/models/webhook_list_events_params.rbi +16 -1
  137. data/rbi/sentdm/models/webhook_list_params.rbi +9 -0
  138. data/rbi/sentdm/models/webhook_retrieve_params.rbi +13 -2
  139. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +16 -2
  140. data/rbi/sentdm/models/webhook_test_params.rbi +19 -10
  141. data/rbi/sentdm/models/webhook_toggle_status_params.rbi +19 -10
  142. data/rbi/sentdm/models/webhook_update_params.rbi +19 -10
  143. data/rbi/sentdm/models.rbi +14 -38
  144. data/rbi/sentdm/resources/contacts.rbi +40 -15
  145. data/rbi/sentdm/resources/me.rbi +25 -7
  146. data/rbi/sentdm/resources/messages.rbi +17 -4
  147. data/rbi/sentdm/resources/numbers.rbi +32 -0
  148. data/rbi/sentdm/resources/profiles/campaigns.rbi +127 -0
  149. data/rbi/sentdm/resources/profiles.rbi +179 -39
  150. data/rbi/sentdm/resources/templates.rbi +47 -19
  151. data/rbi/sentdm/resources/users.rbi +47 -25
  152. data/rbi/sentdm/resources/webhooks.rbi +92 -20
  153. data/sig/sentdm/client.rbs +2 -4
  154. data/sig/sentdm/models/api_meta.rbs +2 -16
  155. data/sig/sentdm/models/{api_response_contact.rbs → api_response_of_contact.rbs} +6 -6
  156. data/sig/sentdm/models/base_dto.rbs +25 -0
  157. data/sig/sentdm/models/billing_contact_info.rbs +30 -0
  158. data/sig/sentdm/models/brands_brand_data.rbs +210 -0
  159. data/sig/sentdm/models/contact_create_params.rbs +16 -5
  160. data/sig/sentdm/models/contact_delete_params.rbs +12 -2
  161. data/sig/sentdm/models/contact_list_params.rbs +8 -1
  162. data/sig/sentdm/models/contact_list_response.rbs +7 -5
  163. data/sig/sentdm/models/{contact.rbs → contact_response.rbs} +2 -2
  164. data/sig/sentdm/models/contact_retrieve_params.rbs +12 -2
  165. data/sig/sentdm/models/contact_update_params.rbs +13 -6
  166. data/sig/sentdm/models/me_retrieve_params.rbs +14 -3
  167. data/sig/sentdm/models/me_retrieve_response.rbs +134 -7
  168. data/sig/sentdm/models/message_retrieve_activities_params.rbs +12 -2
  169. data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -4
  170. data/sig/sentdm/models/message_retrieve_status_params.rbs +12 -2
  171. data/sig/sentdm/models/message_retrieve_status_response.rbs +5 -0
  172. data/sig/sentdm/models/message_send_params.rbs +15 -8
  173. data/sig/sentdm/models/mutation_request_base.rbs +15 -0
  174. data/sig/sentdm/models/{lookup_retrieve_phone_info_params.rbs → number_lookup_params.rbs} +10 -3
  175. data/sig/sentdm/models/{lookup_retrieve_phone_info_response.rbs → number_lookup_response.rbs} +14 -16
  176. data/sig/sentdm/models/payment_details.rbs +30 -0
  177. data/sig/sentdm/models/{profile_complete_params.rbs → profile_complete_setup_params.rbs} +15 -8
  178. data/sig/sentdm/models/profile_complete_setup_response.rbs +5 -0
  179. data/sig/sentdm/models/profile_create_params.rbs +57 -7
  180. data/sig/sentdm/models/profile_delete_params.rbs +23 -13
  181. data/sig/sentdm/models/profile_detail.rbs +374 -68
  182. data/sig/sentdm/models/profile_list_params.rbs +14 -3
  183. data/sig/sentdm/models/profile_retrieve_params.rbs +8 -1
  184. data/sig/sentdm/models/profile_update_params.rbs +32 -17
  185. data/sig/sentdm/models/{brands/api_response_tcr_campaign_with_use_cases.rbs → profiles/api_response_of_tcr_campaign_with_use_cases.rbs} +7 -7
  186. data/sig/sentdm/models/profiles/campaign_create_params.rbs +54 -0
  187. data/sig/sentdm/models/{brands → profiles}/campaign_data.rbs +27 -5
  188. data/sig/sentdm/models/{brands → profiles}/campaign_delete_params.rbs +17 -10
  189. data/sig/sentdm/models/{brands → profiles}/campaign_list_params.rbs +12 -5
  190. data/sig/sentdm/models/{brands → profiles}/campaign_list_response.rbs +5 -5
  191. data/sig/sentdm/models/{brands → profiles}/campaign_update_params.rbs +22 -15
  192. data/sig/sentdm/models/{brands → profiles}/messaging_use_case_us.rbs +2 -2
  193. data/sig/sentdm/models/{brands → profiles}/tcr_campaign_with_use_cases.rbs +29 -29
  194. data/sig/sentdm/models/template_create_params.rbs +15 -8
  195. data/sig/sentdm/models/template_definition.rbs +233 -20
  196. data/sig/sentdm/models/template_delete_params.rbs +16 -5
  197. data/sig/sentdm/models/template_list_params.rbs +13 -1
  198. data/sig/sentdm/models/template_retrieve_params.rbs +12 -2
  199. data/sig/sentdm/models/template_update_params.rbs +15 -8
  200. data/sig/sentdm/models/template_variable.rbs +5 -0
  201. data/sig/sentdm/models/user_invite_params.rbs +13 -6
  202. data/sig/sentdm/models/user_list_params.rbs +14 -3
  203. data/sig/sentdm/models/user_remove_params.rbs +23 -13
  204. data/sig/sentdm/models/user_retrieve_params.rbs +8 -1
  205. data/sig/sentdm/models/user_update_role_params.rbs +17 -17
  206. data/sig/sentdm/models/webhook_create_params.rbs +13 -6
  207. data/sig/sentdm/models/webhook_delete_params.rbs +12 -2
  208. data/sig/sentdm/models/webhook_list_event_types_params.rbs +13 -3
  209. data/sig/sentdm/models/webhook_list_events_params.rbs +13 -1
  210. data/sig/sentdm/models/webhook_list_params.rbs +13 -1
  211. data/sig/sentdm/models/webhook_retrieve_params.rbs +12 -2
  212. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +9 -2
  213. data/sig/sentdm/models/webhook_test_params.rbs +13 -6
  214. data/sig/sentdm/models/webhook_toggle_status_params.rbs +17 -5
  215. data/sig/sentdm/models/webhook_update_params.rbs +13 -6
  216. data/sig/sentdm/models.rbs +14 -32
  217. data/sig/sentdm/resources/contacts.rbs +10 -5
  218. data/sig/sentdm/resources/me.rbs +1 -0
  219. data/sig/sentdm/resources/messages.rbs +4 -1
  220. data/sig/sentdm/resources/{lookup.rbs → numbers.rbs} +4 -3
  221. data/sig/sentdm/resources/profiles/campaigns.rbs +42 -0
  222. data/sig/sentdm/resources/profiles.rbs +22 -9
  223. data/sig/sentdm/resources/templates.rbs +9 -3
  224. data/sig/sentdm/resources/users.rbs +10 -7
  225. data/sig/sentdm/resources/webhooks.rbs +18 -5
  226. metadata +67 -106
  227. data/lib/sentdm/models/api_response_brand_with_kyc.rb +0 -43
  228. data/lib/sentdm/models/brand_create_params.rb +0 -41
  229. data/lib/sentdm/models/brand_data.rb +0 -237
  230. data/lib/sentdm/models/brand_delete_params.rb +0 -34
  231. data/lib/sentdm/models/brand_list_params.rb +0 -14
  232. data/lib/sentdm/models/brand_list_response.rb +0 -43
  233. data/lib/sentdm/models/brand_update_params.rb +0 -48
  234. data/lib/sentdm/models/brand_with_kyc.rb +0 -335
  235. data/lib/sentdm/models/brands/base_dto.rb +0 -32
  236. data/lib/sentdm/models/brands/campaign_create_params.rb +0 -50
  237. data/lib/sentdm/models/brands/campaign_delete_params.rb +0 -43
  238. data/lib/sentdm/models/brands/campaign_list_params.rb +0 -22
  239. data/lib/sentdm/models/brands/campaign_update_params.rb +0 -57
  240. data/lib/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +0 -30
  241. data/lib/sentdm/models/mutation_request.rb +0 -20
  242. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +0 -34
  243. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +0 -40
  244. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +0 -38
  245. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +0 -81
  246. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +0 -34
  247. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +0 -39
  248. data/lib/sentdm/resources/brands/campaigns.rb +0 -145
  249. data/lib/sentdm/resources/brands.rb +0 -130
  250. data/lib/sentdm/resources/lookup.rb +0 -35
  251. data/rbi/sentdm/models/api_response_contact.rbi +0 -74
  252. data/rbi/sentdm/models/brand_create_params.rbi +0 -68
  253. data/rbi/sentdm/models/brand_data.rbi +0 -266
  254. data/rbi/sentdm/models/brand_delete_params.rbi +0 -68
  255. data/rbi/sentdm/models/brand_list_params.rbi +0 -27
  256. data/rbi/sentdm/models/brand_list_response.rbi +0 -71
  257. data/rbi/sentdm/models/brand_update_params.rbi +0 -74
  258. data/rbi/sentdm/models/brand_with_kyc.rbi +0 -398
  259. data/rbi/sentdm/models/brands/base_dto.rbi +0 -53
  260. data/rbi/sentdm/models/brands/campaign_list_params.rbi +0 -37
  261. data/rbi/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +0 -52
  262. data/rbi/sentdm/models/mutation_request.rbi +0 -32
  263. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +0 -56
  264. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +0 -76
  265. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +0 -79
  266. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +0 -104
  267. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +0 -60
  268. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +0 -62
  269. data/rbi/sentdm/resources/brands/campaigns.rbi +0 -109
  270. data/rbi/sentdm/resources/brands.rbi +0 -95
  271. data/rbi/sentdm/resources/lookup.rbi +0 -24
  272. data/sig/sentdm/models/api_response_brand_with_kyc.rbs +0 -39
  273. data/sig/sentdm/models/brand_create_params.rbs +0 -36
  274. data/sig/sentdm/models/brand_data.rbs +0 -164
  275. data/sig/sentdm/models/brand_delete_params.rbs +0 -36
  276. data/sig/sentdm/models/brand_list_params.rbs +0 -14
  277. data/sig/sentdm/models/brand_list_response.rbs +0 -39
  278. data/sig/sentdm/models/brand_update_params.rbs +0 -45
  279. data/sig/sentdm/models/brand_with_kyc.rbs +0 -237
  280. data/sig/sentdm/models/brands/base_dto.rbs +0 -27
  281. data/sig/sentdm/models/brands/campaign_create_params.rbs +0 -47
  282. data/sig/sentdm/models/brands/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +0 -27
  283. data/sig/sentdm/models/mutation_request.rbs +0 -15
  284. data/sig/sentdm/models/profile_complete_response.rbs +0 -5
  285. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +0 -24
  286. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +0 -30
  287. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +0 -38
  288. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +0 -75
  289. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +0 -32
  290. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +0 -32
  291. data/sig/sentdm/resources/brands/campaigns.rbs +0 -38
  292. data/sig/sentdm/resources/brands.rbs +0 -34
@@ -1,79 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Sentdm::SentDmServicesCommonContractsPocOsTemplateButton,
10
- Sentdm::Internal::AnyHash
11
- )
12
- end
13
-
14
- # The unique identifier of the button (1-based index)
15
- sig { returns(T.nilable(Integer)) }
16
- attr_reader :id
17
-
18
- sig { params(id: Integer).void }
19
- attr_writer :id
20
-
21
- # Properties specific to the button type
22
- sig do
23
- returns(
24
- T.nilable(
25
- Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps
26
- )
27
- )
28
- end
29
- attr_reader :props
30
-
31
- sig do
32
- params(
33
- props:
34
- Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash
35
- ).void
36
- end
37
- attr_writer :props
38
-
39
- # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
40
- sig { returns(T.nilable(String)) }
41
- attr_reader :type
42
-
43
- sig { params(type: String).void }
44
- attr_writer :type
45
-
46
- # Interactive button in a message template
47
- sig do
48
- params(
49
- id: Integer,
50
- props:
51
- Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps::OrHash,
52
- type: String
53
- ).returns(T.attached_class)
54
- end
55
- def self.new(
56
- # The unique identifier of the button (1-based index)
57
- id: nil,
58
- # Properties specific to the button type
59
- props: nil,
60
- # The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
61
- type: nil
62
- )
63
- end
64
-
65
- sig do
66
- override.returns(
67
- {
68
- id: Integer,
69
- props:
70
- Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
71
- type: String
72
- }
73
- )
74
- end
75
- def to_hash
76
- end
77
- end
78
- end
79
- end
@@ -1,104 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps,
10
- Sentdm::Internal::AnyHash
11
- )
12
- end
13
-
14
- sig { returns(T.nilable(Integer)) }
15
- attr_accessor :active_for
16
-
17
- sig { returns(T.nilable(String)) }
18
- attr_accessor :autofill_text
19
-
20
- sig { returns(T.nilable(String)) }
21
- attr_accessor :country_code
22
-
23
- sig { returns(T.nilable(String)) }
24
- attr_accessor :offer_code
25
-
26
- sig { returns(T.nilable(String)) }
27
- attr_accessor :otp_type
28
-
29
- sig { returns(T.nilable(String)) }
30
- attr_accessor :package_name
31
-
32
- sig { returns(T.nilable(String)) }
33
- attr_accessor :phone_number
34
-
35
- sig { returns(T.nilable(String)) }
36
- attr_accessor :quick_reply_type
37
-
38
- sig { returns(T.nilable(String)) }
39
- attr_accessor :signature_hash
40
-
41
- sig { returns(T.nilable(String)) }
42
- attr_accessor :text
43
-
44
- sig { returns(T.nilable(String)) }
45
- attr_accessor :url
46
-
47
- sig { returns(T.nilable(String)) }
48
- attr_accessor :url_type
49
-
50
- sig do
51
- params(
52
- active_for: T.nilable(Integer),
53
- autofill_text: T.nilable(String),
54
- country_code: T.nilable(String),
55
- offer_code: T.nilable(String),
56
- otp_type: T.nilable(String),
57
- package_name: T.nilable(String),
58
- phone_number: T.nilable(String),
59
- quick_reply_type: T.nilable(String),
60
- signature_hash: T.nilable(String),
61
- text: T.nilable(String),
62
- url: T.nilable(String),
63
- url_type: T.nilable(String)
64
- ).returns(T.attached_class)
65
- end
66
- def self.new(
67
- active_for: nil,
68
- autofill_text: nil,
69
- country_code: nil,
70
- offer_code: nil,
71
- otp_type: nil,
72
- package_name: nil,
73
- phone_number: nil,
74
- quick_reply_type: nil,
75
- signature_hash: nil,
76
- text: nil,
77
- url: nil,
78
- url_type: nil
79
- )
80
- end
81
-
82
- sig do
83
- override.returns(
84
- {
85
- active_for: T.nilable(Integer),
86
- autofill_text: T.nilable(String),
87
- country_code: T.nilable(String),
88
- offer_code: T.nilable(String),
89
- otp_type: T.nilable(String),
90
- package_name: T.nilable(String),
91
- phone_number: T.nilable(String),
92
- quick_reply_type: T.nilable(String),
93
- signature_hash: T.nilable(String),
94
- text: T.nilable(String),
95
- url: T.nilable(String),
96
- url_type: T.nilable(String)
97
- }
98
- )
99
- end
100
- def to_hash
101
- end
102
- end
103
- end
104
- end
@@ -1,60 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter,
10
- Sentdm::Internal::AnyHash
11
- )
12
- end
13
-
14
- # The footer template text with optional variable placeholders
15
- sig { returns(T.nilable(String)) }
16
- attr_reader :template
17
-
18
- sig { params(template: String).void }
19
- attr_writer :template
20
-
21
- # The type of footer (typically "text")
22
- sig { returns(T.nilable(String)) }
23
- attr_accessor :type
24
-
25
- # List of variables used in the footer template
26
- sig { returns(T.nilable(T::Array[Sentdm::TemplateVariable])) }
27
- attr_accessor :variables
28
-
29
- # Footer section of a message template
30
- sig do
31
- params(
32
- template: String,
33
- type: T.nilable(String),
34
- variables: T.nilable(T::Array[Sentdm::TemplateVariable::OrHash])
35
- ).returns(T.attached_class)
36
- end
37
- def self.new(
38
- # The footer template text with optional variable placeholders
39
- template: nil,
40
- # The type of footer (typically "text")
41
- type: nil,
42
- # List of variables used in the footer template
43
- variables: nil
44
- )
45
- end
46
-
47
- sig do
48
- override.returns(
49
- {
50
- template: String,
51
- type: T.nilable(String),
52
- variables: T.nilable(T::Array[Sentdm::TemplateVariable])
53
- }
54
- )
55
- end
56
- def to_hash
57
- end
58
- end
59
- end
60
- end
@@ -1,62 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class SentDmServicesCommonContractsPocOsTemplateHeader < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader,
10
- Sentdm::Internal::AnyHash
11
- )
12
- end
13
-
14
- # The header template text with optional variable placeholders (e.g., "Welcome to
15
- # {{0:variable}}")
16
- sig { returns(T.nilable(String)) }
17
- attr_reader :template
18
-
19
- sig { params(template: String).void }
20
- attr_writer :template
21
-
22
- # The type of header (e.g., "text", "image", "video", "document")
23
- sig { returns(T.nilable(String)) }
24
- attr_accessor :type
25
-
26
- # List of variables used in the header template
27
- sig { returns(T.nilable(T::Array[Sentdm::TemplateVariable])) }
28
- attr_accessor :variables
29
-
30
- # Header section of a message template
31
- sig do
32
- params(
33
- template: String,
34
- type: T.nilable(String),
35
- variables: T.nilable(T::Array[Sentdm::TemplateVariable::OrHash])
36
- ).returns(T.attached_class)
37
- end
38
- def self.new(
39
- # The header template text with optional variable placeholders (e.g., "Welcome to
40
- # {{0:variable}}")
41
- template: nil,
42
- # The type of header (e.g., "text", "image", "video", "document")
43
- type: nil,
44
- # List of variables used in the header template
45
- variables: nil
46
- )
47
- end
48
-
49
- sig do
50
- override.returns(
51
- {
52
- template: String,
53
- type: T.nilable(String),
54
- variables: T.nilable(T::Array[Sentdm::TemplateVariable])
55
- }
56
- )
57
- end
58
- def to_hash
59
- end
60
- end
61
- end
62
- end
@@ -1,109 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Resources
5
- class Brands
6
- # Register and manage 10DLC brands for SMS compliance
7
- class Campaigns
8
- # Creates a new campaign scoped under a specific brand. The campaign is linked to
9
- # the specified brand. Each campaign must include at least one use case with
10
- # sample messages.
11
- sig do
12
- params(
13
- brand_id: String,
14
- campaign: Sentdm::Brands::CampaignData::OrHash,
15
- test_mode: T::Boolean,
16
- idempotency_key: String,
17
- request_options: Sentdm::RequestOptions::OrHash
18
- ).returns(Sentdm::Brands::APIResponseTcrCampaignWithUseCases)
19
- end
20
- def create(
21
- # Path param: Brand ID from route
22
- brand_id,
23
- # Body param: Campaign data
24
- campaign:,
25
- # Body param: Test mode flag - when true, the operation is simulated without side
26
- # effects Useful for testing integrations without actual execution
27
- test_mode: nil,
28
- # Header param: Unique key to ensure idempotent request processing. Must be 1-255
29
- # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
30
- # hours per key per customer.
31
- idempotency_key: nil,
32
- request_options: {}
33
- )
34
- end
35
-
36
- # Updates an existing campaign scoped under a specific brand. Cannot update
37
- # campaigns that have already been submitted to TCR.
38
- sig do
39
- params(
40
- campaign_id: String,
41
- brand_id: String,
42
- campaign: Sentdm::Brands::CampaignData::OrHash,
43
- test_mode: T::Boolean,
44
- idempotency_key: String,
45
- request_options: Sentdm::RequestOptions::OrHash
46
- ).returns(Sentdm::Brands::APIResponseTcrCampaignWithUseCases)
47
- end
48
- def update(
49
- # Path param: Campaign ID from route
50
- campaign_id,
51
- # Path param: Brand ID from route
52
- brand_id:,
53
- # Body param: Campaign data
54
- campaign:,
55
- # Body param: Test mode flag - when true, the operation is simulated without side
56
- # effects Useful for testing integrations without actual execution
57
- test_mode: nil,
58
- # Header param: Unique key to ensure idempotent request processing. Must be 1-255
59
- # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
60
- # hours per key per customer.
61
- idempotency_key: nil,
62
- request_options: {}
63
- )
64
- end
65
-
66
- # Retrieves all campaigns linked to a specific brand, including their use cases
67
- # and sample messages.
68
- sig do
69
- params(
70
- brand_id: String,
71
- request_options: Sentdm::RequestOptions::OrHash
72
- ).returns(Sentdm::Models::Brands::CampaignListResponse)
73
- end
74
- def list(
75
- # Brand ID from route
76
- brand_id,
77
- request_options: {}
78
- )
79
- end
80
-
81
- # Deletes a campaign by ID within a specific brand. The brand must belong to the
82
- # authenticated customer.
83
- sig do
84
- params(
85
- campaign_id: String,
86
- brand_id: String,
87
- body: Sentdm::Brands::CampaignDeleteParams::Body::OrHash,
88
- request_options: Sentdm::RequestOptions::OrHash
89
- ).void
90
- end
91
- def delete(
92
- # Path param: Campaign ID from route parameter
93
- campaign_id,
94
- # Path param: Brand ID from route parameter
95
- brand_id:,
96
- # Body param: Request to delete a campaign from a brand
97
- body:,
98
- request_options: {}
99
- )
100
- end
101
-
102
- # @api private
103
- sig { params(client: Sentdm::Client).returns(T.attached_class) }
104
- def self.new(client:)
105
- end
106
- end
107
- end
108
- end
109
- end
@@ -1,95 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Resources
5
- # Register and manage 10DLC brands for SMS compliance
6
- class Brands
7
- # Register and manage 10DLC brands for SMS compliance
8
- sig { returns(Sentdm::Resources::Brands::Campaigns) }
9
- attr_reader :campaigns
10
-
11
- # Creates a new brand and associated information. This endpoint automatically sets
12
- # inheritTcrBrand=false when a brand is created.
13
- sig do
14
- params(
15
- brand: Sentdm::BrandData::OrHash,
16
- test_mode: T::Boolean,
17
- idempotency_key: String,
18
- request_options: Sentdm::RequestOptions::OrHash
19
- ).returns(Sentdm::APIResponseBrandWithKYC)
20
- end
21
- def create(
22
- # Body param: Brand and KYC information
23
- brand:,
24
- # Body param: Test mode flag - when true, the operation is simulated without side
25
- # effects Useful for testing integrations without actual execution
26
- test_mode: nil,
27
- # Header param: Unique key to ensure idempotent request processing. Must be 1-255
28
- # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
29
- # hours per key per customer.
30
- idempotency_key: nil,
31
- request_options: {}
32
- )
33
- end
34
-
35
- # Updates an existing brand and its associated information. Cannot update brands
36
- # that have already been submitted to TCR or inherited brands.
37
- sig do
38
- params(
39
- brand_id: String,
40
- brand: Sentdm::BrandData::OrHash,
41
- test_mode: T::Boolean,
42
- idempotency_key: String,
43
- request_options: Sentdm::RequestOptions::OrHash
44
- ).returns(Sentdm::APIResponseBrandWithKYC)
45
- end
46
- def update(
47
- # Path param: Brand ID from route
48
- brand_id,
49
- # Body param: Brand and KYC information
50
- brand:,
51
- # Body param: Test mode flag - when true, the operation is simulated without side
52
- # effects Useful for testing integrations without actual execution
53
- test_mode: nil,
54
- # Header param: Unique key to ensure idempotent request processing. Must be 1-255
55
- # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
56
- # hours per key per customer.
57
- idempotency_key: nil,
58
- request_options: {}
59
- )
60
- end
61
-
62
- # Retrieves all brands for the authenticated customer with information in a
63
- # flattened structure. Includes inherited brands if inheritTcrBrand=true.
64
- sig do
65
- params(request_options: Sentdm::RequestOptions::OrHash).returns(
66
- Sentdm::Models::BrandListResponse
67
- )
68
- end
69
- def list(request_options: {})
70
- end
71
-
72
- # Delete a brand by ID. The brand must belong to the authenticated customer.
73
- sig do
74
- params(
75
- brand_id: String,
76
- body: Sentdm::BrandDeleteParams::Body::OrHash,
77
- request_options: Sentdm::RequestOptions::OrHash
78
- ).void
79
- end
80
- def delete(
81
- # Brand ID from route parameter
82
- brand_id,
83
- # Request to delete a brand
84
- body:,
85
- request_options: {}
86
- )
87
- end
88
-
89
- # @api private
90
- sig { params(client: Sentdm::Client).returns(T.attached_class) }
91
- def self.new(client:)
92
- end
93
- end
94
- end
95
- end
@@ -1,24 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Resources
5
- class Lookup
6
- # Validates a phone number and retrieves formatting, country, and timezone
7
- # information from the internal index. Provider-agnostic and works for all
8
- # customers.
9
- sig do
10
- params(
11
- phone_number: String,
12
- request_options: Sentdm::RequestOptions::OrHash
13
- ).returns(Sentdm::Models::LookupRetrievePhoneInfoResponse)
14
- end
15
- def retrieve_phone_info(phone_number, request_options: {})
16
- end
17
-
18
- # @api private
19
- sig { params(client: Sentdm::Client).returns(T.attached_class) }
20
- def self.new(client:)
21
- end
22
- end
23
- end
24
- end
@@ -1,39 +0,0 @@
1
- module Sentdm
2
- module Models
3
- type api_response_brand_with_kyc =
4
- {
5
- data: Sentdm::BrandWithKYC?,
6
- error: Sentdm::APIError?,
7
- meta: Sentdm::APIMeta,
8
- success: bool
9
- }
10
-
11
- class APIResponseBrandWithKYC < Sentdm::Internal::Type::BaseModel
12
- attr_accessor data: Sentdm::BrandWithKYC?
13
-
14
- attr_accessor error: Sentdm::APIError?
15
-
16
- attr_reader meta: Sentdm::APIMeta?
17
-
18
- def meta=: (Sentdm::APIMeta) -> Sentdm::APIMeta
19
-
20
- attr_reader success: bool?
21
-
22
- def success=: (bool) -> bool
23
-
24
- def initialize: (
25
- ?data: Sentdm::BrandWithKYC?,
26
- ?error: Sentdm::APIError?,
27
- ?meta: Sentdm::APIMeta,
28
- ?success: bool
29
- ) -> void
30
-
31
- def to_hash: -> {
32
- data: Sentdm::BrandWithKYC?,
33
- error: Sentdm::APIError?,
34
- meta: Sentdm::APIMeta,
35
- success: bool
36
- }
37
- end
38
- end
39
- end
@@ -1,36 +0,0 @@
1
- module Sentdm
2
- module Models
3
- type brand_create_params =
4
- { brand: Sentdm::BrandData, test_mode: bool, idempotency_key: String }
5
- & Sentdm::Internal::Type::request_parameters
6
-
7
- class BrandCreateParams < Sentdm::Internal::Type::BaseModel
8
- extend Sentdm::Internal::Type::RequestParameters::Converter
9
- include Sentdm::Internal::Type::RequestParameters
10
-
11
- attr_accessor brand: Sentdm::BrandData
12
-
13
- attr_reader test_mode: bool?
14
-
15
- def test_mode=: (bool) -> bool
16
-
17
- attr_reader idempotency_key: String?
18
-
19
- def idempotency_key=: (String) -> String
20
-
21
- def initialize: (
22
- brand: Sentdm::BrandData,
23
- ?test_mode: bool,
24
- ?idempotency_key: String,
25
- ?request_options: Sentdm::request_opts
26
- ) -> void
27
-
28
- def to_hash: -> {
29
- brand: Sentdm::BrandData,
30
- test_mode: bool,
31
- idempotency_key: String,
32
- request_options: Sentdm::RequestOptions
33
- }
34
- end
35
- end
36
- end