sentdm 0.28.0 → 0.30.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 (276) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +27 -1
  4. data/lib/sentdm/internal/type/base_model.rb +5 -5
  5. data/lib/sentdm/models/api_meta.rb +34 -0
  6. data/lib/sentdm/models/api_response_of_contact.rb +46 -0
  7. data/lib/sentdm/models/api_response_of_contact_message_summary.rb +43 -0
  8. data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +43 -0
  9. data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
  10. data/lib/sentdm/models/api_response_of_user.rb +43 -0
  11. data/lib/sentdm/models/api_response_template.rb +43 -0
  12. data/lib/sentdm/models/api_response_webhook.rb +43 -0
  13. data/lib/sentdm/models/billing_contact_info.rb +47 -0
  14. data/lib/sentdm/models/brand_business_info.rb +114 -0
  15. data/lib/sentdm/models/brand_compliance_info.rb +59 -0
  16. data/lib/sentdm/models/brand_contact_info.rb +58 -0
  17. data/lib/sentdm/models/brands_brand_data.rb +34 -0
  18. data/lib/sentdm/models/contact_delete_params.rb +2 -16
  19. data/lib/sentdm/models/contact_list_response.rb +12 -295
  20. data/lib/sentdm/models/contact_message_summary.rb +76 -0
  21. data/lib/sentdm/models/contact_response.rb +139 -0
  22. data/lib/sentdm/models/conversation_messages_list.rb +245 -0
  23. data/lib/sentdm/models/error_detail.rb +42 -0
  24. data/lib/sentdm/models/inbound_message_event_payload.rb +17 -17
  25. data/lib/sentdm/models/me_retrieve_response.rb +43 -243
  26. data/lib/sentdm/models/message_event_payload.rb +11 -11
  27. data/lib/sentdm/models/message_retrieve_activities_response.rb +9 -159
  28. data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
  29. data/lib/sentdm/models/message_send_response.rb +6 -74
  30. data/lib/sentdm/models/mutation_request.rb +20 -0
  31. data/lib/sentdm/models/number_lookup_response.rb +6 -74
  32. data/lib/sentdm/models/pagination_meta.rb +84 -0
  33. data/lib/sentdm/models/payment_details.rb +40 -0
  34. data/lib/sentdm/models/profile_complete_response.rb +6 -74
  35. data/lib/sentdm/models/profile_create_params.rb +9 -345
  36. data/lib/sentdm/models/profile_delete_params.rb +2 -16
  37. data/lib/sentdm/models/profile_detail.rb +650 -0
  38. data/lib/sentdm/models/profile_list_response.rb +12 -815
  39. data/lib/sentdm/models/profile_settings.rb +85 -0
  40. data/lib/sentdm/models/profile_update_params.rb +9 -345
  41. data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +45 -0
  42. data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +45 -0
  43. data/lib/sentdm/models/profiles/brand_campaign.rb +247 -0
  44. data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -156
  45. data/lib/sentdm/models/profiles/campaign_data.rb +136 -0
  46. data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
  47. data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -156
  48. data/lib/sentdm/models/profiles/campaign_use_case.rb +71 -0
  49. data/lib/sentdm/models/profiles/campaign_use_case_data.rb +29 -0
  50. data/lib/sentdm/models/template.rb +102 -0
  51. data/lib/sentdm/models/template_event_payload.rb +18 -18
  52. data/lib/sentdm/models/template_list_response.rb +12 -258
  53. data/lib/sentdm/models/user_list_response.rb +12 -249
  54. data/lib/sentdm/models/user_remove_params.rb +2 -16
  55. data/lib/sentdm/models/user_response.rb +94 -0
  56. data/lib/sentdm/models/webhook_event_type.rb +45 -0
  57. data/lib/sentdm/models/webhook_list_event_types_response.rb +12 -203
  58. data/lib/sentdm/models/webhook_list_events_response.rb +9 -157
  59. data/lib/sentdm/models/webhook_list_response.rb +12 -276
  60. data/lib/sentdm/models/webhook_response.rb +120 -0
  61. data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
  62. data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
  63. data/lib/sentdm/models/webhook_test_response.rb +6 -74
  64. data/lib/sentdm/models.rb +52 -0
  65. data/lib/sentdm/resources/contacts.rb +8 -8
  66. data/lib/sentdm/resources/conversations.rb +4 -4
  67. data/lib/sentdm/resources/me.rb +11 -0
  68. data/lib/sentdm/resources/profiles/campaigns.rb +8 -8
  69. data/lib/sentdm/resources/profiles.rb +12 -12
  70. data/lib/sentdm/resources/templates.rb +6 -6
  71. data/lib/sentdm/resources/users.rb +6 -6
  72. data/lib/sentdm/resources/webhooks.rb +8 -8
  73. data/lib/sentdm/version.rb +1 -1
  74. data/lib/sentdm.rb +32 -22
  75. data/rbi/sentdm/models/api_meta.rbi +55 -0
  76. data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
  77. data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi +79 -0
  78. data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +79 -0
  79. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
  80. data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
  81. data/rbi/sentdm/models/api_response_template.rbi +74 -0
  82. data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
  83. data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
  84. data/rbi/sentdm/models/brand_business_info.rbi +162 -0
  85. data/rbi/sentdm/models/brand_compliance_info.rbi +76 -0
  86. data/rbi/sentdm/models/brand_contact_info.rbi +78 -0
  87. data/rbi/sentdm/models/brands_brand_data.rbi +65 -0
  88. data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
  89. data/rbi/sentdm/models/contact_list_response.rbi +16 -522
  90. data/rbi/sentdm/models/contact_message_summary.rbi +144 -0
  91. data/rbi/sentdm/models/contact_response.rbi +200 -0
  92. data/rbi/sentdm/models/conversation_messages_list.rbi +419 -0
  93. data/rbi/sentdm/models/error_detail.rbi +66 -0
  94. data/rbi/sentdm/models/inbound_message_event_payload.rbi +16 -22
  95. data/rbi/sentdm/models/me_retrieve_response.rbi +60 -367
  96. data/rbi/sentdm/models/message_event_payload.rbi +12 -15
  97. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +12 -325
  98. data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
  99. data/rbi/sentdm/models/message_send_response.rbi +8 -135
  100. data/rbi/sentdm/models/mutation_request.rbi +32 -0
  101. data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
  102. data/rbi/sentdm/models/pagination_meta.rbi +135 -0
  103. data/rbi/sentdm/models/payment_details.rbi +56 -0
  104. data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
  105. data/rbi/sentdm/models/profile_create_params.rbi +12 -546
  106. data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
  107. data/rbi/sentdm/models/profile_detail.rbi +918 -0
  108. data/rbi/sentdm/models/profile_list_response.rbi +16 -1347
  109. data/rbi/sentdm/models/profile_settings.rbi +102 -0
  110. data/rbi/sentdm/models/profile_update_params.rbi +12 -546
  111. data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +81 -0
  112. data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +76 -0
  113. data/rbi/sentdm/models/profiles/brand_campaign.rbi +299 -0
  114. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -218
  115. data/rbi/sentdm/models/profiles/campaign_data.rbi +158 -0
  116. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
  117. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -218
  118. data/rbi/sentdm/models/profiles/campaign_use_case.rbi +110 -0
  119. data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +51 -0
  120. data/rbi/sentdm/models/template.rbi +139 -0
  121. data/rbi/sentdm/models/template_event_payload.rbi +21 -27
  122. data/rbi/sentdm/models/template_list_response.rbi +16 -464
  123. data/rbi/sentdm/models/user_list_response.rbi +16 -444
  124. data/rbi/sentdm/models/user_remove_params.rbi +2 -19
  125. data/rbi/sentdm/models/user_response.rbi +131 -0
  126. data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
  127. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +16 -414
  128. data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
  129. data/rbi/sentdm/models/webhook_list_response.rbi +16 -475
  130. data/rbi/sentdm/models/webhook_response.rbi +153 -0
  131. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
  132. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
  133. data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
  134. data/rbi/sentdm/models.rbi +54 -0
  135. data/rbi/sentdm/resources/contacts.rbi +4 -4
  136. data/rbi/sentdm/resources/conversations.rbi +2 -2
  137. data/rbi/sentdm/resources/me.rbi +11 -0
  138. data/rbi/sentdm/resources/profiles/campaigns.rbi +5 -5
  139. data/rbi/sentdm/resources/profiles.rbi +9 -13
  140. data/rbi/sentdm/resources/templates.rbi +3 -3
  141. data/rbi/sentdm/resources/users.rbi +3 -3
  142. data/rbi/sentdm/resources/webhooks.rbi +4 -4
  143. data/sig/sentdm/models/api_meta.rbs +27 -0
  144. data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
  145. data/sig/sentdm/models/api_response_of_contact_message_summary.rbs +39 -0
  146. data/sig/sentdm/models/api_response_of_conversation_messages_list.rbs +39 -0
  147. data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
  148. data/sig/sentdm/models/api_response_of_user.rbs +39 -0
  149. data/sig/sentdm/models/api_response_template.rbs +39 -0
  150. data/sig/sentdm/models/api_response_webhook.rbs +39 -0
  151. data/sig/sentdm/models/billing_contact_info.rbs +30 -0
  152. data/sig/sentdm/models/brand_business_info.rbs +89 -0
  153. data/sig/sentdm/models/brand_compliance_info.rbs +45 -0
  154. data/sig/sentdm/models/brand_contact_info.rbs +45 -0
  155. data/sig/sentdm/models/brands_brand_data.rbs +30 -0
  156. data/sig/sentdm/models/contact_delete_params.rbs +6 -10
  157. data/sig/sentdm/models/contact_list_response.rbs +20 -263
  158. data/sig/sentdm/models/contact_message_summary.rbs +84 -0
  159. data/sig/sentdm/models/contact_response.rbs +118 -0
  160. data/sig/sentdm/models/conversation_messages_list.rbs +240 -0
  161. data/sig/sentdm/models/error_detail.rbs +39 -0
  162. data/sig/sentdm/models/inbound_message_event_payload.rbs +10 -14
  163. data/sig/sentdm/models/me_retrieve_response.rbs +28 -176
  164. data/sig/sentdm/models/message_event_payload.rbs +5 -7
  165. data/sig/sentdm/models/message_retrieve_activities_response.rbs +14 -142
  166. data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
  167. data/sig/sentdm/models/message_send_response.rbs +9 -71
  168. data/sig/sentdm/models/mutation_request.rbs +15 -0
  169. data/sig/sentdm/models/number_lookup_response.rbs +9 -71
  170. data/sig/sentdm/models/pagination_meta.rbs +67 -0
  171. data/sig/sentdm/models/payment_details.rbs +30 -0
  172. data/sig/sentdm/models/profile_complete_response.rbs +9 -71
  173. data/sig/sentdm/models/profile_create_params.rbs +12 -263
  174. data/sig/sentdm/models/profile_delete_params.rbs +6 -10
  175. data/sig/sentdm/models/profile_detail.rbs +461 -0
  176. data/sig/sentdm/models/profile_list_response.rbs +20 -606
  177. data/sig/sentdm/models/profile_settings.rbs +50 -0
  178. data/sig/sentdm/models/profile_update_params.rbs +12 -263
  179. data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +41 -0
  180. data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +41 -0
  181. data/sig/sentdm/models/profiles/brand_campaign.rbs +194 -0
  182. data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -108
  183. data/sig/sentdm/models/profiles/campaign_data.rbs +87 -0
  184. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
  185. data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -108
  186. data/sig/sentdm/models/profiles/campaign_use_case.rbs +66 -0
  187. data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +27 -0
  188. data/sig/sentdm/models/template.rbs +84 -0
  189. data/sig/sentdm/models/template_event_payload.rbs +13 -17
  190. data/sig/sentdm/models/template_list_response.rbs +19 -230
  191. data/sig/sentdm/models/user_list_response.rbs +20 -224
  192. data/sig/sentdm/models/user_remove_params.rbs +6 -10
  193. data/sig/sentdm/models/user_response.rbs +79 -0
  194. data/sig/sentdm/models/webhook_event_type.rbs +51 -0
  195. data/sig/sentdm/models/webhook_list_event_types_response.rbs +20 -196
  196. data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
  197. data/sig/sentdm/models/webhook_list_response.rbs +20 -255
  198. data/sig/sentdm/models/webhook_response.rbs +110 -0
  199. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
  200. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
  201. data/sig/sentdm/models/webhook_test_response.rbs +9 -71
  202. data/sig/sentdm/models.rbs +52 -0
  203. data/sig/sentdm/resources/contacts.rbs +4 -4
  204. data/sig/sentdm/resources/conversations.rbs +2 -2
  205. data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
  206. data/sig/sentdm/resources/profiles.rbs +9 -9
  207. data/sig/sentdm/resources/templates.rbs +3 -3
  208. data/sig/sentdm/resources/users.rbs +3 -3
  209. data/sig/sentdm/resources/webhooks.rbs +4 -4
  210. metadata +98 -68
  211. data/lib/sentdm/models/contact_create_response.rb +0 -249
  212. data/lib/sentdm/models/contact_retrieve_message_summary_response.rb +0 -186
  213. data/lib/sentdm/models/contact_retrieve_response.rb +0 -249
  214. data/lib/sentdm/models/contact_update_response.rb +0 -249
  215. data/lib/sentdm/models/conversation_list_messages_response.rb +0 -436
  216. data/lib/sentdm/models/conversation_list_response.rb +0 -433
  217. data/lib/sentdm/models/profile_create_response.rb +0 -760
  218. data/lib/sentdm/models/profile_retrieve_response.rb +0 -762
  219. data/lib/sentdm/models/profile_update_response.rb +0 -760
  220. data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -420
  221. data/lib/sentdm/models/profiles/campaign_list_response.rb +0 -421
  222. data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -420
  223. data/lib/sentdm/models/template_create_response.rb +0 -209
  224. data/lib/sentdm/models/template_retrieve_response.rb +0 -209
  225. data/lib/sentdm/models/template_update_response.rb +0 -209
  226. data/lib/sentdm/models/user_invite_response.rb +0 -201
  227. data/lib/sentdm/models/user_retrieve_response.rb +0 -201
  228. data/lib/sentdm/models/user_update_role_response.rb +0 -201
  229. data/lib/sentdm/models/webhook_create_response.rb +0 -229
  230. data/lib/sentdm/models/webhook_retrieve_response.rb +0 -229
  231. data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -229
  232. data/lib/sentdm/models/webhook_update_response.rb +0 -229
  233. data/rbi/sentdm/models/contact_create_response.rbi +0 -407
  234. data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +0 -397
  235. data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -409
  236. data/rbi/sentdm/models/contact_update_response.rbi +0 -407
  237. data/rbi/sentdm/models/conversation_list_messages_response.rbi +0 -843
  238. data/rbi/sentdm/models/conversation_list_response.rbi +0 -819
  239. data/rbi/sentdm/models/profile_create_response.rbi +0 -1226
  240. data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1230
  241. data/rbi/sentdm/models/profile_update_response.rbi +0 -1226
  242. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -674
  243. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +0 -667
  244. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -674
  245. data/rbi/sentdm/models/template_create_response.rbi +0 -349
  246. data/rbi/sentdm/models/template_retrieve_response.rbi +0 -355
  247. data/rbi/sentdm/models/template_update_response.rbi +0 -349
  248. data/rbi/sentdm/models/user_invite_response.rbi +0 -336
  249. data/rbi/sentdm/models/user_retrieve_response.rbi +0 -336
  250. data/rbi/sentdm/models/user_update_role_response.rbi +0 -341
  251. data/rbi/sentdm/models/webhook_create_response.rbi +0 -361
  252. data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -363
  253. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -379
  254. data/rbi/sentdm/models/webhook_update_response.rbi +0 -361
  255. data/sig/sentdm/models/contact_create_response.rbs +0 -216
  256. data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +0 -182
  257. data/sig/sentdm/models/contact_retrieve_response.rbs +0 -216
  258. data/sig/sentdm/models/contact_update_response.rbs +0 -216
  259. data/sig/sentdm/models/conversation_list_messages_response.rbs +0 -404
  260. data/sig/sentdm/models/conversation_list_response.rbs +0 -404
  261. data/sig/sentdm/models/profile_create_response.rbs +0 -559
  262. data/sig/sentdm/models/profile_retrieve_response.rbs +0 -559
  263. data/sig/sentdm/models/profile_update_response.rbs +0 -559
  264. data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -357
  265. data/sig/sentdm/models/profiles/campaign_list_response.rbs +0 -357
  266. data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -357
  267. data/sig/sentdm/models/template_create_response.rbs +0 -182
  268. data/sig/sentdm/models/template_retrieve_response.rbs +0 -182
  269. data/sig/sentdm/models/template_update_response.rbs +0 -182
  270. data/sig/sentdm/models/user_invite_response.rbs +0 -177
  271. data/sig/sentdm/models/user_retrieve_response.rbs +0 -177
  272. data/sig/sentdm/models/user_update_role_response.rbs +0 -177
  273. data/sig/sentdm/models/webhook_create_response.rbs +0 -208
  274. data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -208
  275. data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -208
  276. data/sig/sentdm/models/webhook_update_response.rbs +0 -208
