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
@@ -12,8 +12,14 @@ module Sentdm
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute x_profile_id
16
+ #
17
+ # @return [String, nil]
18
+ optional :x_profile_id, String
19
+
20
+ # @!method initialize(id:, x_profile_id: nil, request_options: {})
16
21
  # @param id [String]
22
+ # @param x_profile_id [String]
17
23
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
18
24
  end
19
25
  end
@@ -24,19 +24,24 @@ module Sentdm
24
24
  # @return [Boolean, nil]
25
25
  optional :opt_out, Sentdm::Internal::Type::Boolean, nil?: true
26
26
 
27
- # @!attribute test_mode
28
- # Test mode flag - when true, the operation is simulated without side effects
29
- # Useful for testing integrations without actual execution
27
+ # @!attribute sandbox
28
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
29
+ # for testing integrations without actual execution
30
30
  #
31
31
  # @return [Boolean, nil]
32
- optional :test_mode, Sentdm::Internal::Type::Boolean
32
+ optional :sandbox, Sentdm::Internal::Type::Boolean
33
33
 
34
34
  # @!attribute idempotency_key
35
35
  #
36
36
  # @return [String, nil]
37
37
  optional :idempotency_key, String
38
38
 
39
- # @!method initialize(id:, default_channel: nil, opt_out: nil, test_mode: nil, idempotency_key: nil, request_options: {})
39
+ # @!attribute x_profile_id
40
+ #
41
+ # @return [String, nil]
42
+ optional :x_profile_id, String
43
+
44
+ # @!method initialize(id:, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
40
45
  # Some parameter documentations has been truncated, see
41
46
  # {Sentdm::Models::ContactUpdateParams} for more details.
42
47
  #
@@ -46,10 +51,12 @@ module Sentdm
46
51
  #
47
52
  # @param opt_out [Boolean, nil] Whether the contact has opted out of messaging
48
53
  #
49
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
54
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
50
55
  #
51
56
  # @param idempotency_key [String]
52
57
  #
58
+ # @param x_profile_id [String]
59
+ #
53
60
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
54
61
  end
55
62
  end
@@ -7,7 +7,13 @@ module Sentdm
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute x_profile_id
11
+ #
12
+ # @return [String, nil]
13
+ optional :x_profile_id, String
14
+
15
+ # @!method initialize(x_profile_id: nil, request_options: {})
16
+ # @param x_profile_id [String]
11
17
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -42,11 +42,17 @@ module Sentdm
42
42
  # @see Sentdm::Models::MeRetrieveResponse#data
43
43
  class Data < Sentdm::Internal::Type::BaseModel
44
44
  # @!attribute id
45
- # Customer ID (organization or profile)
45
+ # Customer ID (organization, account, or profile)
46
46
  #
47
47
  # @return [String, nil]
48
48
  optional :id, String
49
49
 
50
+ # @!attribute channels
51
+ # Messaging channel configuration
52
+ #
53
+ # @return [Sentdm::Models::MeRetrieveResponse::Data::Channels, nil]
54
+ optional :channels, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels }
55
+
50
56
  # @!attribute created_at
51
57
  # When the account was created
52
58
  #
@@ -59,6 +65,12 @@ module Sentdm
59
65
  # @return [String, nil]
60
66
  optional :description, String, nil?: true
61
67
 
68
+ # @!attribute email
69
+ # Contact email address
70
+ #
71
+ # @return [String, nil]
72
+ optional :email, String, nil?: true
73
+
62
74
  # @!attribute icon
63
75
  # Account icon URL
64
76
  #
@@ -71,13 +83,19 @@ module Sentdm
71
83
  # @return [String, nil]
72
84
  optional :name, String
73
85
 
86
+ # @!attribute organization_id
87
+ # Organization ID (only for profile type — the parent organization)
88
+ #
89
+ # @return [String, nil]
90
+ optional :organization_id, String, nil?: true
91
+
74
92
  # @!attribute profiles
75
- # List of profiles (only for organization type)
93
+ # List of profiles (populated for organization type, empty for user and profile
94
+ # types)
76
95
  #
77
96
  # @return [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>, nil]
78
97
  optional :profiles,
79
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] },
80
- nil?: true
98
+ -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] }
81
99
 
82
100
  # @!attribute settings
83
101
  # Profile settings (only for profile type)
