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
@@ -17,18 +17,29 @@ module Sentdm
17
17
  sig { returns(String) }
18
18
  attr_accessor :id
19
19
 
20
+ sig { returns(T.nilable(String)) }
21
+ attr_reader :x_profile_id
22
+
23
+ sig { params(x_profile_id: String).void }
24
+ attr_writer :x_profile_id
25
+
20
26
  sig do
21
27
  params(
22
28
  id: String,
29
+ x_profile_id: String,
23
30
  request_options: Sentdm::RequestOptions::OrHash
24
31
  ).returns(T.attached_class)
25
32
  end
26
- def self.new(id:, request_options: {})
33
+ def self.new(id:, x_profile_id: nil, request_options: {})
27
34
  end
28
35
 
29
36
  sig do
30
37
  override.returns(
31
- { id: String, request_options: Sentdm::RequestOptions }
38
+ {
39
+ id: String,
40
+ x_profile_id: String,
41
+ request_options: Sentdm::RequestOptions
42
+ }
32
43
  )
33
44
  end
34
45
  def to_hash
@@ -169,9 +169,10 @@ module Sentdm
169
169
  )
170
170
  end
171
171
 
172
- # Additional content or payload for the activity (e.g., channel response)
172
+ # Active contact markup applied on top of the channel cost, formatted to 4 decimal
173
+ # places.
173
174
  sig { returns(T.nilable(String)) }
174
- attr_accessor :content
175
+ attr_accessor :active_contact_price
175
176
 
176
177
  # Human-readable description of the activity
177
178
  sig { returns(T.nilable(String)) }
@@ -180,6 +181,11 @@ module Sentdm
180
181
  sig { params(description: String).void }
181
182
  attr_writer :description
182
183
 
184
+ # Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
185
+ # 4 decimal places.
186
+ sig { returns(T.nilable(String)) }
187
+ attr_accessor :price
188
+
183
189
  # Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
184
190
  sig { returns(T.nilable(String)) }
185
191
  attr_reader :status
@@ -197,17 +203,22 @@ module Sentdm
197
203
  # A single message activity event for v3 API
198
204
  sig do
199
205
  params(
200
- content: T.nilable(String),
206
+ active_contact_price: T.nilable(String),
201
207
  description: String,
208
+ price: T.nilable(String),
202
209
  status: String,
203
210
  timestamp: Time
204
211
  ).returns(T.attached_class)
205
212
  end
