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
@@ -16,8 +16,8 @@ module Sentdm
16
16
  # @!attribute campaign
17
17
  # Campaign data for create or update operation
18
18
  #
19
- # @return [Sentdm::Models::Profiles::CampaignData]
20
- required :campaign, -> { Sentdm::Profiles::CampaignData }
19
+ # @return [Sentdm::Models::Profiles::CampaignCreateParams::Campaign]
20
+ required :campaign, -> { Sentdm::Profiles::CampaignCreateParams::Campaign }
21
21
 
22
22
  # @!attribute sandbox
23
23
  # Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -42,7 +42,7 @@ module Sentdm
42
42
  #
43
43
  # @param profile_id [String]
44
44
  #
45
- # @param campaign [Sentdm::Models::Profiles::CampaignData] Campaign data for create or update operation
45
+ # @param campaign [Sentdm::Models::Profiles::CampaignCreateParams::Campaign] Campaign data for create or update operation
46
46
  #
47
47
  # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
48
48
  #
@@ -51,6 +51,168 @@ module Sentdm
51
51
  # @param x_profile_id [String]
52
52
  #
53
53
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
54
+
55
+ class Campaign < Sentdm::Internal::Type::BaseModel
56
+ # @!attribute description
57
+ # Campaign description
58
+ #
59
+ # @return [String]
60
+ required :description, String
61
+
62
+ # @!attribute name
63
+ # Campaign name
64
+ #
65
+ # @return [String]
66
+ required :name, String
67
+
68
+ # @!attribute type
69
+ # Campaign type (e.g., "KYC", "App")
70
+ #
71
+ # @return [String]
72
+ required :type, String
73
+
74
+ # @!attribute use_cases
75
+ # List of use cases with sample messages
76
+ #
77
+ # @return [Array<Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase>]
78
+ required :use_cases,
79
+ -> {
80
+ Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::CampaignCreateParams::Campaign::UseCase]
81
+ },
82
+ api_name: :useCases
83
+
84
+ # @!attribute help_keywords
85
+ # Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
86
+ #
87
+ # @return [String, nil]
88
+ optional :help_keywords, String, api_name: :helpKeywords, nil?: true
89
+
90
+ # @!attribute help_message
91
+ # Message sent when user requests help
92
+ #
93
+ # @return [String, nil]
94
+ optional :help_message, String, api_name: :helpMessage, nil?: true
95
+
96
+ # @!attribute message_flow
97
+ # Description of how messages flow in the campaign
98
+ #
99
+ # @return [String, nil]
100
+ optional :message_flow, String, api_name: :messageFlow, nil?: true
101
+
102
+ # @!attribute optin_keywords
103
+ # Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
104
+ #
105
+ # @return [String, nil]
106
+ optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
107
+
108
+ # @!attribute optin_message
109
+ # Message sent when user opts in
110
+ #
111
+ # @return [String, nil]
112
+ optional :optin_message, String, api_name: :optinMessage, nil?: true
113
+
114
+ # @!attribute optout_keywords
115
+ # Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
116
+ #
117
+ # @return [String, nil]
118
+ optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
119
+
120
+ # @!attribute optout_message
121
+ # Message sent when user opts out
122
+ #
123
+ # @return [String, nil]
124
+ optional :optout_message, String, api_name: :optoutMessage, nil?: true
125
+
126
+ # @!attribute privacy_policy_link
127
+ # URL to privacy policy
128
+ #
129
+ # @return [String, nil]
130
+ optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
131
+
132
+ # @!attribute terms_and_conditions_link
133
+ # URL to terms and conditions
134
+ #
135
+ # @return [String, nil]
136
+ optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
137
+
138
+ # @!method initialize(description:, name:, type:, use_cases:, help_keywords: nil, help_message: nil, message_flow: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, terms_and_conditions_link: nil)
139
+ # Some parameter documentations has been truncated, see
140
+ # {Sentdm::Models::Profiles::CampaignCreateParams::Campaign} for more details.
141
+ #
142
+ # Campaign data for create or update operation
143
+ #
144
+ # @param description [String] Campaign description
145
+ #
146
+ # @param name [String] Campaign name
147
+ #
148
+ # @param type [String] Campaign type (e.g., "KYC", "App")
149
+ #
150
+ # @param use_cases [Array<Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase>] List of use cases with sample messages
151
+ #
152
+ # @param help_keywords [String, nil] Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
153
+ #
154
+ # @param help_message [String, nil] Message sent when user requests help
155
+ #
156
+ # @param message_flow [String, nil] Description of how messages flow in the campaign
157
+ #
158
+ # @param optin_keywords [String, nil] Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
159
+ #
160
+ # @param optin_message [String, nil] Message sent when user opts in
161
+ #
162
+ # @param optout_keywords [String, nil] Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
163
+ #
164
+ # @param optout_message [String, nil] Message sent when user opts out
165
+ #
166
+ # @param privacy_policy_link [String, nil] URL to privacy policy
167
+ #
168
+ # @param terms_and_conditions_link [String, nil] URL to terms and conditions
169
+
170
+ class UseCase < Sentdm::Internal::Type::BaseModel
171
+ # @!attribute messaging_use_case_us
172
+ #
173
+ # @return [Symbol, Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs]
174
+ required :messaging_use_case_us,
175
+ enum: -> {
176
+ Sentdm::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs
177
+ },
178
+ api_name: :messagingUseCaseUs
179
+
180
+ # @!attribute sample_messages
181
+ # Sample messages for this use case (1-5 messages, max 1024 characters each)
182
+ #
183
+ # @return [Array<String>]
184
+ required :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
185
+
186
+ # @!method initialize(messaging_use_case_us:, sample_messages:)
187
+ # Campaign use case with sample messages
188
+ #
189
+ # @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase::MessagingUseCaseUs]
190
+ #
191
+ # @param sample_messages [Array<String>] Sample messages for this use case (1-5 messages, max 1024 characters each)
192
+
193
+ # @see Sentdm::Models::Profiles::CampaignCreateParams::Campaign::UseCase#messaging_use_case_us
194
+ module MessagingUseCaseUs
195
+ extend Sentdm::Internal::Type::Enum
196
+
197
+ MARKETING = :MARKETING
198
+ ACCOUNT_NOTIFICATION = :ACCOUNT_NOTIFICATION
199
+ CUSTOMER_CARE = :CUSTOMER_CARE
200
+ FRAUD_ALERT = :FRAUD_ALERT
201
+ TWO_FA = :TWO_FA
202
+ DELIVERY_NOTIFICATION = :DELIVERY_NOTIFICATION
203
+ SECURITY_ALERT = :SECURITY_ALERT
204
+ M2_M = :M2M
205
+ MIXED = :MIXED
206
+ HIGHER_EDUCATION = :HIGHER_EDUCATION
207
+ POLLING_VOTING = :POLLING_VOTING
208
+ PUBLIC_SERVICE_ANNOUNCEMENT = :PUBLIC_SERVICE_ANNOUNCEMENT
209
+ LOW_VOLUME = :LOW_VOLUME
210
+
211
+ # @!method self.values
212
+ # @return [Array<Symbol>]
213
+ end
214
+ end
215
+ end
54
216
  end