@@ -85,6 +103,12 @@ module Sentdm
85
103
  # @return [Sentdm::Models::ProfileSettings, nil]
86
104
  optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
87
105
 
106
+ # @!attribute short_name
107
+ # Short name / abbreviation (only for profile type)
108
+ #
109
+ # @return [String, nil]
110
+ optional :short_name, String, nil?: true
111
+
88
112
  # @!attribute status
89
113
  # Profile status (only for profile type): incomplete, pending_review, approved,
90
114
  # etc.
@@ -92,27 +116,148 @@ module Sentdm
92
116
  # @return [String, nil]
93
117
  optional :status, String, nil?: true
94
118
 
95
- # @!method initialize(id: nil, created_at: nil, description: nil, icon: nil, name: nil, profiles: nil, settings: nil, status: nil)
119
+ # @!attribute type
120
+ # Account type: "organization" (has profiles), "user" (no profiles), or "profile"
121
+ # (child of an organization)
122
+ #
123
+ # @return [String, nil]
124
+ optional :type, String
125
+
126
+ # @!method initialize(id: nil, channels: nil, created_at: nil, description: nil, email: nil, icon: nil, name: nil, organization_id: nil, profiles: nil, settings: nil, short_name: nil, status: nil, type: nil)
96
127
  # Some parameter documentations has been truncated, see
97
128
  # {Sentdm::Models::MeRetrieveResponse::Data} for more details.
98
129
  #
99
130
  # The response data (null if error)
100
131
  #
101
- # @param id [String] Customer ID (organization or profile)
132
+ # @param id [String] Customer ID (organization, account, or profile)
133
+ #
134
+ # @param channels [Sentdm::Models::MeRetrieveResponse::Data::Channels] Messaging channel configuration
102
135
  #
103
136
  # @param created_at [Time] When the account was created
104
137
  #
105
138
  # @param description [String, nil] Account description
106
139
  #
140
+ # @param email [String, nil] Contact email address
141
+ #
107
142
  # @param icon [String, nil] Account icon URL
108
143
  #
109
144
  # @param name [String] Account name
110
145
  #
111
- # @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>, nil] List of profiles (only for organization type)
146
+ # @param organization_id [String, nil] Organization ID (only for profile type — the parent organization)
147
+ #
148
+ # @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>] List of profiles (populated for organization type, empty for user and profile ty
112
149
  #
113
150
  # @param settings [Sentdm::Models::ProfileSettings, nil] Profile settings (only for profile type)
114
151
  #
152
+ # @param short_name [String, nil] Short name / abbreviation (only for profile type)
153
+ #
115
154
  # @param status [String, nil] Profile status (only for profile type): incomplete, pending_review, approved, et
