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
@@ -1,197 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Templates#retrieve
6
- class TemplateRetrieveResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # Template response for v3 API
9
- #
10
- # @return [Sentdm::Models::TemplateRetrieveResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::TemplateRetrieveResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::TemplateRetrieveResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::TemplateRetrieveResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::TemplateRetrieveResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::TemplateRetrieveResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::TemplateRetrieveResponse::Data, nil] Template response for v3 API
35
- #
36
- # @param error [Sentdm::Models::TemplateRetrieveResponse::Error, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::TemplateRetrieveResponse::Meta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::TemplateRetrieveResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute id
45
- # Unique template identifier
46
- #
47
- # @return [String, nil]
48
- optional :id, String
49
-
50
- # @!attribute category
51
- # Template category: MARKETING, UTILITY, AUTHENTICATION
52
- #
53
- # @return [String, nil]
54
- optional :category, String
55
-
56
- # @!attribute channels
57
- # Supported channels: sms, whatsapp
58
- #
59
- # @return [Array<String>, nil]
60
- optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
61
-
62
- # @!attribute created_at
63
- # When the template was created
64
- #
65
- # @return [Time, nil]
66
- optional :created_at, Time
67
-
68
- # @!attribute is_published
69
- # Whether the template is published and active
70
- #
71
- # @return [Boolean, nil]
72
- optional :is_published, Sentdm::Internal::Type::Boolean
73
-
74
- # @!attribute language
75
- # Template language code (e.g., en_US)
76
- #
77
- # @return [String, nil]
78
- optional :language, String
79
-
80
- # @!attribute name
81
- # Template display name
82
- #
83
- # @return [String, nil]
84
- optional :name, String
85
-
86
- # @!attribute status
87
- # Template status: APPROVED, PENDING, REJECTED
88
- #
89
- # @return [String, nil]
90
- optional :status, String
91
-
92
- # @!attribute updated_at
93
- # When the template was last updated
94
- #
95
- # @return [Time, nil]
96
- optional :updated_at, Time, nil?: true
97
-
98
- # @!attribute variables
99
- # Template variables for personalization
100
- #
101
- # @return [Array<String>, nil]
102
- optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
103
-
104
- # @!method initialize(id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
105
- # Template response for v3 API
106
- #
107
- # @param id [String] Unique template identifier
108
- #
109
- # @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
110
- #
111
- # @param channels [Array<String>, nil] Supported channels: sms, whatsapp
112
- #
113
- # @param created_at [Time] When the template was created
114
- #
115
- # @param is_published [Boolean] Whether the template is published and active
116
- #
117
- # @param language [String] Template language code (e.g., en_US)
118
- #
119
- # @param name [String] Template display name
120
- #
121
- # @param status [String] Template status: APPROVED, PENDING, REJECTED
122
- #
123
- # @param updated_at [Time, nil] When the template was last updated
124
- #
125
- # @param variables [Array<String>, nil] Template variables for personalization
126
- end
127
-
128
- # @see Sentdm::Models::TemplateRetrieveResponse#error
129
- class Error < Sentdm::Internal::Type::BaseModel
130
- # @!attribute code
131
- # Machine-readable error code (e.g., "RESOURCE_001")
132
- #
133
- # @return [String, nil]
134
- optional :code, String
135
-
136
- # @!attribute details
137
- # Additional validation error details (field-level errors)
138
- #
139
- # @return [Hash{Symbol=>Array<String>}, nil]
140
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
141
-
142
- # @!attribute doc_url
143
- # URL to documentation about this error
144
- #
145
- # @return [String, nil]
146
- optional :doc_url, String, nil?: true
147
-
148
- # @!attribute message
149
- # Human-readable error message
150
- #
151
- # @return [String, nil]
152
- optional :message, String
153
-
154
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
155
- # Error information
156
- #
157
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
158
- #
159
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
160
- #
161
- # @param doc_url [String, nil] URL to documentation about this error
162
- #
163
- # @param message [String] Human-readable error message
164
- end
165
-
166
- # @see Sentdm::Models::TemplateRetrieveResponse#meta
167
- class Meta < Sentdm::Internal::Type::BaseModel
168
- # @!attribute request_id
169
- # Unique identifier for this request (for tracing and support)
170
- #
171
- # @return [String, nil]
172
- optional :request_id, String
173
-
174
- # @!attribute timestamp
175
- # Server timestamp when the response was generated
176
- #
177
- # @return [Time, nil]
178
- optional :timestamp, Time
179
-
180
- # @!attribute version
181
- # API version used for this request
182
- #
183
- # @return [String, nil]
184
- optional :version, String
185
-
186
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
187
- # Request and response metadata
188
- #
189
- # @param request_id [String] Unique identifier for this request (for tracing and support)
190
- #
191
- # @param timestamp [Time] Server timestamp when the response was generated
192
- #
193
- # @param version [String] API version used for this request
194
- end
195
- end
196
- end
197
- end
@@ -1,197 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Templates#update
6
- class TemplateUpdateResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # Template response for v3 API
9
- #
10
- # @return [Sentdm::Models::TemplateUpdateResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::TemplateUpdateResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::TemplateUpdateResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::TemplateUpdateResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::TemplateUpdateResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::TemplateUpdateResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::TemplateUpdateResponse::Data, nil] Template response for v3 API
35
- #
36
- # @param error [Sentdm::Models::TemplateUpdateResponse::Error, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::TemplateUpdateResponse::Meta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::TemplateUpdateResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute id
45
- # Unique template identifier
46
- #
47
- # @return [String, nil]
48
- optional :id, String
49
-
50
- # @!attribute category
51
- # Template category: MARKETING, UTILITY, AUTHENTICATION
52
- #
53
- # @return [String, nil]
54
- optional :category, String
55
-
56
- # @!attribute channels
57
- # Supported channels: sms, whatsapp
58
- #
59
- # @return [Array<String>, nil]
60
- optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
61
-
62
- # @!attribute created_at
63
- # When the template was created
64
- #
65
- # @return [Time, nil]
66
- optional :created_at, Time
67
-
68
- # @!attribute is_published
69
- # Whether the template is published and active
70
- #
71
- # @return [Boolean, nil]
72
- optional :is_published, Sentdm::Internal::Type::Boolean
73
-
74
- # @!attribute language
75
- # Template language code (e.g., en_US)
76
- #
77
- # @return [String, nil]
78
- optional :language, String
79
-
80
- # @!attribute name
81
- # Template display name
82
- #
83
- # @return [String, nil]
84
- optional :name, String
85
-
86
- # @!attribute status
87
- # Template status: APPROVED, PENDING, REJECTED
88
- #
89
- # @return [String, nil]
90
- optional :status, String
91
-
92
- # @!attribute updated_at
93
- # When the template was last updated
94
- #
95
- # @return [Time, nil]
96
- optional :updated_at, Time, nil?: true
97
-
98
- # @!attribute variables
99
- # Template variables for personalization
100
- #
101
- # @return [Array<String>, nil]
102
- optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
103
-
104
- # @!method initialize(id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
105
- # Template response for v3 API
106
- #
107
- # @param id [String] Unique template identifier
108
- #
109
- # @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
110
- #
111
- # @param channels [Array<String>, nil] Supported channels: sms, whatsapp
112
- #
113
- # @param created_at [Time] When the template was created
114
- #
115
- # @param is_published [Boolean] Whether the template is published and active
116
- #
117
- # @param language [String] Template language code (e.g., en_US)
118
- #
119
- # @param name [String] Template display name
120
- #
121
- # @param status [String] Template status: APPROVED, PENDING, REJECTED
122
- #
123
- # @param updated_at [Time, nil] When the template was last updated
124
- #
125
- # @param variables [Array<String>, nil] Template variables for personalization
126
- end
127
-
128
- # @see Sentdm::Models::TemplateUpdateResponse#error
129
- class Error < Sentdm::Internal::Type::BaseModel
130
- # @!attribute code
131
- # Machine-readable error code (e.g., "RESOURCE_001")
132
- #
133
- # @return [String, nil]
134
- optional :code, String
135
-
136
- # @!attribute details
137
- # Additional validation error details (field-level errors)
138
- #
139
- # @return [Hash{Symbol=>Array<String>}, nil]
140
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
141
-
142
- # @!attribute doc_url
143
- # URL to documentation about this error
144
- #
145
- # @return [String, nil]
146
- optional :doc_url, String, nil?: true
147
-
148
- # @!attribute message
149
- # Human-readable error message
150
- #
151
- # @return [String, nil]
152
- optional :message, String
153
-
154
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
155
- # Error information
156
- #
157
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
158
- #
159
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
160
- #
161
- # @param doc_url [String, nil] URL to documentation about this error
162
- #
163
- # @param message [String] Human-readable error message
164
- end
165
-
166
- # @see Sentdm::Models::TemplateUpdateResponse#meta
167
- class Meta < Sentdm::Internal::Type::BaseModel
168
- # @!attribute request_id
169
- # Unique identifier for this request (for tracing and support)
170
- #
171
- # @return [String, nil]
172
- optional :request_id, String
173
-
174
- # @!attribute timestamp
175
- # Server timestamp when the response was generated
176
- #
177
- # @return [Time, nil]
178
- optional :timestamp, Time
179
-
180
- # @!attribute version
181
- # API version used for this request
182
- #
183
- # @return [String, nil]
184
- optional :version, String
185
-
186
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
187
- # Request and response metadata
188
- #
189
- # @param request_id [String] Unique identifier for this request (for tracing and support)
190
- #
191
- # @param timestamp [Time] Server timestamp when the response was generated
192
- #
193
- # @param version [String] API version used for this request
194
- end
195
- end
196
- end
197
- end
@@ -1,189 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Users#invite
6
- class UserInviteResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # User response for v3 API
9
- #
10
- # @return [Sentdm::Models::UserInviteResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::UserInviteResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::UserInviteResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::UserInviteResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::UserInviteResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::UserInviteResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::UserInviteResponse::Data, nil] User response for v3 API
35
- #
36
- # @param error [Sentdm::Models::UserInviteResponse::Error, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::UserInviteResponse::Meta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::UserInviteResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute id
45
- # User unique identifier
46
- #
47
- # @return [String, nil]
48
- optional :id, String
49
-
50
- # @!attribute created_at
51
- # When the user was added to the organization
52
- #
53
- # @return [Time, nil]
54
- optional :created_at, Time
55
-
56
- # @!attribute email
57
- # User email address
58
- #
59
- # @return [String, nil]
60
- optional :email, String
61
-
62
- # @!attribute invited_at
63
- # When the user was invited
64
- #
65
- # @return [Time, nil]
66
- optional :invited_at, Time, nil?: true
67
-
68
- # @!attribute last_login_at
69
- # When the user last logged in
70
- #
71
- # @return [Time, nil]
72
- optional :last_login_at, Time, nil?: true
73
-
74
- # @!attribute name
75
- # User full name
76
- #
77
- # @return [String, nil]
78
- optional :name, String
79
-
80
- # @!attribute role
81
- # User role in the organization: admin, billing, developer
82
- #
83
- # @return [String, nil]
84
- optional :role, String
85
-
86
- # @!attribute status
87
- # User status: active, invited, suspended, rejected
88
- #
89
- # @return [String, nil]
90
- optional :status, String
91
-
92
- # @!attribute updated_at
93
- # When the user record was last updated
94
- #
95
- # @return [Time, nil]
96
- optional :updated_at, Time, nil?: true
97
-
98
- # @!method initialize(id: nil, created_at: nil, email: nil, invited_at: nil, last_login_at: nil, name: nil, role: nil, status: nil, updated_at: nil)
99
- # User response for v3 API
100
- #
101
- # @param id [String] User unique identifier
102
- #
103
- # @param created_at [Time] When the user was added to the organization
104
- #
105
- # @param email [String] User email address
106
- #
107
- # @param invited_at [Time, nil] When the user was invited
108
- #
109
- # @param last_login_at [Time, nil] When the user last logged in
110
- #
111
- # @param name [String] User full name
112
- #
113
- # @param role [String] User role in the organization: admin, billing, developer
114
- #
115
- # @param status [String] User status: active, invited, suspended, rejected
116
- #
117
- # @param updated_at [Time, nil] When the user record was last updated
118
- end
119
-
120
- # @see Sentdm::Models::UserInviteResponse#error
121
- class Error < Sentdm::Internal::Type::BaseModel
122
- # @!attribute code
123
- # Machine-readable error code (e.g., "RESOURCE_001")
124
- #
125
- # @return [String, nil]
126
- optional :code, String
127
-
128
- # @!attribute details
129
- # Additional validation error details (field-level errors)
130
- #
131
- # @return [Hash{Symbol=>Array<String>}, nil]
132
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
133
-
134
- # @!attribute doc_url
135
- # URL to documentation about this error
136
- #
137
- # @return [String, nil]
138
- optional :doc_url, String, nil?: true
139
-
140
- # @!attribute message
141
- # Human-readable error message
142
- #
143
- # @return [String, nil]
144
- optional :message, String
145
-
146
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
147
- # Error information
148
- #
149
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
150
- #
151
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
152
- #
153
- # @param doc_url [String, nil] URL to documentation about this error
154
- #
155
- # @param message [String] Human-readable error message
156
- end
157
-
158
- # @see Sentdm::Models::UserInviteResponse#meta
159
- class Meta < Sentdm::Internal::Type::BaseModel
160
- # @!attribute request_id
161
- # Unique identifier for this request (for tracing and support)
162
- #
163
- # @return [String, nil]
164
- optional :request_id, String
165
-
166
- # @!attribute timestamp
167
- # Server timestamp when the response was generated
168
- #
169
- # @return [Time, nil]
170
- optional :timestamp, Time
171
-
172
- # @!attribute version
173
- # API version used for this request
174
- #
175
- # @return [String, nil]
176
- optional :version, String
177
-
178
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
179
- # Request and response metadata
180
- #
181
- # @param request_id [String] Unique identifier for this request (for tracing and support)
182
- #
183
- # @param timestamp [Time] Server timestamp when the response was generated
184
- #
185
- # @param version [String] API version used for this request
186
- end
187
- end
188
- end
189
- end