sentdm 0.18.0 → 0.19.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 (291) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -0
  3. data/README.md +1 -31
  4. data/lib/sentdm/internal/transport/base_client.rb +2 -0
  5. data/lib/sentdm/internal/type/base_model.rb +5 -5
  6. data/lib/sentdm/internal/type/enum.rb +0 -25
  7. data/lib/sentdm/models/contact_create_response.rb +236 -0
  8. data/lib/sentdm/models/contact_delete_params.rb +16 -2
  9. data/lib/sentdm/models/contact_list_response.rb +278 -12
  10. data/lib/sentdm/models/contact_retrieve_response.rb +236 -0
  11. data/lib/sentdm/models/contact_update_params.rb +4 -16
  12. data/lib/sentdm/models/contact_update_response.rb +236 -0
  13. data/lib/sentdm/models/me_retrieve_response.rb +204 -12
  14. data/lib/sentdm/models/message_retrieve_activities_response.rb +74 -6
  15. data/lib/sentdm/models/message_retrieve_status_response.rb +87 -7
  16. data/lib/sentdm/models/message_send_params.rb +2 -2
  17. data/lib/sentdm/models/message_send_response.rb +74 -6
  18. data/lib/sentdm/models/number_lookup_response.rb +74 -6
  19. data/lib/sentdm/models/profile_complete_response.rb +74 -6
  20. data/lib/sentdm/models/profile_create_params.rb +423 -9
  21. data/lib/sentdm/models/profile_create_response.rb +781 -0
  22. data/lib/sentdm/models/profile_delete_params.rb +16 -2
  23. data/lib/sentdm/models/profile_list_response.rb +753 -9
  24. data/lib/sentdm/models/profile_retrieve_response.rb +783 -0
  25. data/lib/sentdm/models/profile_update_params.rb +423 -9
  26. data/lib/sentdm/models/profile_update_response.rb +781 -0
  27. data/lib/sentdm/models/profiles/campaign_create_params.rb +165 -3
  28. data/lib/sentdm/models/profiles/campaign_create_response.rb +459 -0
  29. data/lib/sentdm/models/profiles/campaign_delete_params.rb +17 -2
  30. data/lib/sentdm/models/profiles/campaign_list_response.rb +420 -9
  31. data/lib/sentdm/models/profiles/campaign_update_params.rb +165 -3
  32. data/lib/sentdm/models/profiles/campaign_update_response.rb +459 -0
  33. data/lib/sentdm/models/template_create_params.rb +889 -3
  34. data/lib/sentdm/models/template_create_response.rb +197 -0
  35. data/lib/sentdm/models/template_list_response.rb +242 -12
  36. data/lib/sentdm/models/template_retrieve_response.rb +197 -0
  37. data/lib/sentdm/models/template_update_params.rb +889 -3
  38. data/lib/sentdm/models/template_update_response.rb +197 -0
  39. data/lib/sentdm/models/user_invite_response.rb +189 -0
  40. data/lib/sentdm/models/user_list_response.rb +154 -9
  41. data/lib/sentdm/models/user_remove_params.rb +16 -2
  42. data/lib/sentdm/models/user_retrieve_response.rb +189 -0
  43. data/lib/sentdm/models/user_update_role_response.rb +189 -0
  44. data/lib/sentdm/models/webhook_create_response.rb +204 -0
  45. data/lib/sentdm/models/webhook_list_event_types_response.rb +118 -9
  46. data/lib/sentdm/models/webhook_list_events_response.rb +153 -9
  47. data/lib/sentdm/models/webhook_list_response.rb +247 -12
  48. data/lib/sentdm/models/webhook_retrieve_response.rb +204 -0
  49. data/lib/sentdm/models/webhook_rotate_secret_params.rb +17 -2
  50. data/lib/sentdm/models/webhook_rotate_secret_response.rb +74 -6
  51. data/lib/sentdm/models/webhook_test_response.rb +74 -6
  52. data/lib/sentdm/models/webhook_toggle_status_response.rb +204 -0
  53. data/lib/sentdm/models/webhook_update_response.rb +204 -0
  54. data/lib/sentdm/models.rb +0 -77
  55. data/lib/sentdm/resources/contacts.rb +8 -10
  56. data/lib/sentdm/resources/profiles/campaigns.rb +6 -6
  57. data/lib/sentdm/resources/profiles.rb +12 -12
  58. data/lib/sentdm/resources/templates.rb +8 -8
  59. data/lib/sentdm/resources/users.rb +6 -6
  60. data/lib/sentdm/resources/webhooks.rb +8 -8
  61. data/lib/sentdm/version.rb +1 -1
  62. data/lib/sentdm.rb +18 -40
  63. data/rbi/sentdm/models/contact_create_response.rbi +390 -0
  64. data/rbi/sentdm/models/contact_delete_params.rbi +19 -2
  65. data/rbi/sentdm/models/contact_list_response.rbi +505 -16
  66. data/rbi/sentdm/models/contact_retrieve_response.rbi +392 -0
  67. data/rbi/sentdm/models/contact_update_params.rbi +4 -20
  68. data/rbi/sentdm/models/contact_update_response.rbi +390 -0
  69. data/rbi/sentdm/models/me_retrieve_response.rbi +335 -16
  70. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +154 -8
  71. data/rbi/sentdm/models/message_retrieve_status_response.rbi +171 -11
  72. data/rbi/sentdm/models/message_send_params.rbi +4 -4
  73. data/rbi/sentdm/models/message_send_response.rbi +135 -8
  74. data/rbi/sentdm/models/number_lookup_response.rbi +135 -8
  75. data/rbi/sentdm/models/profile_complete_response.rbi +137 -8
  76. data/rbi/sentdm/models/profile_create_params.rbi +810 -12
  77. data/rbi/sentdm/models/profile_create_response.rbi +1439 -0
  78. data/rbi/sentdm/models/profile_delete_params.rbi +19 -2
  79. data/rbi/sentdm/models/profile_list_response.rbi +1400 -14
  80. data/rbi/sentdm/models/profile_retrieve_response.rbi +1443 -0
  81. data/rbi/sentdm/models/profile_update_params.rbi +810 -12
  82. data/rbi/sentdm/models/profile_update_response.rbi +1439 -0
  83. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +289 -4
  84. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +814 -0
  85. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +14 -1
  86. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +733 -11
  87. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +289 -4
  88. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +814 -0
  89. data/rbi/sentdm/models/template_create_params.rbi +1701 -4
  90. data/rbi/sentdm/models/template_create_response.rbi +339 -0
  91. data/rbi/sentdm/models/template_list_response.rbi +454 -16
  92. data/rbi/sentdm/models/template_retrieve_response.rbi +345 -0
  93. data/rbi/sentdm/models/template_update_params.rbi +1701 -4
  94. data/rbi/sentdm/models/template_update_response.rbi +339 -0
  95. data/rbi/sentdm/models/user_invite_response.rbi +323 -0
  96. data/rbi/sentdm/models/user_list_response.rbi +271 -14
  97. data/rbi/sentdm/models/user_remove_params.rbi +19 -2
  98. data/rbi/sentdm/models/user_retrieve_response.rbi +323 -0
  99. data/rbi/sentdm/models/user_update_role_response.rbi +328 -0
  100. data/rbi/sentdm/models/webhook_create_response.rbi +348 -0
  101. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +247 -12
  102. data/rbi/sentdm/models/webhook_list_events_response.rbi +314 -12
  103. data/rbi/sentdm/models/webhook_list_response.rbi +462 -16
  104. data/rbi/sentdm/models/webhook_retrieve_response.rbi +350 -0
  105. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +14 -1
  106. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +148 -8
  107. data/rbi/sentdm/models/webhook_test_response.rbi +135 -8
  108. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +366 -0
  109. data/rbi/sentdm/models/webhook_update_response.rbi +348 -0
  110. data/rbi/sentdm/models.rbi +0 -77
  111. data/rbi/sentdm/resources/contacts.rbi +5 -12
  112. data/rbi/sentdm/resources/messages.rbi +2 -2
  113. data/rbi/sentdm/resources/profiles/campaigns.rbi +4 -4
  114. data/rbi/sentdm/resources/profiles.rbi +13 -9
  115. data/rbi/sentdm/resources/templates.rbi +6 -5
  116. data/rbi/sentdm/resources/users.rbi +3 -3
  117. data/rbi/sentdm/resources/webhooks.rbi +4 -4
  118. data/sig/sentdm/models/contact_create_response.rbs +209 -0
  119. data/sig/sentdm/models/contact_delete_params.rbs +10 -6
  120. data/sig/sentdm/models/contact_list_response.rbs +256 -20
  121. data/sig/sentdm/models/contact_retrieve_response.rbs +209 -0
  122. data/sig/sentdm/models/contact_update_params.rbs +0 -5
  123. data/sig/sentdm/models/contact_update_response.rbs +209 -0
  124. data/sig/sentdm/models/me_retrieve_response.rbs +176 -18
  125. data/sig/sentdm/models/message_retrieve_activities_response.rbs +71 -9
  126. data/sig/sentdm/models/message_retrieve_status_response.rbs +95 -13
  127. data/sig/sentdm/models/message_send_response.rbs +71 -9
  128. data/sig/sentdm/models/number_lookup_response.rbs +71 -9
  129. data/sig/sentdm/models/profile_complete_response.rbs +71 -9
  130. data/sig/sentdm/models/profile_create_params.rbs +363 -12
  131. data/sig/sentdm/models/profile_create_response.rbs +662 -0
  132. data/sig/sentdm/models/profile_delete_params.rbs +10 -6
  133. data/sig/sentdm/models/profile_list_response.rbs +645 -15
  134. data/sig/sentdm/models/profile_retrieve_response.rbs +662 -0
  135. data/sig/sentdm/models/profile_update_params.rbs +363 -12
  136. data/sig/sentdm/models/profile_update_response.rbs +662 -0
  137. data/sig/sentdm/models/profiles/campaign_create_params.rbs +138 -4
  138. data/sig/sentdm/models/profiles/campaign_create_response.rbs +424 -0
  139. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +15 -8
  140. data/sig/sentdm/models/profiles/campaign_list_response.rbs +396 -13
  141. data/sig/sentdm/models/profiles/campaign_update_params.rbs +138 -4
  142. data/sig/sentdm/models/profiles/campaign_update_response.rbs +424 -0
  143. data/sig/sentdm/models/template_create_params.rbs +853 -6
  144. data/sig/sentdm/models/template_create_response.rbs +177 -0
  145. data/sig/sentdm/models/template_list_response.rbs +225 -19
  146. data/sig/sentdm/models/template_retrieve_response.rbs +177 -0
  147. data/sig/sentdm/models/template_update_params.rbs +851 -4
  148. data/sig/sentdm/models/template_update_response.rbs +177 -0
  149. data/sig/sentdm/models/user_invite_response.rbs +170 -0
  150. data/sig/sentdm/models/user_list_response.rbs +151 -15
  151. data/sig/sentdm/models/user_remove_params.rbs +10 -6
  152. data/sig/sentdm/models/user_retrieve_response.rbs +170 -0
  153. data/sig/sentdm/models/user_update_role_response.rbs +170 -0
  154. data/sig/sentdm/models/webhook_create_response.rbs +201 -0
  155. data/sig/sentdm/models/webhook_list_event_types_response.rbs +130 -15
  156. data/sig/sentdm/models/webhook_list_events_response.rbs +142 -14
  157. data/sig/sentdm/models/webhook_list_response.rbs +248 -20
  158. data/sig/sentdm/models/webhook_retrieve_response.rbs +201 -0
  159. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +17 -8
  160. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +71 -9
  161. data/sig/sentdm/models/webhook_test_response.rbs +71 -9
  162. data/sig/sentdm/models/webhook_toggle_status_response.rbs +201 -0
  163. data/sig/sentdm/models/webhook_update_response.rbs +201 -0
  164. data/sig/sentdm/models.rbs +0 -68
  165. data/sig/sentdm/resources/contacts.rbs +3 -4
  166. data/sig/sentdm/resources/profiles/campaigns.rbs +4 -4
  167. data/sig/sentdm/resources/profiles.rbs +9 -9
  168. data/sig/sentdm/resources/templates.rbs +5 -5
  169. data/sig/sentdm/resources/users.rbs +3 -3
  170. data/sig/sentdm/resources/webhooks.rbs +4 -4
  171. metadata +56 -122
  172. data/lib/sentdm/models/api_meta.rb +0 -34
  173. data/lib/sentdm/models/api_response_of_contact.rb +0 -46
  174. data/lib/sentdm/models/api_response_of_profile_detail.rb +0 -43
  175. data/lib/sentdm/models/api_response_of_user.rb +0 -43
  176. data/lib/sentdm/models/api_response_template.rb +0 -43
  177. data/lib/sentdm/models/api_response_webhook.rb +0 -43
  178. data/lib/sentdm/models/billing_contact_info.rb +0 -47
  179. data/lib/sentdm/models/brands_brand_data.rb +0 -38
  180. data/lib/sentdm/models/contact_response.rb +0 -136
  181. data/lib/sentdm/models/destination_country.rb +0 -21
  182. data/lib/sentdm/models/error_detail.rb +0 -42
  183. data/lib/sentdm/models/mutation_request.rb +0 -20
  184. data/lib/sentdm/models/pagination_meta.rb +0 -80
  185. data/lib/sentdm/models/payment_details.rb +0 -44
  186. data/lib/sentdm/models/profile_detail.rb +0 -605
  187. data/lib/sentdm/models/profile_settings.rb +0 -66
  188. data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +0 -45
  189. data/lib/sentdm/models/profiles/base_dto.rb +0 -32
  190. data/lib/sentdm/models/profiles/campaign_data.rb +0 -123
  191. data/lib/sentdm/models/profiles/messaging_use_case_us.rb +0 -28
  192. data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +0 -29
  193. data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +0 -236
  194. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +0 -34
  195. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +0 -40
  196. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +0 -38
  197. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +0 -81
  198. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +0 -34
  199. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +0 -39
  200. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +0 -116
  201. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +0 -75
  202. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +0 -58
  203. data/lib/sentdm/models/tcr_brand_relationship.rb +0 -18
  204. data/lib/sentdm/models/tcr_vertical.rb +0 -36
  205. data/lib/sentdm/models/template.rb +0 -90
  206. data/lib/sentdm/models/template_body_content.rb +0 -27
  207. data/lib/sentdm/models/template_definition.rb +0 -66
  208. data/lib/sentdm/models/template_variable.rb +0 -80
  209. data/lib/sentdm/models/user_response.rb +0 -82
  210. data/lib/sentdm/models/webhook_event_type.rb +0 -45
  211. data/lib/sentdm/models/webhook_response.rb +0 -95
  212. data/rbi/sentdm/models/api_meta.rbi +0 -55
  213. data/rbi/sentdm/models/api_response_of_contact.rbi +0 -74
  214. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +0 -74
  215. data/rbi/sentdm/models/api_response_of_user.rbi +0 -74
  216. data/rbi/sentdm/models/api_response_template.rbi +0 -74
  217. data/rbi/sentdm/models/api_response_webhook.rbi +0 -74
  218. data/rbi/sentdm/models/billing_contact_info.rbi +0 -65
  219. data/rbi/sentdm/models/brands_brand_data.rbi +0 -104
  220. data/rbi/sentdm/models/contact_response.rbi +0 -195
  221. data/rbi/sentdm/models/destination_country.rbi +0 -32
  222. data/rbi/sentdm/models/error_detail.rbi +0 -66
  223. data/rbi/sentdm/models/mutation_request.rbi +0 -32
  224. data/rbi/sentdm/models/pagination_meta.rbi +0 -135
  225. data/rbi/sentdm/models/payment_details.rbi +0 -59
  226. data/rbi/sentdm/models/profile_detail.rbi +0 -874
  227. data/rbi/sentdm/models/profile_settings.rbi +0 -86
  228. data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +0 -83
  229. data/rbi/sentdm/models/profiles/base_dto.rbi +0 -53
  230. data/rbi/sentdm/models/profiles/campaign_data.rbi +0 -148
  231. data/rbi/sentdm/models/profiles/messaging_use_case_us.rbi +0 -73
  232. data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +0 -51
  233. data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +0 -410
  234. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +0 -56
  235. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +0 -76
  236. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +0 -72
  237. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +0 -104
  238. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +0 -57
  239. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +0 -59
  240. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +0 -180
  241. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +0 -95
  242. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +0 -81
  243. data/rbi/sentdm/models/tcr_brand_relationship.rbi +0 -30
  244. data/rbi/sentdm/models/tcr_vertical.rbi +0 -41
  245. data/rbi/sentdm/models/template.rbi +0 -129
  246. data/rbi/sentdm/models/template_body_content.rbi +0 -43
  247. data/rbi/sentdm/models/template_definition.rbi +0 -164
  248. data/rbi/sentdm/models/template_variable.rbi +0 -120
  249. data/rbi/sentdm/models/user_response.rbi +0 -118
  250. data/rbi/sentdm/models/webhook_event_type.rbi +0 -74
  251. data/rbi/sentdm/models/webhook_response.rbi +0 -140
  252. data/sig/sentdm/models/api_meta.rbs +0 -27
  253. data/sig/sentdm/models/api_response_of_contact.rbs +0 -39
  254. data/sig/sentdm/models/api_response_of_profile_detail.rbs +0 -39
  255. data/sig/sentdm/models/api_response_of_user.rbs +0 -39
  256. data/sig/sentdm/models/api_response_template.rbs +0 -39
  257. data/sig/sentdm/models/api_response_webhook.rbs +0 -39
  258. data/sig/sentdm/models/billing_contact_info.rbs +0 -30
  259. data/sig/sentdm/models/brands_brand_data.rbs +0 -30
  260. data/sig/sentdm/models/contact_response.rbs +0 -116
  261. data/sig/sentdm/models/destination_country.rbs +0 -19
  262. data/sig/sentdm/models/error_detail.rbs +0 -39
  263. data/sig/sentdm/models/mutation_request.rbs +0 -15
  264. data/sig/sentdm/models/pagination_meta.rbs +0 -67
  265. data/sig/sentdm/models/payment_details.rbs +0 -30
  266. data/sig/sentdm/models/profile_detail.rbs +0 -474
  267. data/sig/sentdm/models/profile_settings.rbs +0 -50
  268. data/sig/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbs +0 -41
  269. data/sig/sentdm/models/profiles/base_dto.rbs +0 -27
  270. data/sig/sentdm/models/profiles/campaign_data.rbs +0 -82
  271. data/sig/sentdm/models/profiles/messaging_use_case_us.rbs +0 -40
  272. data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +0 -27
  273. data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +0 -285
  274. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +0 -24
  275. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +0 -30
  276. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +0 -32
  277. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +0 -75
  278. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +0 -30
  279. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +0 -30
  280. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbs +0 -89
  281. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbs +0 -55
  282. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbs +0 -45
  283. data/sig/sentdm/models/tcr_brand_relationship.rbs +0 -22
  284. data/sig/sentdm/models/tcr_vertical.rbs +0 -58
  285. data/sig/sentdm/models/template.rbs +0 -79
  286. data/sig/sentdm/models/template_body_content.rbs +0 -30
  287. data/sig/sentdm/models/template_definition.rbs +0 -45
  288. data/sig/sentdm/models/template_variable.rbs +0 -84
  289. data/sig/sentdm/models/user_response.rbs +0 -72
  290. data/sig/sentdm/models/webhook_event_type.rbs +0 -51
  291. data/sig/sentdm/models/webhook_response.rbs +0 -103