155
+ #
156
+ # @param type [String] Account type: "organization" (has profiles), "user" (no profiles), or "profile"
157
+
158
+ # @see Sentdm::Models::MeRetrieveResponse::Data#channels
159
+ class Channels < Sentdm::Internal::Type::BaseModel
160
+ # @!attribute rcs
161
+ # RCS channel (provider: vibes)
162
+ #
163
+ # @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs, nil]
164
+ optional :rcs, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs }
165
+
166
+ # @!attribute sms
167
+ # SMS channel (providers: telnyx, sinch)
168
+ #
169
+ # @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS, nil]
170
+ optional :sms, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS }
171
+
172
+ # @!attribute whatsapp
173
+ # WhatsApp Business channel (provider: meta)
174
+ #
175
+ # @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp, nil]
176
+ optional :whatsapp, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp }
177
+
178
+ # @!method initialize(rcs: nil, sms: nil, whatsapp: nil)
179
+ # Messaging channel configuration
180
+ #
181
+ # @param rcs [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs] RCS channel (provider: vibes)
182
+ #
183
+ # @param sms [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS] SMS channel (providers: telnyx, sinch)
184
+ #
185
+ # @param whatsapp [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp] WhatsApp Business channel (provider: meta)
186
+
187
+ # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#rcs
188
+ class Rcs < Sentdm::Internal::Type::BaseModel
189
+ # @!attribute configured
190
+ # Whether RCS is configured for this account
191
+ #
192
+ # @return [Boolean, nil]
193
+ optional :configured, Sentdm::Internal::Type::Boolean
194
+
195
+ # @!attribute phone_number
196
+ # RCS-enabled phone number in E.164 format
197
+ #
198
+ # @return [String, nil]
199
+ optional :phone_number, String, nil?: true
200
+
201
+ # @!method initialize(configured: nil, phone_number: nil)
202
+ # RCS channel (provider: vibes)
203
+ #
204
+ # @param configured [Boolean] Whether RCS is configured for this account
205
+ #
206
+ # @param phone_number [String, nil] RCS-enabled phone number in E.164 format
207
+ end
208
+
209
+ # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#sms
210
+ class SMS < Sentdm::Internal::Type::BaseModel
211
+ # @!attribute configured
212
+ # Whether SMS is configured for this account
213
+ #
214
+ # @return [Boolean, nil]
215
+ optional :configured, Sentdm::Internal::Type::Boolean
216
+
217
+ # @!attribute phone_number
218
+ # Sending phone number in E.164 format
219
+ #
220
+ # @return [String, nil]
221
+ optional :phone_number, String, nil?: true
222
+
223
+ # @!method initialize(configured: nil, phone_number: nil)
224
+ # SMS channel (providers: telnyx, sinch)
225
+ #
226
+ # @param configured [Boolean] Whether SMS is configured for this account
227
+ #
228
+ # @param phone_number [String, nil] Sending phone number in E.164 format
229
+ end
230
+
231
+ # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#whatsapp
232
+ class Whatsapp < Sentdm::Internal::Type::BaseModel
233
+ # @!attribute business_name
234
+ # WhatsApp Business display name
235
+ #
236
+ # @return [String, nil]
237
+ optional :business_name, String, nil?: true
238
+
239
+ # @!attribute configured
240
+ # Whether WhatsApp is configured for this account
241
+ #
242
+ # @return [Boolean, nil]
243
+ optional :configured, Sentdm::Internal::Type::Boolean
244
+
245
+ # @!attribute phone_number
246
+ # WhatsApp phone number in E.164 format
247
+ #
248
+ # @return [String, nil]
249
+ optional :phone_number, String, nil?: true
250
+
251
+ # @!method initialize(business_name: nil, configured: nil, phone_number: nil)
252
+ # WhatsApp Business channel (provider: meta)
253
+ #
254
+ # @param business_name [String, nil] WhatsApp Business display name
255
+ #
256
+ # @param configured [Boolean] Whether WhatsApp is configured for this account
257
+ #
258
+ # @param phone_number [String, nil] WhatsApp phone number in E.164 format
259
+ end
260
+ end
116
261
 
117
262
  class Profile < Sentdm::Internal::Type::BaseModel
118
263
  # @!attribute id
@@ -12,8 +12,14 @@ module Sentdm
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute x_profile_id
16
+ #
17
+ # @return [String, nil]
18
+ optional :x_profile_id, String
19
+
20
+ # @!method initialize(id:, x_profile_id: nil, request_options: {})
16
21
  # @param id [String]
22
+ # @param x_profile_id [String]
17
23
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
18
24
  end
19
25
  end
@@ -62,11 +62,12 @@ module Sentdm
62
62
  # @param message_id [String] The message ID these activities belong to
63
63
 
64
64
  class Activity < Sentdm::Internal::Type::BaseModel
65
- # @!attribute content
66
- # Additional content or payload for the activity (e.g., channel response)
65
+ # @!attribute active_contact_price
66
+ # Active contact markup applied on top of the channel cost, formatted to 4 decimal
67
+ # places.
67
68
  #
68
69
  # @return [String, nil]
69
- optional :content, String, nil?: true
70
+ optional :active_contact_price, String, nil?: true
70
71
 
71
72
  # @!attribute description
72
73
  # Human-readable description of the activity
@@ -74,6 +75,13 @@ module Sentdm
74
75
  # @return [String, nil]
75
76
  optional :description, String
76
77
 
78
+ # @!attribute price
79
+ # Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
80
+ # 4 decimal places.
81
+ #
82
+ # @return [String, nil]
83
+ optional :price, String, nil?: true
84
+
77
85
  # @!attribute status
78
86
  # Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
79
87
  #
@@ -86,13 +94,19 @@ module Sentdm
86
94
  # @return [Time, nil]
87
95
  optional :timestamp, Time
88
96
 
