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::WebhookListEventsResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::WebhookListEventsResponse::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::WebhookListEventsResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::WebhookListEventsResponse::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::WebhookListEventsResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::WebhookListEventsResponse::Error, nil] Error information
36
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::WebhookListEventsResponse::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
 
@@ -50,15 +50,15 @@ module Sentdm
50
50
  # @!attribute pagination
51
51
  # Pagination metadata for list responses
52
52
  #
53
- # @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination, nil]
54
- optional :pagination, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination }
53
+ # @return [Sentdm::Models::PaginationMeta, nil]
54
+ optional :pagination, -> { Sentdm::PaginationMeta }
55
55
 
56
56
  # @!method initialize(events: nil, pagination: nil)
57
57
  # The response data (null if error)
58
58
  #
59
59
  # @param events [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>]
60
60
  #
61
- # @param pagination [Sentdm::Models::WebhookListEventsResponse::Data::Pagination] Pagination metadata for list responses
61
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
62
62
 
63
63
  class Event < Sentdm::Internal::Type::BaseModel
64
64
  # @!attribute id
@@ -129,150 +129,6 @@ module Sentdm
129
129
  # @param processing_started_at [Time, nil]
130
130
  # @param response_body [String, nil]
131
131
  end
132
-
133
- # @see Sentdm::Models::WebhookListEventsResponse::Data#pagination
134
- class Pagination < Sentdm::Internal::Type::BaseModel
135
- # @!attribute cursors
136
- # Cursor-based pagination pointers
137
- #
138
- # @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil]
139
- optional :cursors, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors }, nil?: true
140
-
141
- # @!attribute has_more
142
- # Whether there are more pages after this one
143
- #
144
- # @return [Boolean, nil]
145
- optional :has_more, Sentdm::Internal::Type::Boolean
146
-
147
- # @!attribute page
148
- # Current page number (1-indexed)
149
- #
150
- # @return [Integer, nil]
151
- optional :page, Integer
152
-
153
- # @!attribute page_size
154
- # Number of items per page
155
- #
156
- # @return [Integer, nil]
157
- optional :page_size, Integer
158
-
159
- # @!attribute total_count
160
- # Total number of items across all pages
161
- #
162
- # @return [Integer, nil]
163
- optional :total_count, Integer
164
-
165
- # @!attribute total_pages
166
- # Total number of pages
167
- #
168
- # @return [Integer, nil]
169
- optional :total_pages, Integer
170
-
171
- # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
172
- # Pagination metadata for list responses
173
- #
174
- # @param cursors [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil] Cursor-based pagination pointers
175
- #
176
- # @param has_more [Boolean] Whether there are more pages after this one
177
- #
178
- # @param page [Integer] Current page number (1-indexed)
179
- #
180
- # @param page_size [Integer] Number of items per page
181
- #
182
- # @param total_count [Integer] Total number of items across all pages
183
- #
184
- # @param total_pages [Integer] Total number of pages
185
-
186
- # @see Sentdm::Models::WebhookListEventsResponse::Data::Pagination#cursors
187
- class Cursors < Sentdm::Internal::Type::BaseModel
188
- # @!attribute after
189
- # Cursor to fetch the next page
190
- #
191
- # @return [String, nil]
192
- optional :after, String, nil?: true
193
-
194
- # @!attribute before
195
- # Cursor to fetch the previous page
196
- #
197
- # @return [String, nil]
198
- optional :before, String, nil?: true
199
-
200
- # @!method initialize(after: nil, before: nil)
201
- # Cursor-based pagination pointers
202
- #
203
- # @param after [String, nil] Cursor to fetch the next page
204
- #
205
- # @param before [String, nil] Cursor to fetch the previous page
206
- end
207
- end
208
- end
209
-
210
- # @see Sentdm::Models::WebhookListEventsResponse#error
211
- class Error < Sentdm::Internal::Type::BaseModel
212
- # @!attribute code
213
- # Machine-readable error code (e.g., "RESOURCE_001")
214
- #
215
- # @return [String, nil]
216
- optional :code, String
217
-
218
- # @!attribute details
219
- # Additional validation error details (field-level errors)
220
- #
221
- # @return [Hash{Symbol=>Array<String>}, nil]
222
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
223
-
224
- # @!attribute doc_url
225
- # URL to documentation about this error
226
- #
227
- # @return [String, nil]
228
- optional :doc_url, String, nil?: true
229
-
230
- # @!attribute message
231
- # Human-readable error message
232
- #
233
- # @return [String, nil]
234
- optional :message, String
235
-
236
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
237
- # Error information
238
- #
239
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
240
- #
241
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
242
- #
243
- # @param doc_url [String, nil] URL to documentation about this error
244
- #
245
- # @param message [String] Human-readable error message
246
- end
247
-
248
- # @see Sentdm::Models::WebhookListEventsResponse#meta
249
- class Meta < Sentdm::Internal::Type::BaseModel
250
- # @!attribute request_id
251
- # Unique identifier for this request (for tracing and support)
252
- #
253
- # @return [String, nil]
254
- optional :request_id, String
255
-
256
- # @!attribute timestamp
257
- # Server timestamp when the response was generated
258
- #
259
- # @return [Time, nil]
260
- optional :timestamp, Time
261
-
262
- # @!attribute version
263
- # API version used for this request
264
- #
265
- # @return [String, nil]
266
- optional :version, String
267
-
268
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
269
- # Request and response metadata
270
- #
271
- # @param request_id [String] Unique identifier for this request (for tracing and support)
272
- #
273
- # @param timestamp [Time] Server timestamp when the response was generated
274
- #
275
- # @param version [String] API version used for this request
276
132
  end
