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
@@ -7,10 +7,10 @@ module Sentdm
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute path_user_id
10
+ # @!attribute user_id
11
11
  #
12
12
  # @return [String]
13
- required :path_user_id, String
13
+ required :user_id, String
14
14
 
15
15
  # @!attribute role
16
16
  # User role: admin, billing, or developer (required)
@@ -18,38 +18,37 @@ module Sentdm
18
18
  # @return [String, nil]
19
19
  optional :role, String
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
- # @!attribute body_user_id
29
- # User ID from route parameter
28
+ # @!attribute idempotency_key
30
29
  #
31
30
  # @return [String, nil]
32
- optional :body_user_id, String, api_name: :user_id
31
+ optional :idempotency_key, String
33
32
 
34
- # @!attribute idempotency_key
33
+ # @!attribute x_profile_id
35
34
  #
36
35
  # @return [String, nil]
37
- optional :idempotency_key, String
36
+ optional :x_profile_id, String
38
37
 
39
- # @!method initialize(path_user_id:, role: nil, test_mode: nil, body_user_id: nil, idempotency_key: nil, request_options: {})
38
+ # @!method initialize(user_id:, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
40
39
  # Some parameter documentations has been truncated, see
41
40
  # {Sentdm::Models::UserUpdateRoleParams} for more details.
42
41
  #
43
- # @param path_user_id [String]
42
+ # @param user_id [String]
44
43
  #
45
44
  # @param role [String] User role: admin, billing, or developer (required)
46
45
  #
47
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
48
- #
49
- # @param body_user_id [String] User ID from route parameter
46
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
50
47
  #
51
48
  # @param idempotency_key [String]
52
49
  #
50
+ # @param x_profile_id [String]
51
+ #
53
52
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
54
53
  end
55
54
  end
@@ -27,12 +27,12 @@ module Sentdm
27
27
  # @return [Integer, nil]
28
28
  optional :retry_count, Integer
29
29
 
30
- # @!attribute test_mode
31
- # Test mode flag - when true, the operation is simulated without side effects
32
- # Useful for testing integrations without actual execution
30
+ # @!attribute sandbox
31
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
32
+ # for testing integrations without actual execution
33
33
  #
34
34
  # @return [Boolean, nil]
35
- optional :test_mode, Sentdm::Internal::Type::Boolean
35
+ optional :sandbox, Sentdm::Internal::Type::Boolean
36
36
 
37
37
  # @!attribute timeout_seconds
38
38
  #
@@ -44,7 +44,12 @@ module Sentdm
44
44
  # @return [String, nil]
45
45
  optional :idempotency_key, String
46
46
 
47
- # @!method initialize(display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, test_mode: nil, timeout_seconds: nil, idempotency_key: nil, request_options: {})
47
+ # @!attribute x_profile_id
48
+ #
49
+ # @return [String, nil]
50
+ optional :x_profile_id, String
51
+
52
+ # @!method initialize(display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
48
53
  # Some parameter documentations has been truncated, see
49
54
  # {Sentdm::Models::WebhookCreateParams} for more details.
50
55
  #
@@ -56,12 +61,14 @@ module Sentdm
56
61
  #
57
62
  # @param retry_count [Integer]
58
63
  #
59
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
64
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
60
65
  #
61
66
  # @param timeout_seconds [Integer]
62
67
  #
63
68
  # @param idempotency_key [String]
64
69
  #
70
+ # @param x_profile_id [String]
71
+ #
65
72
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
66
73
  end
67
74
  end
@@ -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
@@ -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
@@ -27,11 +27,17 @@ module Sentdm
27
27
  # @return [String, nil]
28
28
  optional :search, String, nil?: true
29
29
 
30
- # @!method initialize(id:, page:, page_size:, search: nil, request_options: {})
30
+ # @!attribute x_profile_id
31
+ #
32
+ # @return [String, nil]
33
+ optional :x_profile_id, String
34
+
35
+ # @!method initialize(id:, page:, page_size:, search: nil, x_profile_id: nil, request_options: {})
31
36
  # @param id [String]
32
37
  # @param page [Integer]
33
38
  # @param page_size [Integer]
34
39
  # @param search [String, nil]
40
+ # @param x_profile_id [String]
35
41
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
36
42
  end
37
43
  end
@@ -27,11 +27,17 @@ module Sentdm
27
27
  # @return [String, nil]
28
28
  optional :search, String, nil?: true
29
29
 
