sentdm 0.29.0 → 0.31.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 (298) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +24 -0
  3. data/README.md +55 -1
  4. data/lib/sentdm/internal/contacts_page.rb +115 -0
  5. data/lib/sentdm/internal/conversations_page.rb +115 -0
  6. data/lib/sentdm/internal/templates_page.rb +115 -0
  7. data/lib/sentdm/internal/type/base_model.rb +5 -5
  8. data/lib/sentdm/internal/webhook_events_page.rb +115 -0
  9. data/lib/sentdm/internal/webhooks_page.rb +115 -0
  10. data/lib/sentdm/models/api_meta.rb +34 -0
  11. data/lib/sentdm/models/api_response_of_contact.rb +46 -0
  12. data/lib/sentdm/models/api_response_of_contact_message_summary.rb +43 -0
  13. data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +42 -0
  14. data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
  15. data/lib/sentdm/models/api_response_of_user.rb +43 -0
  16. data/lib/sentdm/models/api_response_template.rb +43 -0
  17. data/lib/sentdm/models/api_response_webhook.rb +43 -0
  18. data/lib/sentdm/models/billing_contact_info.rb +47 -0
  19. data/lib/sentdm/models/brand_business_info.rb +114 -0
  20. data/lib/sentdm/models/brand_compliance_info.rb +59 -0
  21. data/lib/sentdm/models/brand_contact_info.rb +58 -0
  22. data/lib/sentdm/models/brands_brand_data.rb +34 -0
  23. data/lib/sentdm/models/contact_delete_params.rb +2 -16
  24. data/lib/sentdm/models/contact_list_params.rb +13 -13
  25. data/lib/sentdm/models/contact_message_summary.rb +76 -0
  26. data/lib/sentdm/models/contact_response.rb +140 -0
  27. data/lib/sentdm/models/conversation_list_messages_params.rb +5 -5
  28. data/lib/sentdm/models/conversation_list_params.rb +5 -5
  29. data/lib/sentdm/models/conversation_messages_list.rb +245 -0
  30. data/lib/sentdm/models/error_detail.rb +42 -0
  31. data/lib/sentdm/models/me_retrieve_response.rb +12 -242
  32. data/lib/sentdm/models/message_retrieve_activities_response.rb +9 -159
  33. data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
  34. data/lib/sentdm/models/message_send_response.rb +6 -74
  35. data/lib/sentdm/models/mutation_request.rb +20 -0
  36. data/lib/sentdm/models/number_lookup_response.rb +6 -74
  37. data/lib/sentdm/models/pagination_meta.rb +84 -0
  38. data/lib/sentdm/models/payment_details.rb +40 -0
  39. data/lib/sentdm/models/profile_complete_response.rb +6 -74
  40. data/lib/sentdm/models/profile_create_params.rb +9 -345
  41. data/lib/sentdm/models/profile_delete_params.rb +2 -16
  42. data/lib/sentdm/models/profile_detail.rb +650 -0
  43. data/lib/sentdm/models/profile_list_response.rb +12 -815
  44. data/lib/sentdm/models/profile_settings.rb +85 -0
  45. data/lib/sentdm/models/profile_update_params.rb +9 -345
  46. data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +45 -0
  47. data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +45 -0
  48. data/lib/sentdm/models/profiles/brand_campaign.rb +247 -0
  49. data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -156
  50. data/lib/sentdm/models/profiles/campaign_data.rb +136 -0
  51. data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
  52. data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -156
  53. data/lib/sentdm/models/profiles/campaign_use_case.rb +71 -0
  54. data/lib/sentdm/models/profiles/campaign_use_case_data.rb +29 -0
  55. data/lib/sentdm/models/template.rb +103 -0
  56. data/lib/sentdm/models/template_list_params.rb +17 -17
  57. data/lib/sentdm/models/user_list_response.rb +12 -249
  58. data/lib/sentdm/models/user_remove_params.rb +2 -16
  59. data/lib/sentdm/models/user_response.rb +94 -0
  60. data/lib/sentdm/models/webhook_event_type.rb +45 -0
  61. data/lib/sentdm/models/webhook_list_event_types_response.rb +12 -203
  62. data/lib/sentdm/models/webhook_list_events_params.rb +5 -5
  63. data/lib/sentdm/models/webhook_list_events_response.rb +87 -295
  64. data/lib/sentdm/models/webhook_list_params.rb +11 -11
  65. data/lib/sentdm/models/webhook_response.rb +121 -0
  66. data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
  67. data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
  68. data/lib/sentdm/models/webhook_test_response.rb +6 -74
  69. data/lib/sentdm/models.rb +52 -0
  70. data/lib/sentdm/resources/contacts.rb +16 -15
  71. data/lib/sentdm/resources/conversations.rb +10 -8
  72. data/lib/sentdm/resources/profiles/campaigns.rb +8 -8
  73. data/lib/sentdm/resources/profiles.rb +12 -12
  74. data/lib/sentdm/resources/templates.rb +16 -15
  75. data/lib/sentdm/resources/users.rb +6 -6
  76. data/lib/sentdm/resources/webhooks.rb +20 -18
  77. data/lib/sentdm/version.rb +1 -1
  78. data/lib/sentdm.rb +37 -25
  79. data/rbi/sentdm/internal/contacts_page.rbi +71 -0
  80. data/rbi/sentdm/internal/conversations_page.rbi +71 -0
  81. data/rbi/sentdm/internal/templates_page.rbi +71 -0
  82. data/rbi/sentdm/internal/webhook_events_page.rbi +71 -0
  83. data/rbi/sentdm/internal/webhooks_page.rbi +71 -0
  84. data/rbi/sentdm/models/api_meta.rbi +55 -0
  85. data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
  86. data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi +79 -0
  87. data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +79 -0
  88. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
  89. data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
  90. data/rbi/sentdm/models/api_response_template.rbi +74 -0
  91. data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
  92. data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
  93. data/rbi/sentdm/models/brand_business_info.rbi +162 -0
  94. data/rbi/sentdm/models/brand_compliance_info.rbi +76 -0
  95. data/rbi/sentdm/models/brand_contact_info.rbi +78 -0
  96. data/rbi/sentdm/models/brands_brand_data.rbi +65 -0
  97. data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
  98. data/rbi/sentdm/models/contact_list_params.rbi +19 -13
  99. data/rbi/sentdm/models/contact_message_summary.rbi +144 -0
  100. data/rbi/sentdm/models/contact_response.rbi +200 -0
  101. data/rbi/sentdm/models/conversation_list_messages_params.rbi +12 -6
  102. data/rbi/sentdm/models/conversation_list_params.rbi +16 -5
  103. data/rbi/sentdm/models/conversation_messages_list.rbi +419 -0
  104. data/rbi/sentdm/models/error_detail.rbi +66 -0
  105. data/rbi/sentdm/models/me_retrieve_response.rbi +16 -367
  106. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +12 -325
  107. data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
  108. data/rbi/sentdm/models/message_send_response.rbi +8 -135
  109. data/rbi/sentdm/models/mutation_request.rbi +32 -0
  110. data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
  111. data/rbi/sentdm/models/pagination_meta.rbi +135 -0
  112. data/rbi/sentdm/models/payment_details.rbi +56 -0
  113. data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
  114. data/rbi/sentdm/models/profile_create_params.rbi +12 -546
  115. data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
  116. data/rbi/sentdm/models/profile_detail.rbi +918 -0
  117. data/rbi/sentdm/models/profile_list_response.rbi +16 -1347
  118. data/rbi/sentdm/models/profile_settings.rbi +102 -0
  119. data/rbi/sentdm/models/profile_update_params.rbi +12 -546
  120. data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +81 -0
  121. data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +76 -0
  122. data/rbi/sentdm/models/profiles/brand_campaign.rbi +299 -0
  123. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -218
  124. data/rbi/sentdm/models/profiles/campaign_data.rbi +158 -0
  125. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
  126. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -218
  127. data/rbi/sentdm/models/profiles/campaign_use_case.rbi +110 -0
  128. data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +51 -0
  129. data/rbi/sentdm/models/template.rbi +139 -0
  130. data/rbi/sentdm/models/template_list_params.rbi +22 -16
  131. data/rbi/sentdm/models/user_list_response.rbi +16 -444
  132. data/rbi/sentdm/models/user_remove_params.rbi +2 -19
  133. data/rbi/sentdm/models/user_response.rbi +131 -0
  134. data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
  135. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +16 -414
  136. data/rbi/sentdm/models/webhook_list_events_params.rbi +12 -6
  137. data/rbi/sentdm/models/webhook_list_events_response.rbi +113 -564
  138. data/rbi/sentdm/models/webhook_list_params.rbi +16 -10
  139. data/rbi/sentdm/models/webhook_response.rbi +153 -0
  140. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
  141. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
  142. data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
  143. data/rbi/sentdm/models.rbi +54 -0
  144. data/rbi/sentdm/resources/contacts.rbi +10 -10
  145. data/rbi/sentdm/resources/conversations.rbi +14 -6
  146. data/rbi/sentdm/resources/profiles/campaigns.rbi +5 -5
  147. data/rbi/sentdm/resources/profiles.rbi +9 -13
  148. data/rbi/sentdm/resources/templates.rbi +10 -10
  149. data/rbi/sentdm/resources/users.rbi +3 -3
  150. data/rbi/sentdm/resources/webhooks.rbi +16 -12
  151. data/sig/sentdm/internal/contacts_page.rbs +41 -0
  152. data/sig/sentdm/internal/conversations_page.rbs +41 -0
  153. data/sig/sentdm/internal/templates_page.rbs +44 -0
  154. data/sig/sentdm/internal/webhook_events_page.rbs +41 -0
  155. data/sig/sentdm/internal/webhooks_page.rbs +41 -0
  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_contact_message_summary.rbs +39 -0
  159. data/sig/sentdm/models/api_response_of_conversation_messages_list.rbs +39 -0
  160. data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
  161. data/sig/sentdm/models/api_response_of_user.rbs +39 -0
  162. data/sig/sentdm/models/api_response_template.rbs +39 -0
  163. data/sig/sentdm/models/api_response_webhook.rbs +39 -0
  164. data/sig/sentdm/models/billing_contact_info.rbs +30 -0
  165. data/sig/sentdm/models/brand_business_info.rbs +89 -0
  166. data/sig/sentdm/models/brand_compliance_info.rbs +45 -0
  167. data/sig/sentdm/models/brand_contact_info.rbs +45 -0
  168. data/sig/sentdm/models/brands_brand_data.rbs +30 -0
  169. data/sig/sentdm/models/contact_delete_params.rbs +6 -10
  170. data/sig/sentdm/models/contact_list_params.rbs +11 -7
  171. data/sig/sentdm/models/contact_message_summary.rbs +84 -0
  172. data/sig/sentdm/models/contact_response.rbs +118 -0
  173. data/sig/sentdm/models/conversation_list_messages_params.rbs +8 -4
  174. data/sig/sentdm/models/conversation_list_params.rbs +8 -4
  175. data/sig/sentdm/models/conversation_messages_list.rbs +240 -0
  176. data/sig/sentdm/models/error_detail.rbs +39 -0
  177. data/sig/sentdm/models/me_retrieve_response.rbs +18 -176
  178. data/sig/sentdm/models/message_retrieve_activities_response.rbs +14 -142
  179. data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
  180. data/sig/sentdm/models/message_send_response.rbs +9 -71
  181. data/sig/sentdm/models/mutation_request.rbs +15 -0
  182. data/sig/sentdm/models/number_lookup_response.rbs +9 -71
  183. data/sig/sentdm/models/pagination_meta.rbs +67 -0
  184. data/sig/sentdm/models/payment_details.rbs +30 -0
  185. data/sig/sentdm/models/profile_complete_response.rbs +9 -71
  186. data/sig/sentdm/models/profile_create_params.rbs +12 -263
  187. data/sig/sentdm/models/profile_delete_params.rbs +6 -10
  188. data/sig/sentdm/models/profile_detail.rbs +461 -0
  189. data/sig/sentdm/models/profile_list_response.rbs +20 -606
  190. data/sig/sentdm/models/profile_settings.rbs +50 -0
  191. data/sig/sentdm/models/profile_update_params.rbs +12 -263
  192. data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +41 -0
  193. data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +41 -0
  194. data/sig/sentdm/models/profiles/brand_campaign.rbs +194 -0
  195. data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -108
  196. data/sig/sentdm/models/profiles/campaign_data.rbs +87 -0
  197. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
  198. data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -108
  199. data/sig/sentdm/models/profiles/campaign_use_case.rbs +66 -0
  200. data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +27 -0
  201. data/sig/sentdm/models/template.rbs +84 -0
  202. data/sig/sentdm/models/template_list_params.rbs +14 -10
  203. data/sig/sentdm/models/user_list_response.rbs +20 -224
  204. data/sig/sentdm/models/user_remove_params.rbs +6 -10
  205. data/sig/sentdm/models/user_response.rbs +79 -0
  206. data/sig/sentdm/models/webhook_event_type.rbs +51 -0
  207. data/sig/sentdm/models/webhook_list_event_types_response.rbs +20 -196
  208. data/sig/sentdm/models/webhook_list_events_params.rbs +8 -4
  209. data/sig/sentdm/models/webhook_list_events_response.rbs +63 -255
  210. data/sig/sentdm/models/webhook_list_params.rbs +11 -7
  211. data/sig/sentdm/models/webhook_response.rbs +110 -0
  212. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
  213. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
  214. data/sig/sentdm/models/webhook_test_response.rbs +9 -71
  215. data/sig/sentdm/models.rbs +52 -0
  216. data/sig/sentdm/resources/contacts.rbs +7 -7
  217. data/sig/sentdm/resources/conversations.rbs +6 -6
  218. data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
  219. data/sig/sentdm/resources/profiles.rbs +9 -9
  220. data/sig/sentdm/resources/templates.rbs +6 -6
  221. data/sig/sentdm/resources/users.rbs +3 -3
  222. data/sig/sentdm/resources/webhooks.rbs +10 -10
  223. metadata +113 -77
  224. data/lib/sentdm/models/contact_create_response.rb +0 -249
  225. data/lib/sentdm/models/contact_list_response.rb +0 -348
  226. data/lib/sentdm/models/contact_retrieve_message_summary_response.rb +0 -186
  227. data/lib/sentdm/models/contact_retrieve_response.rb +0 -249
  228. data/lib/sentdm/models/contact_update_response.rb +0 -249
  229. data/lib/sentdm/models/conversation_list_messages_response.rb +0 -436
  230. data/lib/sentdm/models/conversation_list_response.rb +0 -433
  231. data/lib/sentdm/models/profile_create_response.rb +0 -760
  232. data/lib/sentdm/models/profile_retrieve_response.rb +0 -762
  233. data/lib/sentdm/models/profile_update_response.rb +0 -760
  234. data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -420
  235. data/lib/sentdm/models/profiles/campaign_list_response.rb +0 -421
  236. data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -420
  237. data/lib/sentdm/models/template_create_response.rb +0 -209
  238. data/lib/sentdm/models/template_list_response.rb +0 -311
  239. data/lib/sentdm/models/template_retrieve_response.rb +0 -209
  240. data/lib/sentdm/models/template_update_response.rb +0 -209
  241. data/lib/sentdm/models/user_invite_response.rb +0 -201
  242. data/lib/sentdm/models/user_retrieve_response.rb +0 -201
  243. data/lib/sentdm/models/user_update_role_response.rb +0 -201
  244. data/lib/sentdm/models/webhook_create_response.rb +0 -229
  245. data/lib/sentdm/models/webhook_list_response.rb +0 -329
  246. data/lib/sentdm/models/webhook_retrieve_response.rb +0 -229
  247. data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -229
  248. data/lib/sentdm/models/webhook_update_response.rb +0 -229
  249. data/rbi/sentdm/models/contact_create_response.rbi +0 -407
  250. data/rbi/sentdm/models/contact_list_response.rbi +0 -634
  251. data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +0 -397
  252. data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -409
  253. data/rbi/sentdm/models/contact_update_response.rbi +0 -407
  254. data/rbi/sentdm/models/conversation_list_messages_response.rbi +0 -843
  255. data/rbi/sentdm/models/conversation_list_response.rbi +0 -819
  256. data/rbi/sentdm/models/profile_create_response.rbi +0 -1226
  257. data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1230
  258. data/rbi/sentdm/models/profile_update_response.rbi +0 -1226
  259. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -674
  260. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +0 -667
  261. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -674
  262. data/rbi/sentdm/models/template_create_response.rbi +0 -349
  263. data/rbi/sentdm/models/template_list_response.rbi +0 -576
  264. data/rbi/sentdm/models/template_retrieve_response.rbi +0 -355
  265. data/rbi/sentdm/models/template_update_response.rbi +0 -349
  266. data/rbi/sentdm/models/user_invite_response.rbi +0 -336
  267. data/rbi/sentdm/models/user_retrieve_response.rbi +0 -336
  268. data/rbi/sentdm/models/user_update_role_response.rbi +0 -341
  269. data/rbi/sentdm/models/webhook_create_response.rbi +0 -361
  270. data/rbi/sentdm/models/webhook_list_response.rbi +0 -587
  271. data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -363
  272. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -379
  273. data/rbi/sentdm/models/webhook_update_response.rbi +0 -361
  274. data/sig/sentdm/models/contact_create_response.rbs +0 -216
  275. data/sig/sentdm/models/contact_list_response.rbs +0 -310
  276. data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +0 -182
  277. data/sig/sentdm/models/contact_retrieve_response.rbs +0 -216
  278. data/sig/sentdm/models/contact_update_response.rbs +0 -216
  279. data/sig/sentdm/models/conversation_list_messages_response.rbs +0 -404
  280. data/sig/sentdm/models/conversation_list_response.rbs +0 -404
  281. data/sig/sentdm/models/profile_create_response.rbs +0 -559
  282. data/sig/sentdm/models/profile_retrieve_response.rbs +0 -559
  283. data/sig/sentdm/models/profile_update_response.rbs +0 -559
  284. data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -357
  285. data/sig/sentdm/models/profiles/campaign_list_response.rbs +0 -357
  286. data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -357
  287. data/sig/sentdm/models/template_create_response.rbs +0 -182
  288. data/sig/sentdm/models/template_list_response.rbs +0 -276
  289. data/sig/sentdm/models/template_retrieve_response.rbs +0 -182
  290. data/sig/sentdm/models/template_update_response.rbs +0 -182
  291. data/sig/sentdm/models/user_invite_response.rbs +0 -177
  292. data/sig/sentdm/models/user_retrieve_response.rbs +0 -177
  293. data/sig/sentdm/models/user_update_role_response.rbs +0 -177
  294. data/sig/sentdm/models/webhook_create_response.rbs +0 -208
  295. data/sig/sentdm/models/webhook_list_response.rbs +0 -302
  296. data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -208
  297. data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -208
  298. data/sig/sentdm/models/webhook_update_response.rbs +0 -208
