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
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Sentdm
4
4
  module Models
5
- # @see Sentdm::Resources::Profiles#complete
6
- class ProfileCompleteParams < Sentdm::Internal::Type::BaseModel
5
+ # @see Sentdm::Resources::Profiles#complete_setup
6
+ class ProfileCompleteSetupParams < Sentdm::Internal::Type::BaseModel
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
@@ -18,30 +18,37 @@ module Sentdm
18
18
  # @return [String]
19
19
  required :web_hook_url, String, api_name: :webHookUrl
20
20
 
21
- # @!attribute test_mode
22
- # Test mode flag - when true, the operation is simulated without side effects
23
- # Useful for testing integrations without actual execution
21
+ # @!attribute sandbox
22
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
23
+ # for testing integrations without actual execution
24
24
  #
25
25
  # @return [Boolean, nil]
26
- optional :test_mode, Sentdm::Internal::Type::Boolean
26
+ optional :sandbox, Sentdm::Internal::Type::Boolean
27
27
 
28
28
  # @!attribute idempotency_key
29
29
  #
30
30
  # @return [String, nil]
31
31
  optional :idempotency_key, String
32
32
 
33
- # @!method initialize(profile_id:, web_hook_url:, test_mode: nil, idempotency_key: nil, request_options: {})
33
+ # @!attribute x_profile_id
34
+ #
35
+ # @return [String, nil]
36
+ optional :x_profile_id, String
37
+
38
+ # @!method initialize(profile_id:, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
34
39
  # Some parameter documentations has been truncated, see
35
- # {Sentdm::Models::ProfileCompleteParams} for more details.
40
+ # {Sentdm::Models::ProfileCompleteSetupParams} for more details.
36
41
  #
37
42
  # @param profile_id [String]
38
43
  #
39
44
  # @param web_hook_url [String] Webhook URL to call when profile completion finishes (success or failure)
40
45
  #
41
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
46
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
42
47
  #
43
48
  # @param idempotency_key [String]
44
49
  #
50
+ # @param x_profile_id [String]
51
+ #
45
52
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
46
53
  end
47
54
  end
@@ -3,6 +3,6 @@
3
3
  module Sentdm
4
4
  module Models
5
5
  # @type [Sentdm::Internal::Type::Converter]
6
- ProfileCompleteResponse = Sentdm::Internal::Type::Unknown
6
+ ProfileCompleteSetupResponse = Sentdm::Internal::Type::Unknown
7
7
  end
8
8
  end
@@ -19,13 +19,35 @@ module Sentdm
19
19
  # @return [Boolean, nil]
20
20
  optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
21
21
 
22
+ # @!attribute billing_contact
23
+ # Billing contact for this profile. Required when billing_model is "profile" or
24
+ # "profile_and_organization". Identifies who receives invoices and who is
25
+ # responsible for payment.
26
+ #
27
+ # @return [Sentdm::Models::BillingContactInfo, nil]
28
+ optional :billing_contact, -> { Sentdm::BillingContactInfo }, nil?: true
29
+
22
30
  # @!attribute billing_model
23
31
  # Billing model: profile, organization, or profile_and_organization (default:
24
- # profile)
32
+ # profile).
33
+ #
34
+ # - "organization": the organization's billing details are used; no profile-level
35
+ # billing info needed.
36
+ # - "profile": the profile is billed independently; billing_contact is required.
37
+ # - "profile_and_organization": the profile is billed first with the organization
38
+ # as fallback; billing_contact is required.
25
39
  #
26
40
  # @return [String, nil]
27
41
  optional :billing_model, String, nil?: true
28
42
 
43
+ # @!attribute brand
44
+ # Brand and KYC information for this profile (optional). When provided, creates
45
+ # the brand associated with this profile. Cannot be set when inherit_tcr_brand is
46
+ # true.
47
+ #
48
+ # @return [Sentdm::Models::BrandsBrandData, nil]
49
+ optional :brand, -> { Sentdm::BrandsBrandData }, nil?: true
50
+
29
51
  # @!attribute description
30
52
  # Profile description (optional)