30
- # @!method initialize(page:, page_size:, is_active: nil, search: nil, request_options: {})
30
+ # @!attribute x_profile_id
31
+ #
32
+ # @return [String, nil]
33
+ optional :x_profile_id, String
34
+
35
+ # @!method initialize(page:, page_size:, is_active: nil, search: nil, x_profile_id: nil, request_options: {})
31
36
  # @param page [Integer]
32
37
  # @param page_size [Integer]
33
38
  # @param is_active [Boolean, nil]
34
39
  # @param search [String, nil]
40
+ # @param x_profile_id [String]
35
41
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
36
42
  end
37
43
  end
@@ -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
@@ -22,13 +22,19 @@ module Sentdm
22
22
  # @return [String, nil]
23
23
  optional :idempotency_key, String
24
24
 
25
- # @!method initialize(id:, body:, idempotency_key: nil, request_options: {})
25
+ # @!attribute x_profile_id
26
+ #
27
+ # @return [String, nil]
28
+ optional :x_profile_id, String
29
+
30
+ # @!method initialize(id:, body:, idempotency_key: nil, x_profile_id: nil, request_options: {})
26
31
  # @param id [String]
27
32
  # @param body [Sentdm::Models::WebhookRotateSecretParams::Body]
28
33
  # @param idempotency_key [String]
34
+ # @param x_profile_id [String]
29
35
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
30
36
 
31
- class Body < Sentdm::Models::MutationRequest
37
+ class Body < Sentdm::Models::MutationRequestBase
32
38
  # @!method initialize
33
39
  end
34
40
  end
@@ -17,19 +17,24 @@ module Sentdm
17
17
  # @return [String, nil]
18
18
  optional :event_type, String
19
19
 
20
- # @!attribute test_mode
21
- # Test mode flag - when true, the operation is simulated without side effects
22
- # Useful for testing integrations without actual execution
20
+ # @!attribute sandbox
21
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
22
+ # for testing integrations without actual execution
23
23
  #
24
24
  # @return [Boolean, nil]
25
- optional :test_mode, Sentdm::Internal::Type::Boolean
25
+ optional :sandbox, Sentdm::Internal::Type::Boolean
26
26
 
27
27
  # @!attribute idempotency_key
28
28
  #
29
29
  # @return [String, nil]
30
30
  optional :idempotency_key, String
31
31
 
32
- # @!method initialize(id:, event_type: nil, test_mode: nil, idempotency_key: nil, request_options: {})
32
+ # @!attribute x_profile_id
33
+ #
34
+ # @return [String, nil]
35
+ optional :x_profile_id, String
36
+
37
+ # @!method initialize(id:, event_type: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
33
38
  # Some parameter documentations has been truncated, see
34
39
  # {Sentdm::Models::WebhookTestParams} for more details.
35
40
  #
@@ -37,10 +42,12 @@ module Sentdm
37
42
  #
38
43
  # @param event_type [String]
39
44
  #
40
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
45
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
41
46
  #
42
47
  # @param idempotency_key [String]
43
48
  #
49
+ # @param x_profile_id [String]
50
+ #
44
51
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
45
52
  end
46
53
  end
@@ -17,19 +17,24 @@ module Sentdm
17
17
  # @return [Boolean, nil]
18
18
  optional :is_active, Sentdm::Internal::Type::Boolean
19
19
 
20
- # @!attribute test_mode
21
- # Test mode flag - when true, the operation is simulated without side effects
22
- # Useful for testing integrations without actual execution
20
+ # @!attribute sandbox
21
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
22
+ # for testing integrations without actual execution
23
23
  #
24
24
  # @return [Boolean, nil]
25
- optional :test_mode, Sentdm::Internal::Type::Boolean
25
+ optional :sandbox, Sentdm::Internal::Type::Boolean
26
26
 
27
27
  # @!attribute idempotency_key
28
28
  #
29
29
  # @return [String, nil]
30
30
  optional :idempotency_key, String
31
31
 
32
- # @!method initialize(id:, is_active: nil, test_mode: nil, idempotency_key: nil, request_options: {})
32
+ # @!attribute x_profile_id
33
+ #
34
+ # @return [String, nil]
35
+ optional :x_profile_id, String
36
+
37
+ # @!method initialize(id:, is_active: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
33
38
  # Some parameter documentations has been truncated, see
34
39
  # {Sentdm::Models::WebhookToggleStatusParams} for more details.
35
40
  #
@@ -37,10 +42,12 @@ module Sentdm
37
42
  #
38
43
  # @param is_active [Boolean]
39
44
  #
40
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
45
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
41
46
  #
42
47
  # @param idempotency_key [String]
43
48
  #
49
+ # @param x_profile_id [String]
50
+ #
44
51
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
45
52
  end
46
53
  end