@@ -1,363 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class WebhookRetrieveResponse < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(
9
- Sentdm::Models::WebhookRetrieveResponse,
10
- Sentdm::Internal::AnyHash
11
- )
12
- end
13
-
14
- # The response data (null if error)
15
- sig { returns(T.nilable(Sentdm::Models::WebhookRetrieveResponse::Data)) }
16
- attr_reader :data
17
-
18
- sig do
19
- params(
20
- data: T.nilable(Sentdm::Models::WebhookRetrieveResponse::Data::OrHash)
21
- ).void
22
- end
23
- attr_writer :data
24
-
25
- # Error information
26
- sig { returns(T.nilable(Sentdm::Models::WebhookRetrieveResponse::Error)) }
27
- attr_reader :error
28
-
29
- sig do
30
- params(
31
- error:
32
- T.nilable(Sentdm::Models::WebhookRetrieveResponse::Error::OrHash)
33
- ).void
34
- end
35
- attr_writer :error
36
-
37
- # Request and response metadata
38
- sig { returns(T.nilable(Sentdm::Models::WebhookRetrieveResponse::Meta)) }
39
- attr_reader :meta
40
-
41
- sig do
42
- params(meta: Sentdm::Models::WebhookRetrieveResponse::Meta::OrHash).void
43
- end
44
- attr_writer :meta
45
-
46
- # Indicates whether the request was successful
47
- sig { returns(T.nilable(T::Boolean)) }
48
- attr_reader :success
49
-
50
- sig { params(success: T::Boolean).void }
51
- attr_writer :success
52
-
53
- # Standard API response envelope for all v3 endpoints
54
- sig do
55
- params(
56
- data:
57
- T.nilable(Sentdm::Models::WebhookRetrieveResponse::Data::OrHash),
58
- error:
59
- T.nilable(Sentdm::Models::WebhookRetrieveResponse::Error::OrHash),
60
- meta: Sentdm::Models::WebhookRetrieveResponse::Meta::OrHash,
61
- success: T::Boolean
62
- ).returns(T.attached_class)
63
- end
64
- def self.new(
65
- # The response data (null if error)
66
- data: nil,
67
- # Error information
68
- error: nil,
69
- # Request and response metadata
70
- meta: nil,
71
- # Indicates whether the request was successful
72
- success: nil
73
- )
74
- end
75
-
76
- sig do
77
- override.returns(
78
- {
79
- data: T.nilable(Sentdm::Models::WebhookRetrieveResponse::Data),
80
- error: T.nilable(Sentdm::Models::WebhookRetrieveResponse::Error),
81
- meta: Sentdm::Models::WebhookRetrieveResponse::Meta,
82
- success: T::Boolean
83
- }
84
- )
85
- end
86
- def to_hash
87
- end
88
-
89
- class Data < Sentdm::Internal::Type::BaseModel
90
- OrHash =
91
- T.type_alias do
92
- T.any(
93
- Sentdm::Models::WebhookRetrieveResponse::Data,
94
- Sentdm::Internal::AnyHash
95
- )
96
- end
97
-
98
- sig { returns(T.nilable(String)) }
99
- attr_reader :id
100
-
101
- sig { params(id: String).void }
102
- attr_writer :id
103
-
104
- sig { returns(T.nilable(Integer)) }
105
- attr_reader :consecutive_failures
106
-
107
- sig { params(consecutive_failures: Integer).void }
108
- attr_writer :consecutive_failures
109
-
110
- sig { returns(T.nilable(Time)) }
111
- attr_reader :created_at
112
-
113
- sig { params(created_at: Time).void }
114
- attr_writer :created_at
115
-
116
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
117
- # Says whose resource this is, which the resource's own id does not.
118
- sig { returns(T.nilable(String)) }
119
- attr_reader :customer_id
120
-
121
- sig { params(customer_id: String).void }
122
- attr_writer :customer_id
123
-
124
- sig { returns(T.nilable(String)) }
125
- attr_reader :display_name
126
-
127
- sig { params(display_name: String).void }
128
- attr_writer :display_name
129
-
130
- sig { returns(T.nilable(String)) }
131
- attr_reader :endpoint_url
132
-
133
- sig { params(endpoint_url: String).void }
134
- attr_writer :endpoint_url
135
-
136
- sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
137
- attr_accessor :event_filters
138
-
139
- sig { returns(T.nilable(T::Array[String])) }
140
- attr_reader :event_types
141
-
142
- sig { params(event_types: T::Array[String]).void }
143
- attr_writer :event_types
144
-
145
- sig { returns(T.nilable(T::Boolean)) }
146
- attr_reader :is_active
147
-
148
- sig { params(is_active: T::Boolean).void }
149
- attr_writer :is_active
150
-
151
- sig { returns(T.nilable(Time)) }
152
- attr_accessor :last_delivery_attempt_at
153
-
154
- sig { returns(T.nilable(Time)) }
155
- attr_accessor :last_successful_delivery_at
156
-
157
- sig { returns(T.nilable(Integer)) }
158
- attr_reader :retry_count
159
-
160
- sig { params(retry_count: Integer).void }
161
- attr_writer :retry_count
162
-
163
- sig { returns(T.nilable(String)) }
164
- attr_accessor :signing_secret
165
-
166
- sig { returns(T.nilable(Integer)) }
167
- attr_reader :timeout_seconds
168
-
169
- sig { params(timeout_seconds: Integer).void }
170
- attr_writer :timeout_seconds
171
-
172
- sig { returns(T.nilable(Time)) }
173
- attr_accessor :updated_at
174
-
175
- # The response data (null if error)
176
- sig do
177
- params(
178
- id: String,
179
- consecutive_failures: Integer,
180
- created_at: Time,
181
- customer_id: String,
182
- display_name: String,
183
- endpoint_url: String,
184
- event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
185
- event_types: T::Array[String],
186
- is_active: T::Boolean,
187
- last_delivery_attempt_at: T.nilable(Time),
188
- last_successful_delivery_at: T.nilable(Time),
189
- retry_count: Integer,
190
- signing_secret: T.nilable(String),
191
- timeout_seconds: Integer,
192
- updated_at: T.nilable(Time)
193
- ).returns(T.attached_class)
194
- end
195
- def self.new(
196
- id: nil,
197
- consecutive_failures: nil,
198
- created_at: nil,
199
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
200
- # Says whose resource this is, which the resource's own id does not.
201
- customer_id: nil,
202
- display_name: nil,
203
- endpoint_url: nil,
204
- event_filters: nil,
205
- event_types: nil,
206
- is_active: nil,
207
- last_delivery_attempt_at: nil,
208
- last_successful_delivery_at: nil,
209
- retry_count: nil,
210
- signing_secret: nil,
211
- timeout_seconds: nil,
212
- updated_at: nil
213
- )
214
- end
215
-
216
- sig do
217
- override.returns(
218
- {
219
- id: String,
220
- consecutive_failures: Integer,
221
- created_at: Time,
222
- customer_id: String,
223
- display_name: String,
224
- endpoint_url: String,
225
- event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
226
- event_types: T::Array[String],
227
- is_active: T::Boolean,
228
- last_delivery_attempt_at: T.nilable(Time),
229
- last_successful_delivery_at: T.nilable(Time),
230
- retry_count: Integer,
231
- signing_secret: T.nilable(String),
232
- timeout_seconds: Integer,
233
- updated_at: T.nilable(Time)
234
- }
235
- )
236
- end
237
- def to_hash
238
- end
239
- end
240
-
241
- class Error < Sentdm::Internal::Type::BaseModel
242
- OrHash =
243
- T.type_alias do
244
- T.any(
245
- Sentdm::Models::WebhookRetrieveResponse::Error,
246
- Sentdm::Internal::AnyHash
247
- )
248
- end
249
-
250
- # Machine-readable error code (e.g., "RESOURCE_001")
251
- sig { returns(T.nilable(String)) }
252
- attr_reader :code
253
-
254
- sig { params(code: String).void }
255
- attr_writer :code
256
-
257
- # Additional validation error details (field-level errors)
258
- sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
259
- attr_accessor :details
260
-
261
- # URL to documentation about this error
262
- sig { returns(T.nilable(String)) }
263
- attr_accessor :doc_url
264
-
265
- # Human-readable error message
266
- sig { returns(T.nilable(String)) }
267
- attr_reader :message
268
-
269
- sig { params(message: String).void }
270
- attr_writer :message
271
-
272
- # Error information
273
- sig do
274
- params(
275
- code: String,
276
- details: T.nilable(T::Hash[Symbol, T::Array[String]]),
277
- doc_url: T.nilable(String),
278
- message: String
279
- ).returns(T.attached_class)
280
- end
281
- def self.new(
282
- # Machine-readable error code (e.g., "RESOURCE_001")
283
- code: nil,
284
- # Additional validation error details (field-level errors)
285
- details: nil,
286
- # URL to documentation about this error
287
- doc_url: nil,
288
- # Human-readable error message
289
- message: nil
290
- )
291
- end
292
-
293
- sig do
294
- override.returns(
295
- {
296
- code: String,
297
- details: T.nilable(T::Hash[Symbol, T::Array[String]]),
298
- doc_url: T.nilable(String),
299
- message: String
300
- }
301
- )
302
- end
303
- def to_hash
304
- end
305
- end
306
-
307
- class Meta < Sentdm::Internal::Type::BaseModel
308
- OrHash =
309
- T.type_alias do
310
- T.any(
311
- Sentdm::Models::WebhookRetrieveResponse::Meta,
312
- Sentdm::Internal::AnyHash
313
- )
314
- end
315
-
316
- # Unique identifier for this request (for tracing and support)
317
- sig { returns(T.nilable(String)) }
318
- attr_reader :request_id
319
-
320
- sig { params(request_id: String).void }
321
- attr_writer :request_id
322
-
323
- # Server timestamp when the response was generated
324
- sig { returns(T.nilable(Time)) }
325
- attr_reader :timestamp
326
-
327
- sig { params(timestamp: Time).void }
328
- attr_writer :timestamp
329
-
330
- # API version used for this request
331
- sig { returns(T.nilable(String)) }
332
- attr_reader :version
333
-
334
- sig { params(version: String).void }
335
- attr_writer :version
336
-
337
- # Request and response metadata
338
- sig do
339
- params(request_id: String, timestamp: Time, version: String).returns(
340
- T.attached_class
341
- )
342
- end
343
- def self.new(
344
- # Unique identifier for this request (for tracing and support)
345
- request_id: nil,
346
- # Server timestamp when the response was generated
347
- timestamp: nil,
348
- # API version used for this request
349
- version: nil
350
- )
351
- end
352
-
353
- sig do
354
- override.returns(
355
- { request_id: String, timestamp: Time, version: String }
356
- )
357
- end
358
- def to_hash
359
- end
360
- end
361
- end
362
- end
363
- end