@@ -0,0 +1,94 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class UserResponse < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute id
7
+ # User unique identifier
8
+ #
9
+ # @return [String, nil]
10
+ optional :id, String
11
+
12
+ # @!attribute created_at
13
+ # When the user was added to the organization
14
+ #
15
+ # @return [Time, nil]
16
+ optional :created_at, Time
17
+
18
+ # @!attribute customer_id
19
+ # Which customer owns this — the key's own, or the profile named in x-profile-id.
20
+ # Says whose resource this is, which the resource's own id does not.
21
+ #
22
+ # @return [String, nil]
23
+ optional :customer_id, String
24
+
25
+ # @!attribute email
26
+ # User email address
27
+ #
28
+ # @return [String, nil]
29
+ optional :email, String
30
+
31
+ # @!attribute invited_at
32
+ # When the user was invited
33
+ #
34
+ # @return [Time, nil]
35
+ optional :invited_at, Time, nil?: true
36
+
37
+ # @!attribute last_login_at
38
+ # When the user last logged in
39
+ #
40
+ # @return [Time, nil]
41
+ optional :last_login_at, Time, nil?: true
42
+
43
+ # @!attribute name
44
+ # User full name
45
+ #
46
+ # @return [String, nil]
47
+ optional :name, String
48
+
49
+ # @!attribute role
50
+ # User role in the organization: admin, billing, developer
51
+ #
52
+ # @return [String, nil]
53
+ optional :role, String
54
+
55
+ # @!attribute status
56
+ # User status: active, invited, suspended, rejected
57
+ #
58
+ # @return [String, nil]
59
+ optional :status, String
60
+
61
+ # @!attribute updated_at
62
+ # When the user record was last updated
63
+ #
64
+ # @return [Time, nil]
65
+ optional :updated_at, Time, nil?: true
66
+
67
+ # @!method initialize(id: nil, created_at: nil, customer_id: nil, email: nil, invited_at: nil, last_login_at: nil, name: nil, role: nil, status: nil, updated_at: nil)
68
+ # Some parameter documentations has been truncated, see
69
+ # {Sentdm::Models::UserResponse} for more details.
70
+ #
71
+ # User response for v3 API
72
+ #
73
+ # @param id [String] User unique identifier
74
+ #
75
+ # @param created_at [Time] When the user was added to the organization
76
+ #
77
+ # @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
78
+ #
79
+ # @param email [String] User email address
80
+ #
81
+ # @param invited_at [Time, nil] When the user was invited
82
+ #
83
+ # @param last_login_at [Time, nil] When the user last logged in
84
+ #
85
+ # @param name [String] User full name
86
+ #
87
+ # @param role [String] User role in the organization: admin, billing, developer
88
+ #
89
+ # @param status [String] User status: active, invited, suspended, rejected
90
+ #
91
+ # @param updated_at [Time, nil] When the user record was last updated
92
+ end
93
+ end
94
+ end
@@ -0,0 +1,45 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class WebhookEventType < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute description
7
+ #
8
+ # @return [String, nil]
9
+ optional :description, String, nil?: true
10
+
11
+ # @!attribute display_name
12
+ #
13
+ # @return [String, nil]
14
+ optional :display_name, String
15
+
16
+ # @!attribute event_type
17
+ #
18
+ # @return [String, nil]
19
+ optional :event_type, String, nil?: true
20
+
21
+ # @!attribute is_active
22
+ #
23
+ # @return [Boolean, nil]
24
+ optional :is_active, Sentdm::Internal::Type::Boolean
25
+
26
+ # @!attribute name
27
+ #
28
+ # @return [String, nil]
29
+ optional :name, String
30
+
31
+ # @!attribute sub_types
32
+ #
33
+ # @return [Array<Sentdm::Models::WebhookEventType>, nil]
34
+ optional :sub_types, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookEventType] }, nil?: true
35
+
36
+ # @!method initialize(description: nil, display_name: nil, event_type: nil, is_active: nil, name: nil, sub_types: nil)
37
+ # @param description [String, nil]
38
+ # @param display_name [String]
39
+ # @param event_type [String, nil]
40
+ # @param is_active [Boolean]
41
+ # @param name [String]
42
+ # @param sub_types [Array<Sentdm::Models::WebhookEventType>, nil]
43
+ end
44
+ end
45
+ end
@@ -13,14 +13,14 @@ module Sentdm
13
13
  # @!attribute error