@@ -32,12 +32,12 @@ module Sentdm
32
32
  # @return [Integer, nil]
33
33
  optional :retry_count, Integer
34
34
 
35
- # @!attribute test_mode
36
- # Test mode flag - when true, the operation is simulated without side effects
37
- # Useful for testing integrations without actual execution
35
+ # @!attribute sandbox
36
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
37
+ # for testing integrations without actual execution
38
38
  #
39
39
  # @return [Boolean, nil]
40
- optional :test_mode, Sentdm::Internal::Type::Boolean
40
+ optional :sandbox, Sentdm::Internal::Type::Boolean
41
41
 
42
42
  # @!attribute timeout_seconds
43
43
  #
@@ -49,7 +49,12 @@ module Sentdm
49
49
  # @return [String, nil]
50
50
  optional :idempotency_key, String
51
51
 
52
- # @!method initialize(id:, display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, test_mode: nil, timeout_seconds: nil, idempotency_key: nil, request_options: {})
52
+ # @!attribute x_profile_id
53
+ #
54
+ # @return [String, nil]
55
+ optional :x_profile_id, String
56
+
57
+ # @!method initialize(id:, display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
53
58
  # Some parameter documentations has been truncated, see
54
59
  # {Sentdm::Models::WebhookUpdateParams} for more details.
55
60
  #
@@ -63,12 +68,14 @@ module Sentdm
63
68
  #
64
69
  # @param retry_count [Integer]
65
70
  #
66
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
71
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
67
72
  #
68
73
  # @param timeout_seconds [Integer]
69
74
  #
70
75
  # @param idempotency_key [String]
71
76
  #
77
+ # @param x_profile_id [String]
78
+ #
72
79
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
73
80
  end
74
81
  end
data/lib/sentdm/models.rb CHANGED
@@ -43,9 +43,7 @@ module Sentdm
43
43
 
44
44
  APIMeta = Sentdm::Models::APIMeta
45
45
 
46
- APIResponseBrandWithKYC = Sentdm::Models::APIResponseBrandWithKYC
47
-
48
- APIResponseContact = Sentdm::Models::APIResponseContact
46
+ APIResponseOfContact = Sentdm::Models::APIResponseOfContact
49
47
 
50
48
  APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
51
49
 
@@ -55,21 +53,11 @@ module Sentdm
55
53
 
56
54
  APIResponseWebhook = Sentdm::Models::APIResponseWebhook
57
55
 
58
- BrandCreateParams = Sentdm::Models::BrandCreateParams
59
-
60
- BrandData = Sentdm::Models::BrandData
61
-
62
- BrandDeleteParams = Sentdm::Models::BrandDeleteParams
63
-
64
- BrandListParams = Sentdm::Models::BrandListParams
65
-
66
- Brands = Sentdm::Models::Brands
56
+ BaseDto = Sentdm::Models::BaseDto
67
57
 
68
- BrandUpdateParams = Sentdm::Models::BrandUpdateParams
58
+ BillingContactInfo = Sentdm::Models::BillingContactInfo
69
59
 
70
- BrandWithKYC = Sentdm::Models::BrandWithKYC
71
-
72
- Contact = Sentdm::Models::Contact
60
+ BrandsBrandData = Sentdm::Models::BrandsBrandData
73
61
 
74
62
  ContactCreateParams = Sentdm::Models::ContactCreateParams
75
63
 
@@ -77,14 +65,14 @@ module Sentdm
77
65
 
78
66
  ContactListParams = Sentdm::Models::ContactListParams
79
67
 
68
+ ContactResponse = Sentdm::Models::ContactResponse
69
+
80
70
  ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
81
71
 
82
72
  ContactUpdateParams = Sentdm::Models::ContactUpdateParams
83
73
 
84
74
  DestinationCountry = Sentdm::Models::DestinationCountry
85
75
 
86
- LookupRetrievePhoneInfoParams = Sentdm::Models::LookupRetrievePhoneInfoParams
87
-
88
76
  MeRetrieveParams = Sentdm::Models::MeRetrieveParams
89
77
 
90
78
  MessageRetrieveActivitiesParams = Sentdm::Models::MessageRetrieveActivitiesParams
@@ -93,11 +81,15 @@ module Sentdm
93
81
 
94
82
  MessageSendParams = Sentdm::Models::MessageSendParams
95
83
 
96
- MutationRequest = Sentdm::Models::MutationRequest
84
+ MutationRequestBase = Sentdm::Models::MutationRequestBase
85
+
86
+ NumberLookupParams = Sentdm::Models::NumberLookupParams
97
87
 
98
88
  PaginationMeta = Sentdm::Models::PaginationMeta