277
133
  end
278
134
  end
@@ -13,14 +13,14 @@ module Sentdm
13
13
  # @!attribute error
14
14
  # Error information
15
15
  #
16
- # @return [Sentdm::Models::WebhookListResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::WebhookListResponse::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::WebhookListResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::WebhookListResponse::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::WebhookListResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::WebhookListResponse::Error, nil] Error information
36
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::WebhookListResponse::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,255 +44,20 @@ module Sentdm
44
44
  # @!attribute pagination
45
45
  # Pagination metadata for list responses
46
46
  #
47
- # @return [Sentdm::Models::WebhookListResponse::Data::Pagination, nil]
48
- optional :pagination, -> { Sentdm::Models::WebhookListResponse::Data::Pagination }
47
+ # @return [Sentdm::Models::PaginationMeta, nil]
48
+ optional :pagination, -> { Sentdm::PaginationMeta }
49
49
 
50
50
  # @!attribute webhooks
51
51
  #
52
- # @return [Array<Sentdm::Models::WebhookListResponse::Data::Webhook>, nil]
53
- optional :webhooks,
54
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::WebhookListResponse::Data::Webhook] }
52
+ # @return [Array<Sentdm::Models::WebhookResponse>, nil]
53
+ optional :webhooks, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookResponse] }
55
54
 
56
55
  # @!method initialize(pagination: nil, webhooks: nil)
57
56
  # The response data (null if error)
58
57
  #
59
- # @param pagination [Sentdm::Models::WebhookListResponse::Data::Pagination] Pagination metadata for list responses
58
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
60
59
  #