14
14
  # Error information
15
15
  #
16
- # @return [Sentdm::Models::WebhookListEventTypesResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::WebhookListEventTypesResponse::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::WebhookListEventTypesResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::WebhookListEventTypesResponse::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::WebhookListEventTypesResponse::Data, nil] The webhook event types a customer can subscribe to.
35
35
  #
36
- # @param error [Sentdm::Models::WebhookListEventTypesResponse::Error, nil] Error information
36
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::WebhookListEventTypesResponse::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,212 +44,21 @@ module Sentdm
44
44
  # @!attribute event_types
45
45
  # The event_types on this page.
46
46
  #
47
- # @return [Array<Sentdm::Models::WebhookListEventTypesResponse::Data::EventType>, nil]
48
- optional :event_types,
49
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::WebhookListEventTypesResponse::Data::EventType] }
47
+ # @return [Array<Sentdm::Models::WebhookEventType>, nil]
48
+ optional :event_types, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookEventType] }
50
49
 
51
50
  # @!attribute pagination
52
51
  # Pagination metadata for list responses
53
52
  #
54
- # @return [Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination, nil]
55
- optional :pagination, -> { Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination }
53
+ # @return [Sentdm::Models::PaginationMeta, nil]
54
+ optional :pagination, -> { Sentdm::PaginationMeta }
56
55
 
