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