61
- # @param webhooks [Array<Sentdm::Models::WebhookListResponse::Data::Webhook>]
62
-
63
- # @see Sentdm::Models::WebhookListResponse::Data#pagination
64
- class Pagination < Sentdm::Internal::Type::BaseModel
65
- # @!attribute cursors
66
- # Cursor-based pagination pointers
67
- #
68
- # @return [Sentdm::Models::WebhookListResponse::Data::Pagination::Cursors, nil]
69
- optional :cursors, -> { Sentdm::Models::WebhookListResponse::Data::Pagination::Cursors }, nil?: true
70
-
71
- # @!attribute has_more
72
- # Whether there are more pages after this one
73
- #
74
- # @return [Boolean, nil]
75
- optional :has_more, Sentdm::Internal::Type::Boolean
76
-
77
- # @!attribute page
78
- # Current page number (1-indexed)
79
- #
80
- # @return [Integer, nil]
81
- optional :page, Integer
82
-
83
- # @!attribute page_size
84
- # Number of items per page
85
- #
86
- # @return [Integer, nil]
87
- optional :page_size, Integer
88
-
89
- # @!attribute total_count
90
- # Total number of items across all pages
91
- #
92
- # @return [Integer, nil]
93
- optional :total_count, Integer
94
-
95
- # @!attribute total_pages
96
- # Total number of pages
97
- #
98
- # @return [Integer, nil]
99
- optional :total_pages, Integer
100
-
101
- # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
102
- # Pagination metadata for list responses
103
- #
104
- # @param cursors [Sentdm::Models::WebhookListResponse::Data::Pagination::Cursors, nil] Cursor-based pagination pointers
105
- #
106
- # @param has_more [Boolean] Whether there are more pages after this one
107
- #
108
- # @param page [Integer] Current page number (1-indexed)
109
- #
110
- # @param page_size [Integer] Number of items per page
111
- #
112
- # @param total_count [Integer] Total number of items across all pages
113
- #
114
- # @param total_pages [Integer] Total number of pages
115
-
116
- # @see Sentdm::Models::WebhookListResponse::Data::Pagination#cursors
117
- class Cursors < Sentdm::Internal::Type::BaseModel
118
- # @!attribute after
119
- # Cursor to fetch the next page
120
- #
121
- # @return [String, nil]
122
- optional :after, String, nil?: true
123
-
124
- # @!attribute before
125
- # Cursor to fetch the previous page
126
- #
127
- # @return [String, nil]
128
- optional :before, String, nil?: true
129
-
130
- # @!method initialize(after: nil, before: nil)
131
- # Cursor-based pagination pointers
132
- #
133
- # @param after [String, nil] Cursor to fetch the next page
134
- #
135
- # @param before [String, nil] Cursor to fetch the previous page
136
- end
137
- end
138
-
139
- class Webhook < Sentdm::Internal::Type::BaseModel
140
- # @!attribute id
141
- #
142
- # @return [String, nil]
143
- optional :id, String
144
-
145
- # @!attribute consecutive_failures
146
- #
147
- # @return [Integer, nil]
148
- optional :consecutive_failures, Integer
149
-
150
- # @!attribute created_at
151
- #
152
- # @return [Time, nil]
153
- optional :created_at, Time
154
-
155
- # @!attribute display_name
156
- #
157
- # @return [String, nil]
158
- optional :display_name, String
159
-
160
- # @!attribute endpoint_url
161
- #
162
- # @return [String, nil]
163
- optional :endpoint_url, String
164
-
165
- # @!attribute event_filters
166
- #
167
- # @return [Hash{Symbol=>Array<String>}, nil]
168
- optional :event_filters,
169
- Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
170
- nil?: true
171
-
172
- # @!attribute event_types
173
- #
174
- # @return [Array<String>, nil]
175
- optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
176
-
177
- # @!attribute is_active
178
- #
179
- # @return [Boolean, nil]
180
- optional :is_active, Sentdm::Internal::Type::Boolean
181
-
182
- # @!attribute last_delivery_attempt_at
183
- #
184
- # @return [Time, nil]
185
- optional :last_delivery_attempt_at, Time, nil?: true
186
-
187
- # @!attribute last_successful_delivery_at
188
- #
189
- # @return [Time, nil]
190
- optional :last_successful_delivery_at, Time, nil?: true
191
-
192
- # @!attribute retry_count
193
- #
194
- # @return [Integer, nil]
195
- optional :retry_count, Integer
196
-
197
- # @!attribute signing_secret
198
- #
199
- # @return [String, nil]
200
- optional :signing_secret, String, nil?: true
201
-
202
- # @!attribute timeout_seconds
203
- #
204
- # @return [Integer, nil]
205
- optional :timeout_seconds, Integer
206
-
207
- # @!attribute updated_at
208
- #
209
- # @return [Time, nil]
210
- optional :updated_at, Time, nil?: true
211
-
212
- # @!method initialize(id: nil, consecutive_failures: nil, created_at: nil, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, is_active: nil, last_delivery_attempt_at: nil, last_successful_delivery_at: nil, retry_count: nil, signing_secret: nil, timeout_seconds: nil, updated_at: nil)
213
- # @param id [String]
214
- # @param consecutive_failures [Integer]
215
- # @param created_at [Time]
216
- # @param display_name [String]
217
- # @param endpoint_url [String]
218
- # @param event_filters [Hash{Symbol=>Array<String>}, nil]
219
- # @param event_types [Array<String>]
220
- # @param is_active [Boolean]
221
- # @param last_delivery_attempt_at [Time, nil]
222
- # @param last_successful_delivery_at [Time, nil]
223
- # @param retry_count [Integer]
224
- # @param signing_secret [String, nil]
225
- # @param timeout_seconds [Integer]
226
- # @param updated_at [Time, nil]
227
- end
228
- end
229
-
230
- # @see Sentdm::Models::WebhookListResponse#error
231
- class Error < Sentdm::Internal::Type::BaseModel
232
- # @!attribute code
233
- # Machine-readable error code (e.g., "RESOURCE_001")
234
- #
235
- # @return [String, nil]
236
- optional :code, String
237
-
238
- # @!attribute details
239
- # Additional validation error details (field-level errors)
240
- #
241
- # @return [Hash{Symbol=>Array<String>}, nil]
242
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
243
-
244
- # @!attribute doc_url
245
- # URL to documentation about this error
246
- #
247
- # @return [String, nil]
248
- optional :doc_url, String, nil?: true
249
-
250
- # @!attribute message
251
- # Human-readable error message
252
- #
253
- # @return [String, nil]
254
- optional :message, String
255
-
256
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
257
- # Error information
258
- #
259
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
260
- #
261
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
262
- #
263
- # @param doc_url [String, nil] URL to documentation about this error
264
- #
265
- # @param message [String] Human-readable error message
266
- end
267
-
268
- # @see Sentdm::Models::WebhookListResponse#meta
269
- class Meta < Sentdm::Internal::Type::BaseModel
270
- # @!attribute request_id
271
- # Unique identifier for this request (for tracing and support)
272
- #
273
- # @return [String, nil]
274
- optional :request_id, String
275
-
276
- # @!attribute timestamp
277
- # Server timestamp when the response was generated
278
- #
279
- # @return [Time, nil]
280
- optional :timestamp, Time
281
-
282
- # @!attribute version
283
- # API version used for this request
284
- #
285
- # @return [String, nil]
286
- optional :version, String
287
-
288
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
289
- # Request and response metadata
290
- #
291
- # @param request_id [String] Unique identifier for this request (for tracing and support)
292
- #
293
- # @param timestamp [Time] Server timestamp when the response was generated
294
- #
295
- # @param version [String] API version used for this request
60
+ # @param webhooks [Array<Sentdm::Models::WebhookResponse>]
296
61
  end