57
56
  # @!method initialize(event_types: nil, pagination: nil)
58
57
  # The webhook event types a customer can subscribe to.
59
58
  #
60
- # @param event_types [Array<Sentdm::Models::WebhookListEventTypesResponse::Data::EventType>] The event_types on this page.
59
+ # @param event_types [Array<Sentdm::Models::WebhookEventType>] The event_types on this page.
61
60
  #
62
- # @param pagination [Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination] Pagination metadata for list responses
63
-
64
- class EventType < Sentdm::Internal::Type::BaseModel
65
- # @!attribute description
66
- #
67
- # @return [String, nil]
68
- optional :description, String, nil?: true
69
-
70
- # @!attribute display_name
71
- #
72
- # @return [String, nil]
73
- optional :display_name, String
74
-
75
- # @!attribute event_type
76
- #
77
- # @return [String, nil]
78
- optional :event_type, String, nil?: true
79
-
80
- # @!attribute is_active
81
- #
82
- # @return [Boolean, nil]
83
- optional :is_active, Sentdm::Internal::Type::Boolean
84
-
85
- # @!attribute name
86
- #
87
- # @return [String, nil]
88
- optional :name, String
89
-
90
- # @!attribute sub_types
91
- #
92
- # @return [Array<Object>, nil]
93
- optional :sub_types, Sentdm::Internal::Type::ArrayOf[Sentdm::Internal::Type::Unknown], nil?: true
94
-
95
- # @!method initialize(description: nil, display_name: nil, event_type: nil, is_active: nil, name: nil, sub_types: nil)
96
- # @param description [String, nil]
97
- # @param display_name [String]
98
- # @param event_type [String, nil]
99
- # @param is_active [Boolean]
100
- # @param name [String]
101
- # @param sub_types [Array<Object>, nil]
102
- end
103
-
104
- # @see Sentdm::Models::WebhookListEventTypesResponse::Data#pagination
105
- class Pagination < Sentdm::Internal::Type::BaseModel
106
- # @!attribute cursors
107
- # @deprecated
108
- #
109
- # Cursor-based pagination. Never populated — see Cursors.
110
- #
111
- # @return [Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination::Cursors, nil]
112
- optional :cursors,
113
- -> { Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination::Cursors },
114
- nil?: true
115
-
116
- # @!attribute has_more
117
- # Whether there are more pages after this one
118
- #
119
- # @return [Boolean, nil]
120
- optional :has_more, Sentdm::Internal::Type::Boolean
121
-
122
- # @!attribute page
123
- # Current page number (1-indexed)
124
- #
125
- # @return [Integer, nil]
126
- optional :page, Integer
127
-
128
- # @!attribute page_size
129
- # Number of items per page
130
- #
131
- # @return [Integer, nil]
132
- optional :page_size, Integer
133
-
134
- # @!attribute total_count
135
- # Total number of items across all pages
136
- #
137
- # @return [Integer, nil]
138
- optional :total_count, Integer
139
-
140
- # @!attribute total_pages
141
- # Total number of pages
142
- #
143
- # @return [Integer, nil]
144
- optional :total_pages, Integer
145
-
146
- # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
147
- # Pagination metadata for list responses
148
- #
149
- # @param cursors [Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
150
- #
151
- # @param has_more [Boolean] Whether there are more pages after this one
152
- #
153
- # @param page [Integer] Current page number (1-indexed)
154
- #
155
- # @param page_size [Integer] Number of items per page
156
- #
157
- # @param total_count [Integer] Total number of items across all pages
158
- #
159
- # @param total_pages [Integer] Total number of pages
160
-
161
- # @deprecated
162
- #
163
- # @see Sentdm::Models::WebhookListEventTypesResponse::Data::Pagination#cursors
164
- class Cursors < Sentdm::Internal::Type::BaseModel
165
- # @!attribute after
166
- # Cursor to fetch the next page.
167
- #
168
- # @return [String, nil]
169
- optional :after, String, nil?: true
170
-
171
- # @!attribute before
172
- # Cursor to fetch the previous page.
173
- #
174
- # @return [String, nil]
175
- optional :before, String, nil?: true
176
-
177
- # @!method initialize(after: nil, before: nil)
178
- # Cursor-based pagination. Never populated — see Cursors.
179
- #
180
- # @param after [String, nil] Cursor to fetch the next page.
181
- #
182
- # @param before [String, nil] Cursor to fetch the previous page.
183
- end
184
- end
185
- end
186
-
187
- # @see Sentdm::Models::WebhookListEventTypesResponse#error
188
- class Error < Sentdm::Internal::Type::BaseModel
189
- # @!attribute code
190
- # Machine-readable error code (e.g., "RESOURCE_001")
191
- #
192
- # @return [String, nil]
193
- optional :code, String
194
-
195
- # @!attribute details
196
- # Additional validation error details (field-level errors)
197
- #
198
- # @return [Hash{Symbol=>Array<String>}, nil]
199
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
200
-
201
- # @!attribute doc_url
202
- # URL to documentation about this error
203
- #
204
- # @return [String, nil]
205
- optional :doc_url, String, nil?: true
206
-
207
- # @!attribute message
208
- # Human-readable error message
209
- #
210
- # @return [String, nil]
211
- optional :message, String
212
-
213
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
214
- # Error information
215
- #
216
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
217
- #
218
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
219
- #
220
- # @param doc_url [String, nil] URL to documentation about this error
221
- #
222
- # @param message [String] Human-readable error message
223
- end
224
-
225
- # @see Sentdm::Models::WebhookListEventTypesResponse#meta
226
- class Meta < Sentdm::Internal::Type::BaseModel
227
- # @!attribute request_id
228
- # Unique identifier for this request (for tracing and support)
229
- #
230
- # @return [String, nil]
231
- optional :request_id, String
232
-
233
- # @!attribute timestamp
234
- # Server timestamp when the response was generated
235
- #
236
- # @return [Time, nil]
237
- optional :timestamp, Time
238
-
239
- # @!attribute version
240
- # API version used for this request
241
- #
242
- # @return [String, nil]
243
- optional :version, String
244
-
245
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
246
- # Request and response metadata
247
- #
248
- # @param request_id [String] Unique identifier for this request (for tracing and support)
249
- #
250
- # @param timestamp [Time] Server timestamp when the response was generated
251
- #
252
- # @param version [String] API version used for this request
61
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
253
62
  end