89
- # @!method initialize(content: nil, description: nil, status: nil, timestamp: nil)
97
+ # @!method initialize(active_contact_price: nil, description: nil, price: nil, status: nil, timestamp: nil)
98
+ # Some parameter documentations has been truncated, see
99
+ # {Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity} for more
100
+ # details.
101
+ #
90
102
  # A single message activity event for v3 API
91
103
  #
92
- # @param content [String, nil] Additional content or payload for the activity (e.g., channel response)
104
+ # @param active_contact_price [String, nil] Active contact markup applied on top of the channel cost, formatted to 4 decimal
93
105
  #
94
106
  # @param description [String] Human-readable description of the activity
95
107
  #
108
+ # @param price [String, nil] Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
109
+ #
96
110
  # @param status [String] Activity status (e.g., ACCEPTED, PROCESSED, SENT, DELIVERED, FAILED)
97
111
  #
98
112
  # @param timestamp [Time] When this activity occurred
@@ -12,8 +12,14 @@ module Sentdm
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute x_profile_id
16
+ #
17
+ # @return [String, nil]
18
+ optional :x_profile_id, String
19
+
20
+ # @!method initialize(id:, x_profile_id: nil, request_options: {})
16
21
  # @param id [String]
22
+ # @param x_profile_id [String]
17
23
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
18
24
  end
19
25
  end
@@ -46,6 +46,11 @@ module Sentdm
46
46
  # @return [String, nil]
47
47
  optional :id, String
48
48
 
49
+ # @!attribute active_contact_price
50
+ #
51
+ # @return [Float, nil]
52
+ optional :active_contact_price, Float, nil?: true
53
+
49
54
  # @!attribute channel
50
55
  #
51
56
  # @return [String, nil]
@@ -122,7 +127,7 @@ module Sentdm
122
127
  # @return [String, nil]
123
128
  optional :template_name, String
124
129
 
125
- # @!method initialize(id: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
130
+ # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
126
131
  # Some parameter documentations has been truncated, see
127
132
  # {Sentdm::Models::MessageRetrieveStatusResponse::Data} for more details.
128
133
  #
@@ -130,6 +135,8 @@ module Sentdm
130
135
  #
131
136
  # @param id [String]
132
137
  #
138
+ # @param active_contact_price [Float, nil]
139
+ #
133
140
  # @param channel [String]
134
141
  #
135
142
  # @param contact_id [String]
@@ -15,19 +15,19 @@ module Sentdm
15
15
  # @return [Array<String>, nil]
16
16
  optional :channel, Sentdm::Internal::Type::ArrayOf[String], nil?: true
17
17
 
18
+ # @!attribute sandbox
19
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
20
+ # for testing integrations without actual execution
21
+ #
22
+ # @return [Boolean, nil]
23
+ optional :sandbox, Sentdm::Internal::Type::Boolean
24
+
18
25
  # @!attribute template
19
26
  # Template reference (by id or name, with optional parameters)
20
27
  #
21
28
  # @return [Sentdm::Models::MessageSendParams::Template, nil]
22
29
  optional :template, -> { Sentdm::MessageSendParams::Template }
23
30
 
24
- # @!attribute test_mode
25
- # Test mode flag - when true, the operation is simulated without side effects
26
- # Useful for testing integrations without actual execution
27
- #
28
- # @return [Boolean, nil]
29
- optional :test_mode, Sentdm::Internal::Type::Boolean
30
-
31
31
  # @!attribute to
32
32
  # List of recipient phone numbers in E.164 format (multi-recipient fan-out)
33
33
  #
@@ -39,20 +39,27 @@ module Sentdm
39
39
  # @return [String, nil]
40
40
  optional :idempotency_key, String
41
41
 
42
- # @!method initialize(channel: nil, template: nil, test_mode: nil, to: nil, idempotency_key: nil, request_options: {})
42
+ # @!attribute x_profile_id
43
+ #
44
+ # @return [String, nil]
45
+ optional :x_profile_id, String
46
+
47
+ # @!method initialize(channel: nil, sandbox: nil, template: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
43
48
  # Some parameter documentations has been truncated, see
44
49
  # {Sentdm::Models::MessageSendParams} for more details.
45
50
  #
46
51
  # @param channel [Array<String>, nil] Channels to broadcast on, e.g. ["whatsapp", "sms"].