55
217
  end
56
218
  end
@@ -0,0 +1,459 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ module Profiles
6
+ # @see Sentdm::Resources::Profiles::Campaigns#create
7
+ class CampaignCreateResponse < Sentdm::Internal::Type::BaseModel
8
+ # @!attribute data
9
+ # The response data (null if error)
10
+ #
11
+ # @return [Sentdm::Models::Profiles::CampaignCreateResponse::Data, nil]
12
+ optional :data, -> { Sentdm::Models::Profiles::CampaignCreateResponse::Data }, nil?: true
13
+
14
+ # @!attribute error
15
+ # Error information
16
+ #
17
+ # @return [Sentdm::Models::Profiles::CampaignCreateResponse::Error, nil]
18
+ optional :error, -> { Sentdm::Models::Profiles::CampaignCreateResponse::Error }, nil?: true
19
+
20
+ # @!attribute meta
21
+ # Request and response metadata
22
+ #
23
+ # @return [Sentdm::Models::Profiles::CampaignCreateResponse::Meta, nil]
24
+ optional :meta, -> { Sentdm::Models::Profiles::CampaignCreateResponse::Meta }
25
+
26
+ # @!attribute success
27
+ # Indicates whether the request was successful
28
+ #
29
+ # @return [Boolean, nil]
30
+ optional :success, Sentdm::Internal::Type::Boolean
31
+
32
+ # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
33
+ # Standard API response envelope for all v3 endpoints
34
+ #
35
+ # @param data [Sentdm::Models::Profiles::CampaignCreateResponse::Data, nil] The response data (null if error)
36
+ #
37
+ # @param error [Sentdm::Models::Profiles::CampaignCreateResponse::Error, nil] Error information
38
+ #
39
+ # @param meta [Sentdm::Models::Profiles::CampaignCreateResponse::Meta] Request and response metadata
40
+ #
41
+ # @param success [Boolean] Indicates whether the request was successful
42
+
43
+ # @see Sentdm::Models::Profiles::CampaignCreateResponse#data
44
+ class Data < Sentdm::Internal::Type::BaseModel
45
+ # @!attribute id
46
+ # Unique identifier
47
+ #
48
+ # @return [String, nil]
49
+ optional :id, String
50
+
51
+ # @!attribute billed_date
52
+ #
53
+ # @return [Time, nil]
54
+ optional :billed_date, Time, api_name: :billedDate, nil?: true
55
+
56
+ # @!attribute brand_id
57
+ #
58
+ # @return [String, nil]
59
+ optional :brand_id, String, api_name: :brandId, nil?: true
60
+
61
+ # @!attribute cost
62
+ #
63
+ # @return [Float, nil]
64
+ optional :cost, Float, nil?: true
65
+
66
+ # @!attribute created_at
67
+ #
68
+ # @return [Time, nil]
69
+ optional :created_at, Time, api_name: :createdAt
70
+
71
+ # @!attribute csp_id
72
+ #
73
+ # @return [String, nil]
74
+ optional :csp_id, String, api_name: :cspId, nil?: true
75
+
76
+ # @!attribute customer_id
77
+ #
78
+ # @return [String, nil]
79
+ optional :customer_id, String, api_name: :customerId
80
+
81
+ # @!attribute dca_elections_complete
82
+ #
83
+ # @return [Boolean, nil]
84
+ optional :dca_elections_complete, Sentdm::Internal::Type::Boolean, api_name: :dcaElectionsComplete
85
+
86
+ # @!attribute dca_elections_completed_at
87
+ #
88
+ # @return [Time, nil]
89
+ optional :dca_elections_completed_at, Time, api_name: :dcaElectionsCompletedAt, nil?: true
90
+
91
+ # @!attribute description
92
+ #
93
+ # @return [String, nil]
94
+ optional :description, String
95
+
96
+ # @!attribute help_keywords
97
+ #
98
+ # @return [String, nil]
99
+ optional :help_keywords, String, api_name: :helpKeywords, nil?: true
100
+
101
+ # @!attribute help_message
102
+ #
103
+ # @return [String, nil]
104
+ optional :help_message, String, api_name: :helpMessage, nil?: true
105
+
106
+ # @!attribute kyc_submission_form_id
107
+ #
108
+ # @return [String, nil]
109
+ optional :kyc_submission_form_id, String, api_name: :kycSubmissionFormId, nil?: true
110
+
111
+ # @!attribute message_flow
112
+ #
113
+ # @return [String, nil]
114
+ optional :message_flow, String, api_name: :messageFlow, nil?: true
115
+
116
+ # @!attribute name
117
+ #
118
+ # @return [String, nil]
119
+ optional :name, String
120
+
121
+ # @!attribute optin_keywords
122
+ #
123
+ # @return [String, nil]
124
+ optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
125
+
126
+ # @!attribute optin_message
127
+ #
128
+ # @return [String, nil]
129
+ optional :optin_message, String, api_name: :optinMessage, nil?: true
130
+
131
+ # @!attribute optout_keywords
132
+ #
133
+ # @return [String, nil]
134
+ optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
135
+
136
+ # @!attribute optout_message
137
+ #
138
+ # @return [String, nil]
139
+ optional :optout_message, String, api_name: :optoutMessage, nil?: true
140
+
141
+ # @!attribute privacy_policy_link
142
+ #
143
+ # @return [String, nil]
144
+ optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
145
+
146
+ # @!attribute reseller_id
147
+ #
148
+ # @return [String, nil]
149
+ optional :reseller_id, String, api_name: :resellerId, nil?: true
150
+
151
+ # @!attribute sharing_status
152
+ #
153
+ # @return [Symbol, Sentdm::Models::Profiles::CampaignCreateResponse::Data::SharingStatus, nil]
154
+ optional :sharing_status,
155
+ enum: -> { Sentdm::Models::Profiles::CampaignCreateResponse::Data::SharingStatus },
156
+ api_name: :sharingStatus,
157
+ nil?: true
158
+
159
+ # @!attribute status
160
+ #
161
+ # @return [Symbol, Sentdm::Models::Profiles::CampaignCreateResponse::Data::Status, nil]
162
+ optional :status, enum: -> { Sentdm::Models::Profiles::CampaignCreateResponse::Data::Status }, nil?: true
163
+
164
+ # @!attribute submitted_at
165
+ #
166
+ # @return [Time, nil]
167
+ optional :submitted_at, Time, api_name: :submittedAt, nil?: true
168
+
169
+ # @!attribute submitted_to_tcr
170
+ #
171
+ # @return [Boolean, nil]
172
+ optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR
173
+
174
+ # @!attribute tcr_campaign_id
175
+ #
176
+ # @return [String, nil]
177
+ optional :tcr_campaign_id, String, api_name: :tcrCampaignId, nil?: true
178
+
179
+ # @!attribute tcr_sync_error
180
+ #
181
+ # @return [String, nil]
182
+ optional :tcr_sync_error, String, api_name: :tcrSyncError, nil?: true
183
+
184
+ # @!attribute telnyx_campaign_id
185
+ #
186
+ # @return [String, nil]
187
+ optional :telnyx_campaign_id, String, api_name: :telnyxCampaignId, nil?: true
188
+
189
+ # @!attribute terms_and_conditions_link
190
+ #
191
+ # @return [String, nil]
192
+ optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
193
+
194
+ # @!attribute type
195
+ #
196
+ # @return [String, nil]
197
+ optional :type, String
198
+
199
+ # @!attribute updated_at
200
+ #
201
+ # @return [Time, nil]
202
+ optional :updated_at, Time, api_name: :updatedAt, nil?: true
203
+
204
+ # @!attribute upstream_cnp_id
205
+ #
206
+ # @return [String, nil]
207
+ optional :upstream_cnp_id, String, api_name: :upstreamCnpId, nil?: true
208
+
209
+ # @!attribute use_cases
210
+ #
211
+ # @return [Array<Sentdm::Models::Profiles::CampaignCreateResponse::Data::UseCase>, nil]
212
+ optional :use_cases,
213
+ -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::Profiles::CampaignCreateResponse::Data::UseCase] },
214
+ api_name: :useCases
215
+
216
+ # @!method initialize(id: nil, billed_date: nil, brand_id: nil, cost: nil, created_at: nil, csp_id: nil, customer_id: nil, dca_elections_complete: nil, dca_elections_completed_at: nil, description: nil, help_keywords: nil, help_message: nil, kyc_submission_form_id: nil, message_flow: nil, name: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, reseller_id: nil, sharing_status: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_campaign_id: nil, tcr_sync_error: nil, telnyx_campaign_id: nil, terms_and_conditions_link: nil, type: nil, updated_at: nil, upstream_cnp_id: nil, use_cases: nil)
217
+ # The response data (null if error)
218
+ #
219
+ # @param id [String] Unique identifier
220
+ #
221
+ # @param billed_date [Time, nil]
222
+ #
223
+ # @param brand_id [String, nil]
224
+ #
225
+ # @param cost [Float, nil]
226
+ #
227
+ # @param created_at [Time]
228
+ #
229
+ # @param csp_id [String, nil]
230
+ #
231
+ # @param customer_id [String]
232
+ #
233
+ # @param dca_elections_complete [Boolean]
234
+ #
235
+ # @param dca_elections_completed_at [Time, nil]
236
+ #
237
+ # @param description [String]
238
+ #
239
+ # @param help_keywords [String, nil]
240
+ #
241
+ # @param help_message [String, nil]
242
+ #
243
+ # @param kyc_submission_form_id [String, nil]
244
+ #
245
+ # @param message_flow [String, nil]
246
+ #
247
+ # @param name [String]
248
+ #
249
+ # @param optin_keywords [String, nil]
250
+ #
251
+ # @param optin_message [String, nil]
252
+ #
253
+ # @param optout_keywords [String, nil]
254
+ #
255
+ # @param optout_message [String, nil]
256
+ #
257
+ # @param privacy_policy_link [String, nil]
258
+ #
259
+ # @param reseller_id [String, nil]
260
+ #
261
+ # @param sharing_status [Symbol, Sentdm::Models::Profiles::CampaignCreateResponse::Data::SharingStatus, nil]
262
+ #
263
+ # @param status [Symbol, Sentdm::Models::Profiles::CampaignCreateResponse::Data::Status, nil]
264
+ #
265
+ # @param submitted_at [Time, nil]
266
+ #
267
+ # @param submitted_to_tcr [Boolean]
268
+ #
269
+ # @param tcr_campaign_id [String, nil]
270
+ #
271
+ # @param tcr_sync_error [String, nil]
272
+ #
273
+ # @param telnyx_campaign_id [String, nil]
274
+ #
275
+ # @param terms_and_conditions_link [String, nil]
276
+ #
277
+ # @param type [String]
278
+ #
279
+ # @param updated_at [Time, nil]
280
+ #
281
+ # @param upstream_cnp_id [String, nil]
282
+ #
283
+ # @param use_cases [Array<Sentdm::Models::Profiles::CampaignCreateResponse::Data::UseCase>]
284
+
285
+ # @see Sentdm::Models::Profiles::CampaignCreateResponse::Data#sharing_status
286
+ module SharingStatus
287
+ extend Sentdm::Internal::Type::Enum
288
+
289
+ PENDING = :PENDING
290
+ ACCEPTED = :ACCEPTED
291
+ DECLINED = :DECLINED
292
+
293
+ # @!method self.values
294
+ # @return [Array<Symbol>]
295
+ end
296
+
297
+ # @see Sentdm::Models::Profiles::CampaignCreateResponse::Data#status
298
+ module Status
299
+ extend Sentdm::Internal::Type::Enum
300
+
301
+ SENT_CREATED = :SENT_CREATED
302
+ ACTIVE = :ACTIVE
303
+ EXPIRED = :EXPIRED
304
+
305
+ # @!method self.values
306
+ # @return [Array<Symbol>]
307
+ end
308
+
309
+ class UseCase < Sentdm::Internal::Type::BaseModel
310
+ # @!attribute id
311
+ # Unique identifier
312
+ #
313
+ # @return [String, nil]
314
+ optional :id, String
315
+
316
+ # @!attribute campaign_id
317
+ #
318
+ # @return [String, nil]
319
+ optional :campaign_id, String, api_name: :campaignId
320
+
321
+ # @!attribute created_at
322
+ #
323
+ # @return [Time, nil]
324
+ optional :created_at, Time, api_name: :createdAt
325
+
326
+ # @!attribute customer_id
327
+ #
328
+ # @return [String, nil]
329
+ optional :customer_id, String, api_name: :customerId
330
+
331
+ # @!attribute messaging_use_case_us
332
+ #
333
+ # @return [Symbol, Sentdm::Models::Profiles::CampaignCreateResponse::Data::UseCase::MessagingUseCaseUs, nil]
334
+ optional :messaging_use_case_us,
335
+ enum: -> { Sentdm::Models::Profiles::CampaignCreateResponse::Data::UseCase::MessagingUseCaseUs },
336
+ api_name: :messagingUseCaseUs
337
+
338
+ # @!attribute sample_messages
339
+ #
340
+ # @return [Array<String>, nil]
341
+ optional :sample_messages, Sentdm::Internal::Type::ArrayOf[String], api_name: :sampleMessages
342
+
343
+ # @!attribute updated_at
344
+ #
345
+ # @return [Time, nil]
346
+ optional :updated_at, Time, api_name: :updatedAt, nil?: true
347
+
348
+ # @!method initialize(id: nil, campaign_id: nil, created_at: nil, customer_id: nil, messaging_use_case_us: nil, sample_messages: nil, updated_at: nil)
349
+ # @param id [String] Unique identifier
350
+ #
351
+ # @param campaign_id [String]
352
+ #
353
+ # @param created_at [Time]
354
+ #
355
+ # @param customer_id [String]
356
+ #
357
+ # @param messaging_use_case_us [Symbol, Sentdm::Models::Profiles::CampaignCreateResponse::Data::UseCase::MessagingUseCaseUs]
358
+ #
359
+ # @param sample_messages [Array<String>]
360
+ #
361
+ # @param updated_at [Time, nil]
362
+
363
+ # @see Sentdm::Models::Profiles::CampaignCreateResponse::Data::UseCase#messaging_use_case_us
364
+ module MessagingUseCaseUs
365
+ extend Sentdm::Internal::Type::Enum
366
+
367
+ MARKETING = :MARKETING
368
+ ACCOUNT_NOTIFICATION = :ACCOUNT_NOTIFICATION
369
+ CUSTOMER_CARE = :CUSTOMER_CARE
370
+ FRAUD_ALERT = :FRAUD_ALERT
371
+ TWO_FA = :TWO_FA
372
+ DELIVERY_NOTIFICATION = :DELIVERY_NOTIFICATION
373
+ SECURITY_ALERT = :SECURITY_ALERT
374
+ M2_M = :M2M
375
+ MIXED = :MIXED
376
+ HIGHER_EDUCATION = :HIGHER_EDUCATION
377
+ POLLING_VOTING = :POLLING_VOTING
378
+ PUBLIC_SERVICE_ANNOUNCEMENT = :PUBLIC_SERVICE_ANNOUNCEMENT
379
+ LOW_VOLUME = :LOW_VOLUME
380
+
381
+ # @!method self.values
382
+ # @return [Array<Symbol>]
383
+ end
384
+ end
385
+ end
386
+
387
+ # @see Sentdm::Models::Profiles::CampaignCreateResponse#error
388
+ class Error < Sentdm::Internal::Type::BaseModel
389
+ # @!attribute code
390
+ # Machine-readable error code (e.g., "RESOURCE_001")
391
+ #
392
+ # @return [String, nil]
393
+ optional :code, String
394
+
395
+ # @!attribute details
396
+ # Additional validation error details (field-level errors)
397
+ #
398
+ # @return [Hash{Symbol=>Array<String>}, nil]
399
+ optional :details,
400
+ Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
401
+ nil?: true
402
+
403
+ # @!attribute doc_url
404
+ # URL to documentation about this error
405
+ #
406
+ # @return [String, nil]
407
+ optional :doc_url, String, nil?: true
408
+
409
+ # @!attribute message
410
+ # Human-readable error message
411
+ #
412
+ # @return [String, nil]
413
+ optional :message, String
414
+
415
+ # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
416
+ # Error information
417
+ #
418
+ # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
419
+ #
420
+ # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
421
+ #
422
+ # @param doc_url [String, nil] URL to documentation about this error
423
+ #
424
+ # @param message [String] Human-readable error message
425
+ end
426
+
427
+ # @see Sentdm::Models::Profiles::CampaignCreateResponse#meta
428
+ class Meta < Sentdm::Internal::Type::BaseModel
429
+ # @!attribute request_id
430
+ # Unique identifier for this request (for tracing and support)
431
+ #
432
+ # @return [String, nil]
433
+ optional :request_id, String
434
+
435
+ # @!attribute timestamp
436
+ # Server timestamp when the response was generated
437
+ #
438
+ # @return [Time, nil]
439
+ optional :timestamp, Time
440
+
441
+ # @!attribute version
442
+ # API version used for this request
443
+ #
444
+ # @return [String, nil]
445
+ optional :version, String
446
+
447
+ # @!method initialize(request_id: nil, timestamp: nil, version: nil)
448
+ # Request and response metadata
449
+ #
450
+ # @param request_id [String] Unique identifier for this request (for tracing and support)
451
+ #
452
+ # @param timestamp [Time] Server timestamp when the response was generated
453
+ #
454
+ # @param version [String] API version used for this request
455
+ end
456
+ end
457
+ end
458
+ end
459
+ end
@@ -4,7 +4,7 @@ module Sentdm
4
4
  module Models