297
62
  end
298
63
  end
@@ -0,0 +1,95 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class WebhookResponse < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute id
7
+ #
8
+ # @return [String, nil]
9
+ optional :id, String
10
+
11
+ # @!attribute consecutive_failures
12
+ #
13
+ # @return [Integer, nil]
14
+ optional :consecutive_failures, Integer
15
+
16
+ # @!attribute created_at
17
+ #
18
+ # @return [Time, nil]
19
+ optional :created_at, Time
20
+
21
+ # @!attribute display_name
22
+ #
23
+ # @return [String, nil]
24
+ optional :display_name, String
25
+
26
+ # @!attribute endpoint_url
27
+ #
28
+ # @return [String, nil]
29
+ optional :endpoint_url, String
30
+
31
+ # @!attribute event_filters
32
+ #
33
+ # @return [Hash{Symbol=>Array<String>}, nil]
34
+ optional :event_filters,
35
+ Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
36
+ nil?: true
37
+
38
+ # @!attribute event_types
39
+ #
40
+ # @return [Array<String>, nil]
41
+ optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
42
+
43
+ # @!attribute is_active
44
+ #
45
+ # @return [Boolean, nil]
46
+ optional :is_active, Sentdm::Internal::Type::Boolean
47
+
48
+ # @!attribute last_delivery_attempt_at
49
+ #
50
+ # @return [Time, nil]
51
+ optional :last_delivery_attempt_at, Time, nil?: true
52
+
53
+ # @!attribute last_successful_delivery_at
54
+ #
55
+ # @return [Time, nil]
56
+ optional :last_successful_delivery_at, Time, nil?: true
57
+
58
+ # @!attribute retry_count
59
+ #
60
+ # @return [Integer, nil]
61
+ optional :retry_count, Integer
62
+
63
+ # @!attribute signing_secret
64
+ #
65
+ # @return [String, nil]
66
+ optional :signing_secret, String, nil?: true
67
+
68
+ # @!attribute timeout_seconds
69
+ #
70
+ # @return [Integer, nil]
71
+ optional :timeout_seconds, Integer
72
+
73
+ # @!attribute updated_at
74
+ #
75
+ # @return [Time, nil]
76
+ optional :updated_at, Time, nil?: true
77
+
78
+ # @!method initialize(id: nil, consecutive_failures: nil, created_at: nil, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, is_active: nil, last_delivery_attempt_at: nil, last_successful_delivery_at: nil, retry_count: nil, signing_secret: nil, timeout_seconds: nil, updated_at: nil)
79
+ # @param id [String]
80
+ # @param consecutive_failures [Integer]
81
+ # @param created_at [Time]
82
+ # @param display_name [String]
83
+ # @param endpoint_url [String]
84
+ # @param event_filters [Hash{Symbol=>Array<String>}, nil]
85
+ # @param event_types [Array<String>]
86
+ # @param is_active [Boolean]
87
+ # @param last_delivery_attempt_at [Time, nil]
88
+ # @param last_successful_delivery_at [Time, nil]
89
+ # @param retry_count [Integer]
90
+ # @param signing_secret [String, nil]
91
+ # @param timeout_seconds [Integer]
92
+ # @param updated_at [Time, nil]
93
+ end
94
+ end
95
+ end
@@ -3,7 +3,7 @@
3
3
  module Sentdm