47
52
  #
48
- # @param template [Sentdm::Models::MessageSendParams::Template] Template reference (by id or name, with optional parameters)
53
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
49
54
  #
50
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
55
+ # @param template [Sentdm::Models::MessageSendParams::Template] Template reference (by id or name, with optional parameters)
51
56
  #
52
57
  # @param to [Array<String>] List of recipient phone numbers in E.164 format (multi-recipient fan-out)
53
58
  #
54
59
  # @param idempotency_key [String]
55
60
  #
61
+ # @param x_profile_id [String]
62
+ #
56
63
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
57
64
 
58
65
  class Template < Sentdm::Internal::Type::BaseModel
@@ -0,0 +1,20 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class MutationRequestBase < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute sandbox
7
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
8
+ # for testing integrations without actual execution
9
+ #
10
+ # @return [Boolean, nil]
11
+ optional :sandbox, Sentdm::Internal::Type::Boolean
12
+
13
+ # @!method initialize(sandbox: nil)
14
+ # Some parameter documentations has been truncated, see
15
+ # {Sentdm::Models::MutationRequestBase} for more details.
16
+ #
17
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
18
+ end
19
+ end
20
+ end
@@ -2,8 +2,8 @@
2
2
 
3
3
  module Sentdm
4
4
  module Models
5
- # @see Sentdm::Resources::Lookup#retrieve_phone_info
6
- class LookupRetrievePhoneInfoParams < Sentdm::Internal::Type::BaseModel
5
+ # @see Sentdm::Resources::Numbers#lookup
6
+ class NumberLookupParams < Sentdm::Internal::Type::BaseModel
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
@@ -12,8 +12,14 @@ module Sentdm
12
12
  # @return [String]
13
13
  required :phone_number, String
14
14
 
15
- # @!method initialize(phone_number:, request_options: {})
15
+ # @!attribute x_profile_id
16
+ #
17
+ # @return [String, nil]
18
+ optional :x_profile_id, String
19
+
20
+ # @!method initialize(phone_number:, x_profile_id: nil, request_options: {})
16
21
  # @param phone_number [String]
22
+ # @param x_profile_id [String]
17
23
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
18
24
  end
19
25
  end
@@ -2,13 +2,13 @@
2
2
 
3
3
  module Sentdm
4
4
  module Models
5
- # @see Sentdm::Resources::Lookup#retrieve_phone_info
6
- class LookupRetrievePhoneInfoResponse < Sentdm::Internal::Type::BaseModel
5
+ # @see Sentdm::Resources::Numbers#lookup
6
+ class NumberLookupResponse < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
8
  # The response data (null if error)
9
9
  #