99
89
 
100
- ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
90
+ PaymentDetails = Sentdm::Models::PaymentDetails
91
+
92
+ ProfileCompleteSetupParams = Sentdm::Models::ProfileCompleteSetupParams
101
93
 
102
94
  ProfileCreateParams = Sentdm::Models::ProfileCreateParams
103
95
 
@@ -109,28 +101,12 @@ module Sentdm
109
101
 
110
102
  ProfileRetrieveParams = Sentdm::Models::ProfileRetrieveParams
111
103
 
104
+ Profiles = Sentdm::Models::Profiles
105
+
112
106
  ProfileSettings = Sentdm::Models::ProfileSettings
113
107
 
114
108
  ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
115
109
 
116
- SentDmServicesCommonContractsPocOsAuthenticationConfig =
117
- Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig
118
-
119
- SentDmServicesCommonContractsPocOsTemplateBody =
120
- Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody
121
-
122
- SentDmServicesCommonContractsPocOsTemplateButton =
123
- Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton
124
-
125
- SentDmServicesCommonContractsPocOsTemplateButtonProps =
126
- Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps
127
-
128
- SentDmServicesCommonContractsPocOsTemplateFooter =
129
- Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter
130
-
131
- SentDmServicesCommonContractsPocOsTemplateHeader =
132
- Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader
133
-
134
110
  TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
135
111
 
136
112
  TcrVertical = Sentdm::Models::TcrVertical
@@ -10,51 +10,60 @@ module Sentdm
10
10
  # Creates a new contact by phone number and associates it with the authenticated
11
11
  # customer.
12
12
  #
13
- # @overload create(phone_number: nil, test_mode: nil, idempotency_key: nil, request_options: {})
13
+ # @overload create(phone_number: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
14
14
  #
15
15
  # @param phone_number [String] Body param: Phone number of the contact to create
16
16
  #
17
- # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
17
+ # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
18
18
  #
19
19
  # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
20
20
  #
21
+ # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
22
+ #
21
23
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
22
24
  #
23
- # @return [Sentdm::Models::APIResponseContact]
25
+ # @return [Sentdm::Models::APIResponseOfContact]
24
26
  #
25
27
  # @see Sentdm::Models::ContactCreateParams
26
28
  def create(params = {})
27
29
  parsed, options = Sentdm::ContactCreateParams.dump_request(params)
28
- header_params = {idempotency_key: "idempotency-key"}
30
+ header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
29
31
  @client.request(
30
32
  method: :post,
31
33
  path: "v3/contacts",
32
34
  headers: parsed.slice(*header_params.keys).transform_keys(header_params),
33
35
  body: parsed.except(*header_params.keys),
34
- model: Sentdm::APIResponseContact,
36
+ model: Sentdm::APIResponseOfContact,
35
37
  options: options
36
38
  )
37
39
  end
38
40
 
41
+ # Some parameter documentations has been truncated, see
42
+ # {Sentdm::Models::ContactRetrieveParams} for more details.
43
+ #
39
44
  # Retrieves a specific contact by their unique identifier. Returns detailed
40
45
  # contact information including phone formats, available channels, and opt-out
41
46
  # status.
42
47
  #
43
- # @overload retrieve(id, request_options: {})
48
+ # @overload retrieve(id, x_profile_id: nil, request_options: {})
44
49
  #
45
50
  # @param id [String] Contact ID from route parameter
46
51
  #
52
+ # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
53
+ #
47
54
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
48
55
  #
49
- # @return [Sentdm::Models::APIResponseContact]
56
+ # @return [Sentdm::Models::APIResponseOfContact]
50
57
  #
51
58
  # @see Sentdm::Models::ContactRetrieveParams
52
59
  def retrieve(id, params = {})
60
+ parsed, options = Sentdm::ContactRetrieveParams.dump_request(params)
53
61
  @client.request(
54
62
  method: :get,
55
63
  path: ["v3/contacts/%1$s", id],
56
- model: Sentdm::APIResponseContact,
57
- options: params[:request_options]
64
+ headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
65
+ model: Sentdm::APIResponseOfContact,
66
+ options: options
58
67
  )
59
68
  end
60
69
 
@@ -64,7 +73,7 @@ module Sentdm
64
73
  # Updates a contact's default channel and/or opt-out status. Inherited contacts
65
74
  # cannot be updated.
66
75
  #
67
- # @overload update(id, default_channel: nil, opt_out: nil, test_mode: nil, idempotency_key: nil, request_options: {})
76
+ # @overload update(id, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
68
77
  #
69
78
  # @param id [String] Path param: Contact ID from route parameter