206
213
  def self.new(
207
- # Additional content or payload for the activity (e.g., channel response)
208
- content: nil,
214
+ # Active contact markup applied on top of the channel cost, formatted to 4 decimal
215
+ # places.
216
+ active_contact_price: nil,
209
217
  # Human-readable description of the activity
210
218
  description: nil,
219
+ # Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
220
+ # 4 decimal places.
221
+ price: nil,
211
222
  # Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
212
223
  status: nil,
213
224
  # When this activity occurred
@@ -218,8 +229,9 @@ module Sentdm
218
229
  sig do
219
230
  override.returns(
220
231
  {
221
- content: T.nilable(String),
232
+ active_contact_price: T.nilable(String),
222
233
  description: String,
234
+ price: T.nilable(String),
223
235
  status: String,
224
236
  timestamp: Time
225
237
  }
@@ -14,18 +14,29 @@ module Sentdm
14
14
  sig { returns(String) }
15
15
  attr_accessor :id
16
16
 
17
+ sig { returns(T.nilable(String)) }
18
+ attr_reader :x_profile_id
19
+
20
+ sig { params(x_profile_id: String).void }
21
+ attr_writer :x_profile_id
22
+
17
23
  sig do
18
24
  params(
19
25
  id: String,
26
+ x_profile_id: String,
20
27
  request_options: Sentdm::RequestOptions::OrHash
21
28
  ).returns(T.attached_class)
22
29
  end
23
- def self.new(id:, request_options: {})
30
+ def self.new(id:, x_profile_id: nil, request_options: {})
24
31
  end
25
32
 
26
33
  sig do
27
34
  override.returns(
28
- { id: String, request_options: Sentdm::RequestOptions }
35
+ {
36
+ id: String,
37
+ x_profile_id: String,
38
+ request_options: Sentdm::RequestOptions
39
+ }
29
40
  )
30
41
  end
31
42
  def to_hash
@@ -101,6 +101,9 @@ module Sentdm
101
101
  sig { params(id: String).void }
102
102
  attr_writer :id
103
103
 
104
+ sig { returns(T.nilable(Float)) }
105
+ attr_accessor :active_contact_price
106
+
104
107
  sig { returns(T.nilable(String)) }
105
108
  attr_reader :channel
106
109
 
@@ -203,6 +206,7 @@ module Sentdm
203
206
  sig do
204
207
  params(
205
208
  id: String,
209
+ active_contact_price: T.nilable(Float),
206
210
  channel: String,
207
211
  contact_id: String,
208
212
  created_at: Time,
@@ -229,6 +233,7 @@ module Sentdm
229
233
  end
230
234
  def self.new(
231
235
  id: nil,
236
+ active_contact_price: nil,
232
237
  channel: nil,
233
238
  contact_id: nil,
234
239
  created_at: nil,
@@ -252,6 +257,7 @@ module Sentdm
252
257
  override.returns(
253
258
  {
254
259
  id: String,
260
+ active_contact_price: T.nilable(Float),
255
261
  channel: String,
256
262
  contact_id: String,
257
263
  created_at: Time,
@@ -17,6 +17,14 @@ module Sentdm
17
17
  sig { returns(T.nilable(T::Array[String])) }
18
18
  attr_accessor :channel
19
19
 
20
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
21
+ # for testing integrations without actual execution
22
+ sig { returns(T.nilable(T::Boolean)) }
23
+ attr_reader :sandbox
24
+
25
+ sig { params(sandbox: T::Boolean).void }
26
+ attr_writer :sandbox
27
+
20
28
  # Template reference (by id or name, with optional parameters)
21
29
  sig { returns(T.nilable(Sentdm::MessageSendParams::Template)) }
22
30
  attr_reader :template
@@ -24,14 +32,6 @@ module Sentdm
24
32
  sig { params(template: Sentdm::MessageSendParams::Template::OrHash).void }
25
33
  attr_writer :template
26
34
 
27
- # Test mode flag - when true, the operation is simulated without side effects
28
- # Useful for testing integrations without actual execution
29
- sig { returns(T.nilable(T::Boolean)) }
30
- attr_reader :test_mode
31
-
32
- sig { params(test_mode: T::Boolean).void }
33
- attr_writer :test_mode
34
-
35
35
  # List of recipient phone numbers in E.164 format (multi-recipient fan-out)
36
36
  sig { returns(T.nilable(T::Array[String])) }
37
37
  attr_reader :to
@@ -45,13 +45,20 @@ module Sentdm
45
45
  sig { params(idempotency_key: String).void }
46
46
  attr_writer :idempotency_key
47
47
 
48
+ sig { returns(T.nilable(String)) }
49
+ attr_reader :x_profile_id
50
+
51
+ sig { params(x_profile_id: String).void }
52
+ attr_writer :x_profile_id
53
+
48
54
  sig do
49
55
  params(
50
56
  channel: T.nilable(T::Array[String]),
57
+ sandbox: T::Boolean,
51
58
  template: Sentdm::MessageSendParams::Template::OrHash,
52
- test_mode: T::Boolean,
53
59
  to: T::Array[String],
54
60
  idempotency_key: String,
61
+ x_profile_id: String,
55
62
  request_options: Sentdm::RequestOptions::OrHash
56
63
  ).returns(T.attached_class)
57
64
  end
@@ -60,14 +67,15 @@ module Sentdm
60
67
  # separate message per recipient. "sent" = auto-detect, "rcs" = reserved
61
68
  # (skipped). Defaults to ["sent"] (auto-detect) if omitted.
62
69
  channel: nil,
70
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
71
+ # for testing integrations without actual execution
72
+ sandbox: nil,
63
73
  # Template reference (by id or name, with optional parameters)
64
74
  template: nil,
65
- # Test mode flag - when true, the operation is simulated without side effects
66
- # Useful for testing integrations without actual execution
67
- test_mode: nil,
68
75
  # List of recipient phone numbers in E.164 format (multi-recipient fan-out)
69
76
  to: nil,
70
77
  idempotency_key: nil,
78
+ x_profile_id: nil,
71
79
  request_options: {}
72
80
  )
73
81
  end
@@ -76,10 +84,11 @@ module Sentdm
76
84
  override.returns(
77
85
  {
78
86
  channel: T.nilable(T::Array[String]),
87
+ sandbox: T::Boolean,
79
88
  template: Sentdm::MessageSendParams::Template,
80
- test_mode: T::Boolean,
81
89
  to: T::Array[String],
82
90
  idempotency_key: String,
91
+ x_profile_id: String,
83
92
  request_options: Sentdm::RequestOptions
84
93
  }
85
94
  )
@@ -0,0 +1,32 @@
1
+ # typed: strong
2
+
3
+ module Sentdm
4
+ module Models
5
+ class MutationRequestBase < Sentdm::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Sentdm::MutationRequestBase, Sentdm::Internal::AnyHash)
9
+ end
10
+
11
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
12
+ # for testing integrations without actual execution
13
+ sig { returns(T.nilable(T::Boolean)) }
14
+ attr_reader :sandbox
15
+
16
+ sig { params(sandbox: T::Boolean).void }
17
+ attr_writer :sandbox
18
+
19
+ sig { params(sandbox: T::Boolean).returns(T.attached_class) }
20
+ def self.new(
21
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
22
+ # for testing integrations without actual execution
23
+ sandbox: nil
24
+ )
25
+ end
26
+
27
+ sig { override.returns({ sandbox: T::Boolean }) }
28
+ def to_hash
29
+ end
30
+ end
31
+ end
32
+ end
@@ -2,33 +2,41 @@
2
2
 
3
3
  module Sentdm
4
4
  module Models
5
- class LookupRetrievePhoneInfoParams < Sentdm::Internal::Type::BaseModel
5
+ class NumberLookupParams < Sentdm::Internal::Type::BaseModel
6
6
  extend Sentdm::Internal::Type::RequestParameters::Converter
7
7
  include Sentdm::Internal::Type::RequestParameters
8
8
 
9
9
  OrHash =
10
10
  T.type_alias do
11
- T.any(
12
- Sentdm::LookupRetrievePhoneInfoParams,
13
- Sentdm::Internal::AnyHash
14
- )
11
+ T.any(Sentdm::NumberLookupParams, Sentdm::Internal::AnyHash)
15
12
  end
16
13
 
17
14
  sig { returns(String) }
18
15
  attr_accessor :phone_number
19
16
 
17
+ sig { returns(T.nilable(String)) }
18
+ attr_reader :x_profile_id
19
+
20
+ sig { params(x_profile_id: String).void }
21
+ attr_writer :x_profile_id
22
+
20
23
  sig do
21
24
  params(
22
25
  phone_number: String,
26
+ x_profile_id: String,
23
27
  request_options: Sentdm::RequestOptions::OrHash
24
28
  ).returns(T.attached_class)
25
29
  end
26
- def self.new(phone_number:, request_options: {})
30
+ def self.new(phone_number:, x_profile_id: nil, request_options: {})
27
31
  end
28
32
 
29
33
  sig do
30
34
  override.returns(
31
- { phone_number: String, request_options: Sentdm::RequestOptions }
35
+ {
36
+ phone_number: String,
37
+ x_profile_id: String,
38
+ request_options: Sentdm::RequestOptions
39
+ }
32
40
  )
33
41
  end
34
42
  def to_hash
@@ -2,29 +2,19 @@
2
2
 
3
3
  module Sentdm
4
4
  module Models
5
- class LookupRetrievePhoneInfoResponse < Sentdm::Internal::Type::BaseModel
5
+ class NumberLookupResponse < Sentdm::Internal::Type::BaseModel
6
6
  OrHash =
7
7
  T.type_alias do
8
- T.any(
9
- Sentdm::Models::LookupRetrievePhoneInfoResponse,
10
- Sentdm::Internal::AnyHash
11
- )
8
+ T.any(Sentdm::Models::NumberLookupResponse, Sentdm::Internal::AnyHash)
12
9
  end
13
10
 
14
11
  # The response data (null if error)
15
- sig do
16
- returns(
17
- T.nilable(Sentdm::Models::LookupRetrievePhoneInfoResponse::Data)
18
- )
19
- end
12
+ sig { returns(T.nilable(Sentdm::Models::NumberLookupResponse::Data)) }
20
13
  attr_reader :data
21
14
 
22
15
  sig do
23
16
  params(
24
- data:
25
- T.nilable(
26
- Sentdm::Models::LookupRetrievePhoneInfoResponse::Data::OrHash
27
- )
17
+ data: T.nilable(Sentdm::Models::NumberLookupResponse::Data::OrHash)
28
18
  ).void
29
19
  end
30
20
  attr_writer :data
@@ -53,10 +43,7 @@ module Sentdm
53
43
  # Standard API response envelope for all v3 endpoints
54
44
  sig do
55
45
  params(
56
- data:
57
- T.nilable(
58
- Sentdm::Models::LookupRetrievePhoneInfoResponse::Data::OrHash
59
- ),
46
+ data: T.nilable(Sentdm::Models::NumberLookupResponse::Data::OrHash),
60
47
  error: T.nilable(Sentdm::APIError::OrHash),
61
48
  meta: Sentdm::APIMeta::OrHash,
62
49
  success: T::Boolean
@@ -77,8 +64,7 @@ module Sentdm
77
64
  sig do
78
65
  override.returns(
79
66
  {
80
- data:
81
- T.nilable(Sentdm::Models::LookupRetrievePhoneInfoResponse::Data),
67
+ data: T.nilable(Sentdm::Models::NumberLookupResponse::Data),
82
68
  error: T.nilable(Sentdm::APIError),
83
69
  meta: Sentdm::APIMeta,
84
70
  success: T::Boolean
@@ -92,7 +78,7 @@ module Sentdm
92
78
  OrHash =
93
79
  T.type_alias do
94
80
  T.any(
95
- Sentdm::Models::LookupRetrievePhoneInfoResponse::Data,
81
+ Sentdm::Models::NumberLookupResponse::Data,
96
82
  Sentdm::Internal::AnyHash
97
83
  )
98
84
  end
@@ -100,6 +86,9 @@ module Sentdm
100
86
  sig { returns(T.nilable(String)) }
101
87
  attr_accessor :carrier_name
102
88
 
89
+ sig { returns(T.nilable(String)) }
90
+ attr_accessor :country_code
91
+
103
92
  sig { returns(T.nilable(T::Boolean)) }
104
93
  attr_accessor :is_ported
105
94
 
@@ -127,36 +116,30 @@ module Sentdm
127
116
  sig { params(phone_number: String).void }
128
117
  attr_writer :phone_number
129
118
 
130
- sig { returns(T.nilable(String)) }
131
- attr_reader :provider
132
-
133
- sig { params(provider: String).void }
134
- attr_writer :provider
135
-
136
119
  # The response data (null if error)
137
120
  sig do
138
121
  params(
139
122
  carrier_name: T.nilable(String),
123
+ country_code: T.nilable(String),
140
124
  is_ported: T.nilable(T::Boolean),
141
125
  is_valid: T::Boolean,
142
126
  is_voip: T.nilable(T::Boolean),
143
127
  line_type: T.nilable(String),
144
128
  mobile_country_code: T.nilable(String),
145
129
  mobile_network_code: T.nilable(String),
146
- phone_number: String,
147
- provider: String
130
+ phone_number: String
148
131
  ).returns(T.attached_class)
149
132
  end
150
133
  def self.new(
151
134
  carrier_name: nil,
135
+ country_code: nil,
152
136
  is_ported: nil,
153
137
  is_valid: nil,
154
138
  is_voip: nil,
155
139
  line_type: nil,
156
140
  mobile_country_code: nil,
157
141
  mobile_network_code: nil,
158
- phone_number: nil,
159
- provider: nil
142
+ phone_number: nil
160
143
  )
161
144
  end
162
145
 
@@ -164,14 +147,14 @@ module Sentdm
164
147
  override.returns(
165
148
  {
166
149
  carrier_name: T.nilable(String),
150
+ country_code: T.nilable(String),
167
151
  is_ported: T.nilable(T::Boolean),
168
152
  is_valid: T::Boolean,
169
153
  is_voip: T.nilable(T::Boolean),
170
154
  line_type: T.nilable(String),
171
155
  mobile_country_code: T.nilable(String),
172
156
  mobile_network_code: T.nilable(String),
173
- phone_number: String,
174
- provider: String
157
+ phone_number: String
175
158
  }
176
159
  )
177
160
  end
@@ -0,0 +1,59 @@
1
+ # typed: strong
2
+
3
+ module Sentdm
4
+ module Models
5
+ class PaymentDetails < Sentdm::Internal::Type::BaseModel
6
+ OrHash =
7
+ T.type_alias do
8
+ T.any(Sentdm::PaymentDetails, Sentdm::Internal::AnyHash)
9
+ end
10
+
11
+ # Card number (digits only, 13–19 characters)
12
+ sig { returns(String) }
13
+ attr_accessor :card_number
14
+
15
+ # Card security code (3–4 digits)
16
+ sig { returns(String) }
17
+ attr_accessor :cvc
18
+
19
+ # Card expiry date in MM/YY format (e.g. "09/27")
20
+ sig { returns(String) }
21
+ attr_accessor :expiry
22
+
23
+ # Billing ZIP / postal code associated with the card
24
+ sig { returns(String) }
25
+ attr_accessor :zip_code
26
+
27
+ # Payment card details for a profile. Accepted when billing_model is "profile" or
28
+ # "profile_and_organization". These details are not stored on our servers and will
29
+ # be forwarded to the payment processor.
30
+ sig do
31
+ params(
32
+ card_number: String,
33
+ cvc: String,
34
+ expiry: String,
35
+ zip_code: String
36
+ ).returns(T.attached_class)
37
+ end
38
+ def self.new(
39
+ # Card number (digits only, 13–19 characters)
40
+ card_number:,
41
+ # Card security code (3–4 digits)
42
+ cvc:,
43
+ # Card expiry date in MM/YY format (e.g. "09/27")
44
+ expiry:,
45
+ # Billing ZIP / postal code associated with the card
46
+ zip_code:
47
+ )
48
+ end
49
+
50
+ sig do
51
+ override.returns(
52
+ { card_number: String, cvc: String, expiry: String, zip_code: String }
53
+ )
54
+ end
55
+ def to_hash
56
+ end
57
+ end
58
+ end
59
+ end
@@ -2,13 +2,13 @@
2
2
 
3
3
  module Sentdm
4
4
  module Models
5
- class ProfileCompleteParams < Sentdm::Internal::Type::BaseModel
5
+ class ProfileCompleteSetupParams < Sentdm::Internal::Type::BaseModel
6
6
  extend Sentdm::Internal::Type::RequestParameters::Converter
7
7
  include Sentdm::Internal::Type::RequestParameters
8
8
 
9
9
  OrHash =
10
10
  T.type_alias do
11
- T.any(Sentdm::ProfileCompleteParams, Sentdm::Internal::AnyHash)
11
+ T.any(Sentdm::ProfileCompleteSetupParams, Sentdm::Internal::AnyHash)
12
12
  end
13
13
 
14
14
  sig { returns(String) }
@@ -18,13 +18,13 @@ module Sentdm
18
18
  sig { returns(String) }
19
19
  attr_accessor :web_hook_url
20
20
 
21
- # Test mode flag - when true, the operation is simulated without side effects
22
- # Useful for testing integrations without actual execution
21
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
22
+ # for testing integrations without actual execution
23
23
  sig { returns(T.nilable(T::Boolean)) }
24
- attr_reader :test_mode
24
+ attr_reader :sandbox
25
25
 
26
- sig { params(test_mode: T::Boolean).void }
27
- attr_writer :test_mode
26
+ sig { params(sandbox: T::Boolean).void }
27
+ attr_writer :sandbox
28
28
 
29
29
  sig { returns(T.nilable(String)) }
30
30
  attr_reader :idempotency_key
@@ -32,12 +32,19 @@ module Sentdm
32
32
  sig { params(idempotency_key: String).void }
33
33
  attr_writer :idempotency_key
34
34
 
35
+ sig { returns(T.nilable(String)) }
36
+ attr_reader :x_profile_id
37
+
38
+ sig { params(x_profile_id: String).void }
39
+ attr_writer :x_profile_id
40
+
35
41
  sig do
36
42
  params(
37
43
  profile_id: String,
38
44
  web_hook_url: String,
39
- test_mode: T::Boolean,
45
+ sandbox: T::Boolean,
40
46
  idempotency_key: String,
47
+ x_profile_id: String,
41
48
  request_options: Sentdm::RequestOptions::OrHash
42
49
  ).returns(T.attached_class)
43
50
  end
@@ -45,10 +52,11 @@ module Sentdm
45
52
  profile_id:,
46
53
  # Webhook URL to call when profile completion finishes (success or failure)
47
54
  web_hook_url:,
48
- # Test mode flag - when true, the operation is simulated without side effects
49
- # Useful for testing integrations without actual execution
50
- test_mode: nil,
55
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
56
+ # for testing integrations without actual execution
57
+ sandbox: nil,
51
58
  idempotency_key: nil,
59
+ x_profile_id: nil,
52
60
  request_options: {}
53
61
  )
54
62
  end
@@ -58,8 +66,9 @@ module Sentdm
58
66
  {
59
67
  profile_id: String,
60
68
  web_hook_url: String,
61
- test_mode: T::Boolean,
69
+ sandbox: T::Boolean,
62
70
  idempotency_key: String,
71
+ x_profile_id: String,
63
72
  request_options: Sentdm::RequestOptions
64
73
  }
65
74
  )
@@ -2,7 +2,7 @@
2
2
 
3
3
  module Sentdm
4
4
  module Models
5
- ProfileCompleteResponse =
5
+ ProfileCompleteSetupResponse =
6
6
  T.let(T.anything, Sentdm::Internal::Type::Converter)
7
7
  end
8
8
  end