10
- # @return [Sentdm::Models::LookupRetrievePhoneInfoResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::LookupRetrievePhoneInfoResponse::Data }, nil?: true
10
+ # @return [Sentdm::Models::NumberLookupResponse::Data, nil]
11
+ optional :data, -> { Sentdm::Models::NumberLookupResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
14
  # Error details (null if successful)
@@ -31,7 +31,7 @@ module Sentdm
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
32
  # Standard API response envelope for all v3 endpoints
33
33
  #
34
- # @param data [Sentdm::Models::LookupRetrievePhoneInfoResponse::Data, nil] The response data (null if error)
34
+ # @param data [Sentdm::Models::NumberLookupResponse::Data, nil] The response data (null if error)
35
35
  #
36
36
  # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
37
37
  #
@@ -39,57 +39,58 @@ module Sentdm
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
42
- # @see Sentdm::Models::LookupRetrievePhoneInfoResponse#data
42
+ # @see Sentdm::Models::NumberLookupResponse#data
43
43
  class Data < Sentdm::Internal::Type::BaseModel
44
44
  # @!attribute carrier_name
45
45
  #
46
46
  # @return [String, nil]
47
- optional :carrier_name, String, api_name: :carrierName, nil?: true
47
+ optional :carrier_name, String, nil?: true
48
+
49
+ # @!attribute country_code
50
+ #
51
+ # @return [String, nil]
52
+ optional :country_code, String, nil?: true
48
53
 
49
54
  # @!attribute is_ported
50
55
  #
51
56
  # @return [Boolean, nil]
52
- optional :is_ported, Sentdm::Internal::Type::Boolean, api_name: :isPorted, nil?: true
57
+ optional :is_ported, Sentdm::Internal::Type::Boolean, nil?: true
53
58
 
54
59
  # @!attribute is_valid
55
60
  #
56
61
  # @return [Boolean, nil]
57
- optional :is_valid, Sentdm::Internal::Type::Boolean, api_name: :isValid
62
+ optional :is_valid, Sentdm::Internal::Type::Boolean
58
63
 
59
64
  # @!attribute is_voip
60
65
  #
61
66
  # @return [Boolean, nil]
62
- optional :is_voip, Sentdm::Internal::Type::Boolean, api_name: :isVoip, nil?: true
67
+ optional :is_voip, Sentdm::Internal::Type::Boolean, nil?: true
63
68
 
64
69
  # @!attribute line_type
65
70
  #
66
71
  # @return [String, nil]
67
- optional :line_type, String, api_name: :lineType, nil?: true
72
+ optional :line_type, String, nil?: true
68
73
 
69
74
  # @!attribute mobile_country_code
70
75
  #
71
76
  # @return [String, nil]
72
- optional :mobile_country_code, String, api_name: :mobileCountryCode, nil?: true
77
+ optional :mobile_country_code, String, nil?: true
73
78
 
74
79
  # @!attribute mobile_network_code
75
80
  #
76
81
  # @return [String, nil]
77
- optional :mobile_network_code, String, api_name: :mobileNetworkCode, nil?: true
82
+ optional :mobile_network_code, String, nil?: true
78
83
 
79
84
  # @!attribute phone_number
80
85
  #
81
86
  # @return [String, nil]
82
- optional :phone_number, String, api_name: :phoneNumber
83
-
84
- # @!attribute provider
85
- #
86
- # @return [String, nil]
87
- optional :provider, String
87
+ optional :phone_number, String
88
88
 
89
- # @!method initialize(carrier_name: nil, is_ported: nil, is_valid: nil, is_voip: nil, line_type: nil, mobile_country_code: nil, mobile_network_code: nil, phone_number: nil, provider: nil)
89
+ # @!method initialize(carrier_name: nil, country_code: nil, is_ported: nil, is_valid: nil, is_voip: nil, line_type: nil, mobile_country_code: nil, mobile_network_code: nil, phone_number: nil)
90
90
  # The response data (null if error)
91
91
  #
92
92
  # @param carrier_name [String, nil]
93
+ # @param country_code [String, nil]
93
94
  # @param is_ported [Boolean, nil]
94
95
  # @param is_valid [Boolean]
95
96
  # @param is_voip [Boolean, nil]
@@ -97,7 +98,6 @@ module Sentdm
97
98
  # @param mobile_country_code [String, nil]
98
99
  # @param mobile_network_code [String, nil]
99
100
  # @param phone_number [String]
100
- # @param provider [String]
101
101
  end
102
102
  end
103
103
  end
@@ -0,0 +1,44 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class PaymentDetails < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute card_number
7
+ # Card number (digits only, 13–19 characters)
8
+ #
9
+ # @return [String]
10
+ required :card_number, String
11
+
12
+ # @!attribute cvc
13
+ # Card security code (3–4 digits)
14
+ #
15
+ # @return [String]
16
+ required :cvc, String
17
+
18
+ # @!attribute expiry
19
+ # Card expiry date in MM/YY format (e.g. "09/27")
20
+ #
21
+ # @return [String]
22
+ required :expiry, String
23
+
24
+ # @!attribute zip_code
25
+ # Billing ZIP / postal code associated with the card
26
+ #
27
+ # @return [String]
28
+ required :zip_code, String
29
+
30
+ # @!method initialize(card_number:, cvc:, expiry:, zip_code:)
31
+ # Payment card details for a profile. Accepted when billing_model is "profile" or
32
+ # "profile_and_organization". These details are not stored on our servers and will
33
+ # be forwarded to the payment processor.
34
+ #
35
+ # @param card_number [String] Card number (digits only, 13–19 characters)
36
+ #
37
+ # @param cvc [String] Card security code (3–4 digits)
38
+ #
39
+ # @param expiry [String] Card expiry date in MM/YY format (e.g. "09/27")
40
+ #
41
+ # @param zip_code [String] Billing ZIP / postal code associated with the card
42
+ end
43
+ end
44
+ end