31
53
  #
@@ -68,25 +90,52 @@ module Sentdm
68
90
  # @return [String, nil]
69
91
  optional :name, String
70
92
 
93
+ # @!attribute payment_details
94
+ # Payment card details for this profile (optional). Accepted when billing_model is
95
+ # "profile" or "profile_and_organization". Not persisted on our servers —
96
+ # forwarded to the payment processor.
97
+ #
98
+ # @return [Sentdm::Models::PaymentDetails, nil]
99
+ optional :payment_details, -> { Sentdm::PaymentDetails }, nil?: true
100
+
101
+ # @!attribute sandbox
102
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
103
+ # for testing integrations without actual execution
104
+ #
105
+ # @return [Boolean, nil]
106
+ optional :sandbox, Sentdm::Internal::Type::Boolean
107
+
71
108
  # @!attribute short_name
72
- # Profile short name/abbreviation (optional)
109
+ # Profile short name/abbreviation (optional). Must be 3–11 characters, contain
110
+ # only letters, numbers, and spaces, and include at least one letter. Example:
111
+ # "SALES", "Mkt 2", "Support1".
73
112
  #
74
113
  # @return [String, nil]
75
114
  optional :short_name, String, nil?: true
76
115
 
77
- # @!attribute test_mode
78
- # Test mode flag - when true, the operation is simulated without side effects
79
- # Useful for testing integrations without actual execution
80
- #
81
- # @return [Boolean, nil]
82
- optional :test_mode, Sentdm::Internal::Type::Boolean
116
+ # @!attribute whatsapp_business_account
117
+ # Direct WhatsApp Business Account credentials for this profile. When provided,
118
+ # the profile uses its own WhatsApp Business Account instead of inheriting from
119
+ # the organization. When omitted, the profile inherits the organization's WhatsApp
120
+ # Business Account (requires the organization to have completed WhatsApp Embedded
121
+ # Signup).
122
+ #
123
+ # @return [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil]
124
+ optional :whatsapp_business_account,
125
+ -> { Sentdm::ProfileCreateParams::WhatsappBusinessAccount },
126
+ nil?: true
83
127
 
84
128
  # @!attribute idempotency_key
85
129
  #
86
130
  # @return [String, nil]
87
131
  optional :idempotency_key, String
88
132
 
89
- # @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, short_name: nil, test_mode: nil, idempotency_key: nil, request_options: {})
133
+ # @!attribute x_profile_id
134
+ #
135
+ # @return [String, nil]
136
+ optional :x_profile_id, String
137
+
138
+ # @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, payment_details: nil, sandbox: nil, short_name: nil, whatsapp_business_account: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
90
139
  # Some parameter documentations has been truncated, see
91
140
  # {Sentdm::Models::ProfileCreateParams} for more details.
92
141
  #
@@ -94,8 +143,12 @@ module Sentdm
94
143
  #
95
144
  # @param allow_template_sharing [Boolean] Whether templates are shared across profiles (default: false)
96
145
  #
146
+ # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Billing contact for this profile. Required when billing_model is "profile" or "p
147
+ #
97
148
  # @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization (default: prof
98
149
  #
150
+ # @param brand [Sentdm::Models::BrandsBrandData, nil] Brand and KYC information for this profile (optional).
151
+ #
99
152
  # @param description [String, nil] Profile description (optional)
100
153
  #
101
154
  # @param icon [String, nil] Profile icon URL (optional)
@@ -110,13 +163,60 @@ module Sentdm
110
163
  #
111
164
  # @param name [String] Profile name (required)
112
165
  #
113
- # @param short_name [String, nil] Profile short name/abbreviation (optional)
166
+ # @param payment_details [Sentdm::Models::PaymentDetails, nil] Payment card details for this profile (optional).
167
+ #
168
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
114
169
  #
115
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
170
+ # @param short_name [String, nil] Profile short name/abbreviation (optional). Must be 3–11 characters, contain onl
171
+ #
172
+ # @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Direct WhatsApp Business Account credentials for this profile.
116
173
  #