70
79
  #
@@ -72,42 +81,49 @@ module Sentdm
72
81
  #
73
82
  # @param opt_out [Boolean, nil] Body param: Whether the contact has opted out of messaging
74
83
  #
75
- # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
84
+ # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
76
85
  #
77
86
  # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
78
87
  #
88
+ # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
89
+ #
79
90
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
80
91
  #
81
- # @return [Sentdm::Models::APIResponseContact]
92
+ # @return [Sentdm::Models::APIResponseOfContact]
82
93
  #
83
94
  # @see Sentdm::Models::ContactUpdateParams
84
95
  def update(id, params = {})
85
96
  parsed, options = Sentdm::ContactUpdateParams.dump_request(params)
86
- header_params = {idempotency_key: "idempotency-key"}
97
+ header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
87
98
  @client.request(
88
99
  method: :patch,
89
100
  path: ["v3/contacts/%1$s", id],
90
101
  headers: parsed.slice(*header_params.keys).transform_keys(header_params),
91
102
  body: parsed.except(*header_params.keys),
92
- model: Sentdm::APIResponseContact,
103
+ model: Sentdm::APIResponseOfContact,
93
104
  options: options
94
105
  )
95
106
  end
96
107
 
108
+ # Some parameter documentations has been truncated, see
109
+ # {Sentdm::Models::ContactListParams} for more details.
110
+ #
97
111
  # Retrieves a paginated list of contacts for the authenticated customer. Supports
98
112
  # filtering by search term, channel, or phone number.
99
113
  #
100
- # @overload list(page:, page_size:, channel: nil, phone: nil, search: nil, request_options: {})
114
+ # @overload list(page:, page_size:, channel: nil, phone: nil, search: nil, x_profile_id: nil, request_options: {})
115
+ #
116
+ # @param page [Integer] Query param: Page number (1-indexed)
101
117
  #
102
- # @param page [Integer] Page number (1-indexed)
118
+ # @param page_size [Integer] Query param: Number of items per page
103
119
  #
104
- # @param page_size [Integer]
120
+ # @param channel [String, nil] Query param: Optional channel filter (sms, whatsapp)
105
121
  #
106
- # @param channel [String, nil] Optional channel filter (sms, whatsapp)
122
+ # @param phone [String, nil] Query param: Optional phone number filter (alternative to list view)
107
123
  #
108
- # @param phone [String, nil] Optional phone number filter (alternative to list view)
124
+ # @param search [String, nil] Query param: Optional search term for filtering contacts
109
125
  #
110
- # @param search [String, nil] Optional search term for filtering contacts
126
+ # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
111
127
  #
112
128
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
113
129
  #
@@ -115,25 +131,32 @@ module Sentdm
115
131
  #
116
132
  # @see Sentdm::Models::ContactListParams
117
133
  def list(params)
134
+ query_params = [:page, :page_size, :channel, :phone, :search]
118
135
  parsed, options = Sentdm::ContactListParams.dump_request(params)
119
- query = Sentdm::Internal::Util.encode_query_params(parsed)
136
+ query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
120
137
  @client.request(
121
138
  method: :get,
122
139
  path: "v3/contacts",
123
- query: query.transform_keys(page_size: "pageSize"),
140
+ query: query,
141
+ headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
124
142
  model: Sentdm::Models::ContactListResponse,
125
143
  options: options
126
144
  )
127
145
  end
128
146
 
147
+ # Some parameter documentations has been truncated, see
148
+ # {Sentdm::Models::ContactDeleteParams} for more details.
149
+ #
129
150
  # Dissociates a contact from the authenticated customer. Inherited contacts cannot
130
151
  # be deleted.
131
152
  #
132
- # @overload delete(id, body:, request_options: {})
153
+ # @overload delete(id, body:, x_profile_id: nil, request_options: {})
133
154
  #
134
- # @param id [String] Contact ID from route parameter
155
+ # @param id [String] Path param: Contact ID from route parameter
156
+ #
157
+ # @param body [Sentdm::Models::ContactDeleteParams::Body] Body param: Request to delete/dissociate a contact
135
158
  #
136
- # @param body [Sentdm::Models::ContactDeleteParams::Body] Request to delete/dissociate a contact
159
+ # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
137
160
  #
138
161
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
139
162
  #
@@ -145,7 +168,7 @@ module Sentdm
145
168
  @client.request(
146
169
  method: :delete,
147
170
  path: ["v3/contacts/%1$s", id],
148
- headers: {"content-type" => "*/*"},
171
+ headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
149
172
  body: parsed[:body],
150
173
  model: NilClass,
151
174
  options: options