@@ -0,0 +1,783 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ # @see Sentdm::Resources::Profiles#retrieve
6
+ class ProfileRetrieveResponse < Sentdm::Internal::Type::BaseModel
7
+ # @!attribute data
8
+ # Detailed profile response for v3 API
9
+ #
10
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Data, nil]
11
+ optional :data, -> { Sentdm::Models::ProfileRetrieveResponse::Data }, nil?: true
12
+
13
+ # @!attribute error
14
+ # Error information
15
+ #
16
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Error, nil]
17
+ optional :error, -> { Sentdm::Models::ProfileRetrieveResponse::Error }, nil?: true
18
+
19
+ # @!attribute meta
20
+ # Request and response metadata
21
+ #
22
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Meta, nil]
23
+ optional :meta, -> { Sentdm::Models::ProfileRetrieveResponse::Meta }
24
+
25
+ # @!attribute success
26
+ # Indicates whether the request was successful
27
+ #
28
+ # @return [Boolean, nil]
29
+ optional :success, Sentdm::Internal::Type::Boolean
30
+
31
+ # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
+ # Standard API response envelope for all v3 endpoints
33
+ #
34
+ # @param data [Sentdm::Models::ProfileRetrieveResponse::Data, nil] Detailed profile response for v3 API
35
+ #
36
+ # @param error [Sentdm::Models::ProfileRetrieveResponse::Error, nil] Error information
37
+ #
38
+ # @param meta [Sentdm::Models::ProfileRetrieveResponse::Meta] Request and response metadata
39
+ #
40
+ # @param success [Boolean] Indicates whether the request was successful
41
+
42
+ # @see Sentdm::Models::ProfileRetrieveResponse#data
43
+ class Data < Sentdm::Internal::Type::BaseModel
44
+ # @!attribute id
45
+ # Profile unique identifier
46
+ #
47
+ # @return [String, nil]
48
+ optional :id, String
49
+
50
+ # @!attribute allow_contact_sharing
51
+ # Whether contacts are shared across profiles in the organization
52
+ #
53
+ # @return [Boolean, nil]
54
+ optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean
55
+
56
+ # @!attribute allow_number_change_during_onboarding
57
+ # Whether number changes are allowed during onboarding
58
+ #
59
+ # @return [Boolean, nil]
60
+ optional :allow_number_change_during_onboarding, Sentdm::Internal::Type::Boolean, nil?: true
61
+
62
+ # @!attribute allow_template_sharing
63
+ # Whether templates are shared across profiles in the organization
64
+ #
65
+ # @return [Boolean, nil]
66
+ optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
67
+
68
+ # @!attribute billing_contact
69
+ # Billing contact info returned in profile responses
70
+ #
71
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact, nil]
72
+ optional :billing_contact,
73
+ -> { Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact },
74
+ nil?: true
75
+
76
+ # @!attribute billing_model
77
+ # Billing model: profile, organization, or profile_and_organization
78
+ #
79
+ # @return [String, nil]
80
+ optional :billing_model, String
81
+
82
+ # @!attribute brand
83
+ # Brand response with nested contact, business, and compliance sections — mirrors
84
+ # the request structure.
85
+ #
86
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Data::Brand, nil]
87
+ optional :brand, -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand }, nil?: true
88
+
89
+ # @!attribute created_at
90
+ # When the profile was created
91
+ #
92
+ # @return [Time, nil]
93
+ optional :created_at, Time
94
+
95
+ # @!attribute description
96
+ # Profile description
97
+ #
98
+ # @return [String, nil]
99
+ optional :description, String, nil?: true
100
+
101
+ # @!attribute email
102
+ # Profile email (inherited from organization)
103
+ #
104
+ # @return [String, nil]
105
+ optional :email, String, nil?: true
106
+
107
+ # @!attribute icon
108
+ # Profile icon URL
109
+ #
110
+ # @return [String, nil]
111
+ optional :icon, String, nil?: true
112
+
113
+ # @!attribute inherit_contacts
114
+ # Whether this profile inherits contacts from the organization
115
+ #
116
+ # @return [Boolean, nil]
117
+ optional :inherit_contacts, Sentdm::Internal::Type::Boolean
118
+
119
+ # @!attribute inherit_tcr_brand
120
+ # Whether this profile inherits TCR brand from the organization
121
+ #
122
+ # @return [Boolean, nil]
123
+ optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean
124
+
125
+ # @!attribute inherit_tcr_campaign
126
+ # Whether this profile inherits TCR campaign from the organization
127
+ #
128
+ # @return [Boolean, nil]
129
+ optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean
130
+
131
+ # @!attribute inherit_templates
132
+ # Whether this profile inherits templates from the organization
133
+ #
134
+ # @return [Boolean, nil]
135
+ optional :inherit_templates, Sentdm::Internal::Type::Boolean
136
+
137
+ # @!attribute name
138
+ # Profile name
139
+ #
140
+ # @return [String, nil]
141
+ optional :name, String
142
+
143
+ # @!attribute organization_id
144
+ # Parent organization ID
145
+ #
146
+ # @return [String, nil]
147
+ optional :organization_id, String, nil?: true
148
+
149
+ # @!attribute sending_phone_number
150
+ # Direct SMS phone number
151
+ #
152
+ # @return [String, nil]
153
+ optional :sending_phone_number, String, nil?: true
154
+
155
+ # @!attribute sending_phone_number_profile_id
156
+ # Reference to another profile for SMS/Telnyx configuration
157
+ #
158
+ # @return [String, nil]
159
+ optional :sending_phone_number_profile_id, String, nil?: true
160
+
161
+ # @!attribute sending_whatsapp_number_profile_id
162
+ # Reference to another profile for WhatsApp configuration
163
+ #
164
+ # @return [String, nil]
165
+ optional :sending_whatsapp_number_profile_id, String, nil?: true
166
+
167
+ # @!attribute short_name
168
+ # Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces
169
+ # only, with at least one letter.
170
+ #
171
+ # @return [String, nil]
172
+ optional :short_name, String, nil?: true
173
+
174
+ # @!attribute status
175
+ # Profile setup status: incomplete, pending_review, approved, rejected
176
+ #
177
+ # @return [String, nil]
178
+ optional :status, String
179
+
180
+ # @!attribute updated_at
181
+ # When the profile was last updated
182
+ #
183
+ # @return [Time, nil]
184
+ optional :updated_at, Time, nil?: true
185
+
186
+ # @!attribute waba_id
187
+ # WhatsApp Business Account ID associated with this profile. Present whether the
188
+ # WABA is inherited from the organization or configured directly.
189
+ #
190
+ # @return [String, nil]
191
+ optional :waba_id, String, nil?: true
192
+
193
+ # @!attribute whatsapp_phone_number
194
+ # Direct WhatsApp phone number
195
+ #
196
+ # @return [String, nil]
197
+ optional :whatsapp_phone_number, String, nil?: true
198
+
199
+ # @!method initialize(id: nil, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, created_at: nil, description: nil, email: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, organization_id: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, status: nil, updated_at: nil, waba_id: nil, whatsapp_phone_number: nil)
200
+ # Some parameter documentations has been truncated, see
201
+ # {Sentdm::Models::ProfileRetrieveResponse::Data} for more details.
202
+ #
203
+ # Detailed profile response for v3 API
204
+ #
205
+ # @param id [String] Profile unique identifier
206
+ #
207
+ # @param allow_contact_sharing [Boolean] Whether contacts are shared across profiles in the organization
208
+ #
209
+ # @param allow_number_change_during_onboarding [Boolean, nil] Whether number changes are allowed during onboarding
210
+ #
211
+ # @param allow_template_sharing [Boolean] Whether templates are shared across profiles in the organization
212
+ #
213
+ # @param billing_contact [Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact, nil] Billing contact info returned in profile responses
214
+ #
215
+ # @param billing_model [String] Billing model: profile, organization, or profile_and_organization
216
+ #
217
+ # @param brand [Sentdm::Models::ProfileRetrieveResponse::Data::Brand, nil] Brand response with nested contact, business, and compliance sections — mirrors
218
+ #
219
+ # @param created_at [Time] When the profile was created
220
+ #
221
+ # @param description [String, nil] Profile description
222
+ #
223
+ # @param email [String, nil] Profile email (inherited from organization)
224
+ #
225
+ # @param icon [String, nil] Profile icon URL
226
+ #
227
+ # @param inherit_contacts [Boolean] Whether this profile inherits contacts from the organization
228
+ #
229
+ # @param inherit_tcr_brand [Boolean] Whether this profile inherits TCR brand from the organization
230
+ #
231
+ # @param inherit_tcr_campaign [Boolean] Whether this profile inherits TCR campaign from the organization
232
+ #
233
+ # @param inherit_templates [Boolean] Whether this profile inherits templates from the organization
234
+ #
235
+ # @param name [String] Profile name
236
+ #
237
+ # @param organization_id [String, nil] Parent organization ID
238
+ #
239
+ # @param sending_phone_number [String, nil] Direct SMS phone number
240
+ #
241
+ # @param sending_phone_number_profile_id [String, nil] Reference to another profile for SMS/Telnyx configuration
242
+ #
243
+ # @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile for WhatsApp configuration
244
+ #
245
+ # @param short_name [String, nil] Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces o
246
+ #
247
+ # @param status [String] Profile setup status: incomplete, pending_review, approved, rejected
248
+ #
249
+ # @param updated_at [Time, nil] When the profile was last updated
250
+ #
251
+ # @param waba_id [String, nil] WhatsApp Business Account ID associated with this profile.
252
+ #
253
+ # @param whatsapp_phone_number [String, nil] Direct WhatsApp phone number
254
+
255
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data#billing_contact
256
+ class BillingContact < Sentdm::Internal::Type::BaseModel
257
+ # @!attribute address
258
+ #
259
+ # @return [String, nil]
260
+ optional :address, String, nil?: true
261
+
262
+ # @!attribute email
263
+ #
264
+ # @return [String, nil]
265
+ optional :email, String, nil?: true
266
+
267
+ # @!attribute name
268
+ #
269
+ # @return [String, nil]
270
+ optional :name, String, nil?: true
271
+
272
+ # @!attribute phone
273
+ #
274
+ # @return [String, nil]
275
+ optional :phone, String, nil?: true
276
+
277
+ # @!method initialize(address: nil, email: nil, name: nil, phone: nil)
278
+ # Billing contact info returned in profile responses
279
+ #
280
+ # @param address [String, nil]
281
+ # @param email [String, nil]
282
+ # @param name [String, nil]
283
+ # @param phone [String, nil]
284
+ end
285
+
286
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data#brand
287
+ class Brand < Sentdm::Internal::Type::BaseModel
288
+ # @!attribute id
289
+ # Unique identifier for the brand
290
+ #
291
+ # @return [String, nil]
292
+ optional :id, String
293
+
294
+ # @!attribute business
295
+ # Business details and address information
296
+ #
297
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business, nil]
298
+ optional :business, -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business }, nil?: true
299
+
300
+ # @!attribute compliance
301
+ # Compliance and TCR-related information
302
+ #
303
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance, nil]
304
+ optional :compliance, -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance }, nil?: true
305
+
306
+ # @!attribute contact
307
+ # Contact information for the brand
308
+ #
309
+ # @return [Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact, nil]
310
+ optional :contact, -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact }, nil?: true
311
+
312
+ # @!attribute created_at
313
+ # When the brand was created
314
+ #
315
+ # @return [Time, nil]
316
+ optional :created_at, Time
317
+
318
+ # @!attribute csp_id
319
+ # CSP (Campaign Service Provider) ID
320
+ #
321
+ # @return [String, nil]
322
+ optional :csp_id, String, nil?: true
323
+
324
+ # @!attribute identity_status
325
+ #
326
+ # @return [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus, nil]
327
+ optional :identity_status,
328
+ enum: -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus },
329
+ nil?: true
330
+
331
+ # @!attribute is_inherited
332
+ # Whether this brand is inherited from the parent organization
333
+ #
334
+ # @return [Boolean, nil]
335
+ optional :is_inherited, Sentdm::Internal::Type::Boolean
336
+
337
+ # @!attribute status
338
+ #
339
+ # @return [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status, nil]
340
+ optional :status, enum: -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status }, nil?: true
341
+
342
+ # @!attribute submitted_at
343
+ # When the brand was submitted to TCR
344
+ #
345
+ # @return [Time, nil]
346
+ optional :submitted_at, Time, nil?: true
347
+
348
+ # @!attribute submitted_to_tcr
349
+ # Whether this brand has been submitted to TCR
350
+ #
351
+ # @return [Boolean, nil]
352
+ optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean
353
+
354
+ # @!attribute tcr_brand_id
355
+ # TCR brand ID (populated after TCR submission)
356
+ #
357
+ # @return [String, nil]
358
+ optional :tcr_brand_id, String, nil?: true
359
+
360
+ # @!attribute universal_ein
361
+ # Universal EIN from TCR
362
+ #
363
+ # @return [String, nil]
364
+ optional :universal_ein, String, nil?: true
365
+
366
+ # @!attribute updated_at
367
+ # When the brand was last updated
368
+ #
369
+ # @return [Time, nil]
370
+ optional :updated_at, Time, nil?: true
371
+
372
+ # @!method initialize(id: nil, business: nil, compliance: nil, contact: nil, created_at: nil, csp_id: nil, identity_status: nil, is_inherited: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil)
373
+ # Brand response with nested contact, business, and compliance sections — mirrors
374
+ # the request structure.
375
+ #
376
+ # @param id [String] Unique identifier for the brand
377
+ #
378
+ # @param business [Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business, nil] Business details and address information
379
+ #
380
+ # @param compliance [Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance, nil] Compliance and TCR-related information
381
+ #
382
+ # @param contact [Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact, nil] Contact information for the brand
383
+ #
384
+ # @param created_at [Time] When the brand was created
385
+ #
386
+ # @param csp_id [String, nil] CSP (Campaign Service Provider) ID
387
+ #
388
+ # @param identity_status [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus, nil]
389
+ #
390
+ # @param is_inherited [Boolean] Whether this brand is inherited from the parent organization
391
+ #
392
+ # @param status [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status, nil]
393
+ #
394
+ # @param submitted_at [Time, nil] When the brand was submitted to TCR
395
+ #
396
+ # @param submitted_to_tcr [Boolean] Whether this brand has been submitted to TCR
397
+ #
398
+ # @param tcr_brand_id [String, nil] TCR brand ID (populated after TCR submission)
399
+ #
400
+ # @param universal_ein [String, nil] Universal EIN from TCR
401
+ #
402
+ # @param updated_at [Time, nil] When the brand was last updated
403
+
404
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data::Brand#business
405
+ class Business < Sentdm::Internal::Type::BaseModel
406
+ # @!attribute city
407
+ # City
408
+ #
409
+ # @return [String, nil]
410
+ optional :city, String, nil?: true
411
+
412
+ # @!attribute country
413
+ # Country code (e.g., US, CA)
414
+ #
415
+ # @return [String, nil]
416
+ optional :country, String, nil?: true
417
+
418
+ # @!attribute country_of_registration
419
+ # Country where the business is registered
420
+ #
421
+ # @return [String, nil]
422
+ optional :country_of_registration, String, nil?: true
423
+
424
+ # @!attribute entity_type
425
+ # Business entity type
426
+ #
427
+ # @return [String, nil]
428
+ optional :entity_type, String, nil?: true
429
+
430
+ # @!attribute legal_name
431
+ # Legal business name
432
+ #
433
+ # @return [String, nil]
434
+ optional :legal_name, String, nil?: true
435
+
436
+ # @!attribute postal_code
437
+ # Postal/ZIP code
438
+ #
439
+ # @return [String, nil]
440
+ optional :postal_code, String, nil?: true
441
+
442
+ # @!attribute state
443
+ # State/province code
444
+ #
445
+ # @return [String, nil]
446
+ optional :state, String, nil?: true
447
+
448
+ # @!attribute street
449
+ # Street address
450
+ #
451
+ # @return [String, nil]
452
+ optional :street, String, nil?: true
453
+
454
+ # @!attribute tax_id
455
+ # Tax ID/EIN number
456
+ #
457
+ # @return [String, nil]
458
+ optional :tax_id, String, nil?: true
459
+
460
+ # @!attribute tax_id_type
461
+ # Type of tax ID (e.g., us_ein, ca_bn)
462
+ #
463
+ # @return [String, nil]
464
+ optional :tax_id_type, String, nil?: true
465
+
466
+ # @!attribute url
467
+ # Business website URL
468
+ #
469
+ # @return [String, nil]
470
+ optional :url, String, nil?: true
471
+
472
+ # @!method initialize(city: nil, country: nil, country_of_registration: nil, entity_type: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, url: nil)
473
+ # Business details and address information
474
+ #
475
+ # @param city [String, nil] City
476
+ #
477
+ # @param country [String, nil] Country code (e.g., US, CA)
478
+ #
479
+ # @param country_of_registration [String, nil] Country where the business is registered
480
+ #
481
+ # @param entity_type [String, nil] Business entity type
482
+ #
483
+ # @param legal_name [String, nil] Legal business name
484
+ #
485
+ # @param postal_code [String, nil] Postal/ZIP code
486
+ #
487
+ # @param state [String, nil] State/province code
488
+ #
489
+ # @param street [String, nil] Street address
490
+ #
491
+ # @param tax_id [String, nil] Tax ID/EIN number
492
+ #
493
+ # @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
494
+ #
495
+ # @param url [String, nil] Business website URL
496
+ end
497
+
498
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data::Brand#compliance
499
+ class Compliance < Sentdm::Internal::Type::BaseModel
500
+ # @!attribute brand_relationship
501
+ #
502
+ # @return [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship, nil]
503
+ optional :brand_relationship,
504
+ enum: -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship },
505
+ nil?: true
506
+
507
+ # @!attribute destination_countries
508
+ # List of destination countries for messaging
509
+ #
510
+ # @return [Array<Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry>, nil]
511
+ optional :destination_countries,
512
+ -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry] }
513
+
514
+ # @!attribute expected_messaging_volume
515
+ # Expected daily messaging volume
516
+ #
517
+ # @return [String, nil]
518
+ optional :expected_messaging_volume, String, nil?: true
519
+
520
+ # @!attribute is_tcr_application
521
+ # Whether this is a TCR (Campaign Registry) application
522
+ #
523
+ # @return [Boolean, nil]
524
+ optional :is_tcr_application, Sentdm::Internal::Type::Boolean
525
+
526
+ # @!attribute notes
527
+ # Additional notes about the business or use case
528
+ #
529
+ # @return [String, nil]
530
+ optional :notes, String, nil?: true
531
+
532
+ # @!attribute phone_number_prefix
533
+ # Phone number prefix for messaging (e.g., "+1")
534
+ #
535
+ # @return [String, nil]
536
+ optional :phone_number_prefix, String, nil?: true
537
+
538
+ # @!attribute primary_use_case
539
+ # Primary messaging use case description
540
+ #
541
+ # @return [String, nil]
542
+ optional :primary_use_case, String, nil?: true
543
+
544
+ # @!attribute vertical
545
+ #
546
+ # @return [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical, nil]
547
+ optional :vertical,
548
+ enum: -> { Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical },
549
+ nil?: true
550
+
551
+ # @!method initialize(brand_relationship: nil, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
552
+ # Compliance and TCR-related information
553
+ #
554
+ # @param brand_relationship [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship, nil]
555
+ #
556
+ # @param destination_countries [Array<Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry>] List of destination countries for messaging
557
+ #
558
+ # @param expected_messaging_volume [String, nil] Expected daily messaging volume
559
+ #
560
+ # @param is_tcr_application [Boolean] Whether this is a TCR (Campaign Registry) application
561
+ #
562
+ # @param notes [String, nil] Additional notes about the business or use case
563
+ #
564
+ # @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
565
+ #
566
+ # @param primary_use_case [String, nil] Primary messaging use case description
567
+ #
568
+ # @param vertical [Symbol, Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical, nil]
569
+
570
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance#brand_relationship
571
+ module BrandRelationship
572
+ extend Sentdm::Internal::Type::Enum
573
+
574
+ BASIC_ACCOUNT = :BASIC_ACCOUNT
575
+ MEDIUM_ACCOUNT = :MEDIUM_ACCOUNT
576
+ LARGE_ACCOUNT = :LARGE_ACCOUNT
577
+ SMALL_ACCOUNT = :SMALL_ACCOUNT
578
+ KEY_ACCOUNT = :KEY_ACCOUNT
579
+
580
+ # @!method self.values
581
+ # @return [Array<Symbol>]
582
+ end
583
+
584
+ class DestinationCountry < Sentdm::Internal::Type::BaseModel
585
+ # @!attribute id
586
+ #
587
+ # @return [String, nil]
588
+ optional :id, String
589
+
590
+ # @!attribute is_main
591
+ #
592
+ # @return [Boolean, nil]
593
+ optional :is_main, Sentdm::Internal::Type::Boolean, api_name: :isMain
594
+
595
+ # @!method initialize(id: nil, is_main: nil)
596
+ # @param id [String]
597
+ # @param is_main [Boolean]
598
+ end
599
+
600
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance#vertical
601
+ module Vertical
602
+ extend Sentdm::Internal::Type::Enum
603
+
604
+ PROFESSIONAL = :PROFESSIONAL
605
+ REAL_ESTATE = :REAL_ESTATE
606
+ HEALTHCARE = :HEALTHCARE
607
+ HUMAN_RESOURCES = :HUMAN_RESOURCES
608
+ ENERGY = :ENERGY
609
+ ENTERTAINMENT = :ENTERTAINMENT
610
+ RETAIL = :RETAIL
611
+ TRANSPORTATION = :TRANSPORTATION
612
+ AGRICULTURE = :AGRICULTURE
613
+ INSURANCE = :INSURANCE
614
+ POSTAL = :POSTAL
615
+ EDUCATION = :EDUCATION
616
+ HOSPITALITY = :HOSPITALITY
617
+ FINANCIAL = :FINANCIAL
618
+ POLITICAL = :POLITICAL
619
+ GAMBLING = :GAMBLING
620
+ LEGAL = :LEGAL
621
+ CONSTRUCTION = :CONSTRUCTION
622
+ NGO = :NGO
623
+ MANUFACTURING = :MANUFACTURING
624
+ GOVERNMENT = :GOVERNMENT
625
+ TECHNOLOGY = :TECHNOLOGY
626
+ COMMUNICATION = :COMMUNICATION
627
+
628
+ # @!method self.values
629
+ # @return [Array<Symbol>]
630
+ end
631
+ end
632
+
633
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data::Brand#contact
634
+ class Contact < Sentdm::Internal::Type::BaseModel
635
+ # @!attribute business_name
636
+ # Business/brand name
637
+ #
638
+ # @return [String, nil]
639
+ optional :business_name, String, nil?: true
640
+
641
+ # @!attribute email
642
+ # Contact email address
643
+ #
644
+ # @return [String, nil]
645
+ optional :email, String, nil?: true
646
+
647
+ # @!attribute name
648
+ # Primary contact name
649
+ #
650
+ # @return [String, nil]
651
+ optional :name, String
652
+
653
+ # @!attribute phone
654
+ # Contact phone number in E.164 format
655
+ #
656
+ # @return [String, nil]
657
+ optional :phone, String, nil?: true
658
+
659
+ # @!attribute phone_country_code
660
+ # Contact phone country code (e.g., "1" for US)
661
+ #
662
+ # @return [String, nil]
663
+ optional :phone_country_code, String, nil?: true
664
+
665
+ # @!attribute role
666
+ # Contact's role in the business
667
+ #
668
+ # @return [String, nil]
669
+ optional :role, String, nil?: true
670
+
671
+ # @!method initialize(business_name: nil, email: nil, name: nil, phone: nil, phone_country_code: nil, role: nil)
672
+ # Contact information for the brand
673
+ #
674
+ # @param business_name [String, nil] Business/brand name
675
+ #
676
+ # @param email [String, nil] Contact email address
677
+ #
678
+ # @param name [String] Primary contact name
679
+ #
680
+ # @param phone [String, nil] Contact phone number in E.164 format
681
+ #
682
+ # @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
683
+ #
684
+ # @param role [String, nil] Contact's role in the business
685
+ end
686
+
687
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data::Brand#identity_status
688
+ module IdentityStatus
689
+ extend Sentdm::Internal::Type::Enum
690
+
691
+ SELF_DECLARED = :SELF_DECLARED
692
+ UNVERIFIED = :UNVERIFIED
693
+ VERIFIED = :VERIFIED
694
+ VETTED_VERIFIED = :VETTED_VERIFIED
695
+
696
+ # @!method self.values
697
+ # @return [Array<Symbol>]
698
+ end
699
+
700
+ # @see Sentdm::Models::ProfileRetrieveResponse::Data::Brand#status
701
+ module Status
702
+ extend Sentdm::Internal::Type::Enum
703
+
704
+ ACTIVE = :ACTIVE
705
+ INACTIVE = :INACTIVE
706
+ SUSPENDED = :SUSPENDED
707
+
708
+ # @!method self.values
709
+ # @return [Array<Symbol>]
710
+ end
711
+ end
712
+ end
713
+
714
+ # @see Sentdm::Models::ProfileRetrieveResponse#error
715
+ class Error < Sentdm::Internal::Type::BaseModel
716
+ # @!attribute code
717
+ # Machine-readable error code (e.g., "RESOURCE_001")
718
+ #
719
+ # @return [String, nil]
720
+ optional :code, String
721
+
722
+ # @!attribute details
723
+ # Additional validation error details (field-level errors)
724
+ #
725
+ # @return [Hash{Symbol=>Array<String>}, nil]
726
+ optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
727
+
728
+ # @!attribute doc_url
729
+ # URL to documentation about this error
730
+ #
731
+ # @return [String, nil]
732
+ optional :doc_url, String, nil?: true
733
+
734
+ # @!attribute message
735
+ # Human-readable error message
736
+ #
737
+ # @return [String, nil]
738
+ optional :message, String
739
+
740
+ # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
741
+ # Error information
742
+ #
743
+ # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
744
+ #
745
+ # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
746
+ #
747
+ # @param doc_url [String, nil] URL to documentation about this error
748
+ #
749
+ # @param message [String] Human-readable error message
750
+ end
751
+
752
+ # @see Sentdm::Models::ProfileRetrieveResponse#meta
753
+ class Meta < Sentdm::Internal::Type::BaseModel
754
+ # @!attribute request_id
755
+ # Unique identifier for this request (for tracing and support)
756
+ #
757
+ # @return [String, nil]
758
+ optional :request_id, String
759
+
760
+ # @!attribute timestamp
761
+ # Server timestamp when the response was generated
762
+ #
763
+ # @return [Time, nil]
764
+ optional :timestamp, Time
765
+
766
+ # @!attribute version
767
+ # API version used for this request
768
+ #
769
+ # @return [String, nil]
770
+ optional :version, String
771
+
772
+ # @!method initialize(request_id: nil, timestamp: nil, version: nil)
773
+ # Request and response metadata
774
+ #
775
+ # @param request_id [String] Unique identifier for this request (for tracing and support)
776
+ #
777
+ # @param timestamp [Time] Server timestamp when the response was generated
778
+ #
779
+ # @param version [String] API version used for this request
780
+ end
781
+ end
782
+ end
783
+ end