117
174
  # @param idempotency_key [String]
118
175
  #
176
+ # @param x_profile_id [String]
177
+ #
119
178
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
179
+
180
+ class WhatsappBusinessAccount < Sentdm::Internal::Type::BaseModel
181
+ # @!attribute access_token
182
+ # System User access token with whatsapp_business_messaging and
183
+ # whatsapp_business_management permissions. This value is stored securely and
184
+ # never returned in API responses.
185
+ #
186
+ # @return [String]
187
+ required :access_token, String
188
+
189
+ # @!attribute waba_id
190
+ # WhatsApp Business Account ID from Meta Business Manager
191
+ #
192
+ # @return [String]
193
+ required :waba_id, String
194
+
195
+ # @!attribute phone_number_id
196
+ # Phone Number ID of an existing number already registered under this WABA in Meta
197
+ # Business Manager. Optional — when omitted, a number will be provisioned from our
198
+ # pool and registered in the WABA during the onboarding flow. When provided, the
199
+ # number must already exist in the WABA.
200
+ #
201
+ # @return [String, nil]
202
+ optional :phone_number_id, String, nil?: true
203
+
204
+ # @!method initialize(access_token:, waba_id:, phone_number_id: nil)
205
+ # Some parameter documentations has been truncated, see
206
+ # {Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount} for more details.
207
+ #
208
+ # Direct WhatsApp Business Account credentials for this profile. When provided,
209
+ # the profile uses its own WhatsApp Business Account instead of inheriting from
210
+ # the organization. When omitted, the profile inherits the organization's WhatsApp
211
+ # Business Account (requires the organization to have completed WhatsApp Embedded
212
+ # Signup).
213
+ #
214
+ # @param access_token [String] System User access token with whatsapp_business_messaging and
215
+ #
216
+ # @param waba_id [String] WhatsApp Business Account ID from Meta Business Manager
217
+ #
218
+ # @param phone_number_id [String, nil] Phone Number ID of an existing number already registered under this WABA in Meta
219
+ end
120
220
  end
121
221
  end
122
222
  end
@@ -7,35 +7,35 @@ module Sentdm
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute path_profile_id
10
+ # @!attribute profile_id
11
11
  #
12
12
  # @return [String]
13
- required :path_profile_id, String
13
+ required :profile_id, String
14
14
 
15
- # @!attribute body_profile_id
16
- # Profile ID from route parameter
15
+ # @!attribute body
16
+ # Request to delete a profile
17
17
  #
18
- # @return [String, nil]
19
- optional :body_profile_id, String, api_name: :profile_id
18
+ # @return [Sentdm::Models::ProfileDeleteParams::Body]
19
+ required :body, -> { Sentdm::ProfileDeleteParams::Body }
20
20
 
21
- # @!attribute test_mode
22
- # Test mode flag - when true, the operation is simulated without side effects
23
- # Useful for testing integrations without actual execution
21
+ # @!attribute x_profile_id
24
22
  #
25
- # @return [Boolean, nil]
26
- optional :test_mode, Sentdm::Internal::Type::Boolean
23
+ # @return [String, nil]
24
+ optional :x_profile_id, String
27
25
 
28
- # @!method initialize(path_profile_id:, body_profile_id: nil, test_mode: nil, request_options: {})
29
- # Some parameter documentations has been truncated, see
30
- # {Sentdm::Models::ProfileDeleteParams} for more details.
26
+ # @!method initialize(profile_id:, body:, x_profile_id: nil, request_options: {})
27
+ # @param profile_id [String]
31
28
  #
32
- # @param path_profile_id [String]
29
+ # @param body [Sentdm::Models::ProfileDeleteParams::Body] Request to delete a profile
33
30
  #
34
- # @param body_profile_id [String] Profile ID from route parameter
35
- #
36
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
31
+ # @param x_profile_id [String]
37
32
  #
38
33
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
34
+
35
+ class Body < Sentdm::Models::MutationRequestBase
36
+ # @!method initialize
37
+ # Request to delete a profile
38
+ end
39
39
  end
40
40
  end
41
41
  end