5
5
  module Profiles
6
6
  # @see Sentdm::Resources::Profiles::Campaigns#delete
7
- class CampaignDeleteParams < Sentdm::Models::MutationRequest
7
+ class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
8
8
  extend Sentdm::Internal::Type::RequestParameters::Converter
9
9
  include Sentdm::Internal::Type::RequestParameters
10
10
 
@@ -18,15 +18,30 @@ module Sentdm
18
18
  # @return [String]
19
19
  required :campaign_id, String
20
20
 
21
+ # @!attribute sandbox
22
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
23
+ # for testing integrations without actual execution
24
+ #
25
+ # @return [Boolean, nil]
26
+ optional :sandbox, Sentdm::Internal::Type::Boolean
27
+
21
28
  # @!attribute x_profile_id
22
29
  #
23
30
  # @return [String, nil]
24
31
  optional :x_profile_id, String
25
32
 
26
- # @!method initialize(profile_id:, campaign_id:, x_profile_id: nil, request_options: {})
33
+ # @!method initialize(profile_id:, campaign_id:, sandbox: nil, x_profile_id: nil, request_options: {})
34
+ # Some parameter documentations has been truncated, see
35
+ # {Sentdm::Models::Profiles::CampaignDeleteParams} for more details.
36
+ #
27
37
  # @param profile_id [String]
38
+ #
28
39
  # @param campaign_id [String]
40
+ #
41
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
42
+ #
29
43
  # @param x_profile_id [String]
44
+ #
30
45
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
31
46
  end
32
47
  end