254
63
  end
255
64
  end
@@ -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] A paginated list of webhook delivery records.
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
 
@@ -51,15 +51,15 @@ module Sentdm
51
51
  # @!attribute pagination
52
52
  # Pagination metadata for list responses
53
53
  #
54
- # @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination, nil]
55
- optional :pagination, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination }
54
+ # @return [Sentdm::Models::PaginationMeta, nil]
55
+ optional :pagination, -> { Sentdm::PaginationMeta }
56
56
 
57
57
  # @!method initialize(events: nil, pagination: nil)
58
58
  # A paginated list of webhook delivery records.
59
59
  #
60
60
  # @param events [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>] The events on this page.
61
61
  #
62
- # @param pagination [Sentdm::Models::WebhookListEventsResponse::Data::Pagination] Pagination metadata for list responses
62
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
63
63
 
64
64
  class Event < Sentdm::Internal::Type::BaseModel
65
65
  # @!attribute id
@@ -172,154 +172,6 @@ module Sentdm
172
172
  # @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent)]
173
173
  end
174
174
  end
175
-
176
- # @see Sentdm::Models::WebhookListEventsResponse::Data#pagination
177
- class Pagination < Sentdm::Internal::Type::BaseModel
178
- # @!attribute cursors
179
- # @deprecated
180
- #
181
- # Cursor-based pagination. Never populated — see Cursors.
182
- #
183
- # @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil]
184
- optional :cursors, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors }, nil?: true
185
-
186
- # @!attribute has_more
187
- # Whether there are more pages after this one
188
- #
189
- # @return [Boolean, nil]
190
- optional :has_more, Sentdm::Internal::Type::Boolean
191
-
192
- # @!attribute page
193
- # Current page number (1-indexed)
194
- #
195
- # @return [Integer, nil]
196
- optional :page, Integer
197
-
198
- # @!attribute page_size
199
- # Number of items per page
200
- #
201
- # @return [Integer, nil]
202
- optional :page_size, Integer
203
-
204
- # @!attribute total_count
205
- # Total number of items across all pages
206
- #
207
- # @return [Integer, nil]
208
- optional :total_count, Integer
209
-
210
- # @!attribute total_pages
211
- # Total number of pages
212
- #
213
- # @return [Integer, nil]
214
- optional :total_pages, Integer
215
-
216
- # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
217
- # Pagination metadata for list responses
218
- #
219
- # @param cursors [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
220
- #
221
- # @param has_more [Boolean] Whether there are more pages after this one
222
- #
223
- # @param page [Integer] Current page number (1-indexed)
224
- #
225
- # @param page_size [Integer] Number of items per page
226
- #
227
- # @param total_count [Integer] Total number of items across all pages
228
- #
229
- # @param total_pages [Integer] Total number of pages
230
-
231
- # @deprecated
232
- #
233
- # @see Sentdm::Models::WebhookListEventsResponse::Data::Pagination#cursors
234
- class Cursors < Sentdm::Internal::Type::BaseModel
235
- # @!attribute after
236
- # Cursor to fetch the next page.
237
- #
238
- # @return [String, nil]
239
- optional :after, String, nil?: true
240
-
241
- # @!attribute before
242
- # Cursor to fetch the previous page.
243
- #
244
- # @return [String, nil]
245
- optional :before, String, nil?: true
246
-
247
- # @!method initialize(after: nil, before: nil)
248
- # Cursor-based pagination. Never populated — see Cursors.
249
- #
250
- # @param after [String, nil] Cursor to fetch the next page.
251
- #
252
- # @param before [String, nil] Cursor to fetch the previous page.
253
- end
254
- end
255
- end
256
-
257
- # @see Sentdm::Models::WebhookListEventsResponse#error
258
- class Error < Sentdm::Internal::Type::BaseModel
259
- # @!attribute code
260
- # Machine-readable error code (e.g., "RESOURCE_001")
261
- #
262
- # @return [String, nil]
263
- optional :code, String
264
-
265
- # @!attribute details
266
- # Additional validation error details (field-level errors)
267
- #
268
- # @return [Hash{Symbol=>Array<String>}, nil]
269
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
270
-
271
- # @!attribute doc_url
272
- # URL to documentation about this error
273
- #
274
- # @return [String, nil]
275
- optional :doc_url, String, nil?: true
276
-
277
- # @!attribute message
278
- # Human-readable error message
279
- #
280
- # @return [String, nil]
281
- optional :message, String
282
-
283
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
284
- # Error information
285
- #
286
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
287
- #
288
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
289
- #
290
- # @param doc_url [String, nil] URL to documentation about this error
291
- #
292
- # @param message [String] Human-readable error message
293
- end
294
-
295
- # @see Sentdm::Models::WebhookListEventsResponse#meta
296
- class Meta < Sentdm::Internal::Type::BaseModel
297
- # @!attribute request_id
298
- # Unique identifier for this request (for tracing and support)
299
- #
300
- # @return [String, nil]
301
- optional :request_id, String
302
-
303
- # @!attribute timestamp
304
- # Server timestamp when the response was generated
305
- #
306
- # @return [Time, nil]
307
- optional :timestamp, Time
308
-
309
- # @!attribute version
310
- # API version used for this request
311
- #
312
- # @return [String, nil]
313
- optional :version, String
314
-
315
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
316
- # Request and response metadata
317
- #
318
- # @param request_id [String] Unique identifier for this request (for tracing and support)
319
- #
320
- # @param timestamp [Time] Server timestamp when the response was generated
321
- #
322
- # @param version [String] API version used for this request
323
175
  end
324
176
  end
325
177
  end