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