4
4
  module Models
5
5
  # @see Sentdm::Resources::Webhooks#rotate_secret
6
- class WebhookRotateSecretParams < Sentdm::Internal::Type::BaseModel
6
+ class WebhookRotateSecretParams < Sentdm::Models::MutationRequest
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
@@ -12,13 +12,6 @@ module Sentdm
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!attribute sandbox
16
- # Sandbox flag - when true, the operation is simulated without side effects Useful
17
- # for testing integrations without actual execution
18
- #
19
- # @return [Boolean, nil]
20
- optional :sandbox, Sentdm::Internal::Type::Boolean
21
-
22
15
  # @!attribute idempotency_key
23
16
  #
24
17
  # @return [String, nil]
@@ -29,18 +22,10 @@ module Sentdm
29
22
  # @return [String, nil]
30
23
  optional :x_profile_id, String
31
24
 
32
- # @!method initialize(id:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
33
- # Some parameter documentations has been truncated, see
34
- # {Sentdm::Models::WebhookRotateSecretParams} for more details.
35
- #
25
+ # @!method initialize(id:, idempotency_key: nil, x_profile_id: nil, request_options: {})
36
26
  # @param id [String]
37
- #
38
- # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
39
- #
40
27
  # @param idempotency_key [String]
41
- #
42
28
  # @param x_profile_id [String]
43
- #
44
29
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
45
30
  end
46
31
  end