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
@@ -1,201 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Users#retrieve
6
- class UserRetrieveResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # User response for v3 API
9
- #
10
- # @return [Sentdm::Models::UserRetrieveResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::UserRetrieveResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::UserRetrieveResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::UserRetrieveResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::UserRetrieveResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::UserRetrieveResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::UserRetrieveResponse::Data, nil] User response for v3 API
35
- #
36
- # @param error [Sentdm::Models::UserRetrieveResponse::Error, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::UserRetrieveResponse::Meta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::UserRetrieveResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute id
45
- # User unique identifier
46
- #
47
- # @return [String, nil]
48
- optional :id, String
49
-
50
- # @!attribute created_at
51
- # When the user was added to the organization
52
- #
53
- # @return [Time, nil]
54
- optional :created_at, Time
55
-
56
- # @!attribute customer_id
57
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
58
- # Says whose resource this is, which the resource's own id does not.
59
- #
60
- # @return [String, nil]
61
- optional :customer_id, String
62
-
63
- # @!attribute email
64
- # User email address
65
- #
66
- # @return [String, nil]
67
- optional :email, String
68
-
69
- # @!attribute invited_at
70
- # When the user was invited
71
- #
72
- # @return [Time, nil]
73
- optional :invited_at, Time, nil?: true
74
-
75
- # @!attribute last_login_at
76
- # When the user last logged in
77
- #
78
- # @return [Time, nil]
79
- optional :last_login_at, Time, nil?: true
80
-
81
- # @!attribute name
82
- # User full name
83
- #
84
- # @return [String, nil]
85
- optional :name, String
86
-
87
- # @!attribute role
88
- # User role in the organization: admin, billing, developer
89
- #
90
- # @return [String, nil]
91
- optional :role, String
92
-
93
- # @!attribute status
94
- # User status: active, invited, suspended, rejected
95
- #
96
- # @return [String, nil]
97
- optional :status, String
98
-
99
- # @!attribute updated_at
100
- # When the user record was last updated
101
- #
102
- # @return [Time, nil]
103
- optional :updated_at, Time, nil?: true
104
-
105
- # @!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)
106
- # Some parameter documentations has been truncated, see
107
- # {Sentdm::Models::UserRetrieveResponse::Data} for more details.
108
- #
109
- # User response for v3 API
110
- #
111
- # @param id [String] User unique identifier
112
- #
113
- # @param created_at [Time] When the user was added to the organization
114
- #
115
- # @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
116
- #
117
- # @param email [String] User email address
118
- #
119
- # @param invited_at [Time, nil] When the user was invited
120
- #
121
- # @param last_login_at [Time, nil] When the user last logged in
122
- #
123
- # @param name [String] User full name
124
- #
125
- # @param role [String] User role in the organization: admin, billing, developer
126
- #
127
- # @param status [String] User status: active, invited, suspended, rejected
128
- #
129
- # @param updated_at [Time, nil] When the user record was last updated
130
- end
131
-
132
- # @see Sentdm::Models::UserRetrieveResponse#error
133
- class Error < Sentdm::Internal::Type::BaseModel
134
- # @!attribute code
135
- # Machine-readable error code (e.g., "RESOURCE_001")
136
- #
137
- # @return [String, nil]
138
- optional :code, String
139
-
140
- # @!attribute details
141
- # Additional validation error details (field-level errors)
142
- #
143
- # @return [Hash{Symbol=>Array<String>}, nil]
144
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
145
-
146
- # @!attribute doc_url
147
- # URL to documentation about this error
148
- #
149
- # @return [String, nil]
150
- optional :doc_url, String, nil?: true
151
-
152
- # @!attribute message
153
- # Human-readable error message
154
- #
155
- # @return [String, nil]
156
- optional :message, String
157
-
158
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
159
- # Error information
160
- #
161
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
162
- #
163
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
164
- #
165
- # @param doc_url [String, nil] URL to documentation about this error
166
- #
167
- # @param message [String] Human-readable error message
168
- end
169
-
170
- # @see Sentdm::Models::UserRetrieveResponse#meta
171
- class Meta < Sentdm::Internal::Type::BaseModel
172
- # @!attribute request_id
173
- # Unique identifier for this request (for tracing and support)
174
- #
175
- # @return [String, nil]
176
- optional :request_id, String
177
-
178
- # @!attribute timestamp
179
- # Server timestamp when the response was generated
180
- #
181
- # @return [Time, nil]
182
- optional :timestamp, Time
183
-
184
- # @!attribute version
185
- # API version used for this request
186
- #
187
- # @return [String, nil]
188
- optional :version, String
189
-
190
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
191
- # Request and response metadata
192
- #
193
- # @param request_id [String] Unique identifier for this request (for tracing and support)
194
- #
195
- # @param timestamp [Time] Server timestamp when the response was generated
196
- #
197
- # @param version [String] API version used for this request
198
- end
199
- end
200
- end
201
- end
@@ -1,201 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Users#update_role
6
- class UserUpdateRoleResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # User response for v3 API
9
- #
10
- # @return [Sentdm::Models::UserUpdateRoleResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::UserUpdateRoleResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::UserUpdateRoleResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::UserUpdateRoleResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::UserUpdateRoleResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::UserUpdateRoleResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::UserUpdateRoleResponse::Data, nil] User response for v3 API
35
- #
36
- # @param error [Sentdm::Models::UserUpdateRoleResponse::Error, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::UserUpdateRoleResponse::Meta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::UserUpdateRoleResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute id
45
- # User unique identifier
46
- #
47
- # @return [String, nil]
48
- optional :id, String
49
-
50
- # @!attribute created_at
51
- # When the user was added to the organization
52
- #
53
- # @return [Time, nil]
54
- optional :created_at, Time
55
-
56
- # @!attribute customer_id
57
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
58
- # Says whose resource this is, which the resource's own id does not.
59
- #
60
- # @return [String, nil]
61
- optional :customer_id, String
62
-
63
- # @!attribute email
64
- # User email address
65
- #
66
- # @return [String, nil]
67
- optional :email, String
68
-
69
- # @!attribute invited_at
70
- # When the user was invited
71
- #
72
- # @return [Time, nil]
73
- optional :invited_at, Time, nil?: true
74
-
75
- # @!attribute last_login_at
76
- # When the user last logged in
77
- #
78
- # @return [Time, nil]
79
- optional :last_login_at, Time, nil?: true
80
-
81
- # @!attribute name
82
- # User full name
83
- #
84
- # @return [String, nil]
85
- optional :name, String
86
-
87
- # @!attribute role
88
- # User role in the organization: admin, billing, developer
89
- #
90
- # @return [String, nil]
91
- optional :role, String
92
-
93
- # @!attribute status
94
- # User status: active, invited, suspended, rejected
95
- #
96
- # @return [String, nil]
97
- optional :status, String
98
-
99
- # @!attribute updated_at
100
- # When the user record was last updated
101
- #
102
- # @return [Time, nil]
103
- optional :updated_at, Time, nil?: true
104
-
105
- # @!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)
106
- # Some parameter documentations has been truncated, see
107
- # {Sentdm::Models::UserUpdateRoleResponse::Data} for more details.
108
- #
109
- # User response for v3 API
110
- #
111
- # @param id [String] User unique identifier
112
- #
113
- # @param created_at [Time] When the user was added to the organization
114
- #
115
- # @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
116
- #
117
- # @param email [String] User email address
118
- #
119
- # @param invited_at [Time, nil] When the user was invited
120
- #
121
- # @param last_login_at [Time, nil] When the user last logged in
122
- #
123
- # @param name [String] User full name
124
- #
125
- # @param role [String] User role in the organization: admin, billing, developer
126
- #
127
- # @param status [String] User status: active, invited, suspended, rejected
128
- #
129
- # @param updated_at [Time, nil] When the user record was last updated
130
- end
131
-
132
- # @see Sentdm::Models::UserUpdateRoleResponse#error
133
- class Error < Sentdm::Internal::Type::BaseModel
134
- # @!attribute code
135
- # Machine-readable error code (e.g., "RESOURCE_001")
136
- #
137
- # @return [String, nil]
138
- optional :code, String
139
-
140
- # @!attribute details
141
- # Additional validation error details (field-level errors)
142
- #
143
- # @return [Hash{Symbol=>Array<String>}, nil]
144
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
145
-
146
- # @!attribute doc_url
147
- # URL to documentation about this error
148
- #
149
- # @return [String, nil]
150
- optional :doc_url, String, nil?: true
151
-
152
- # @!attribute message
153
- # Human-readable error message
154
- #
155
- # @return [String, nil]
156
- optional :message, String
157
-
158
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
159
- # Error information
160
- #
161
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
162
- #
163
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
164
- #
165
- # @param doc_url [String, nil] URL to documentation about this error
166
- #
167
- # @param message [String] Human-readable error message
168
- end
169
-
170
- # @see Sentdm::Models::UserUpdateRoleResponse#meta
171
- class Meta < Sentdm::Internal::Type::BaseModel
172
- # @!attribute request_id
173
- # Unique identifier for this request (for tracing and support)
174
- #
175
- # @return [String, nil]
176
- optional :request_id, String
177
-
178
- # @!attribute timestamp
179
- # Server timestamp when the response was generated
180
- #
181
- # @return [Time, nil]
182
- optional :timestamp, Time
183
-
184
- # @!attribute version
185
- # API version used for this request
186
- #
187
- # @return [String, nil]
188
- optional :version, String
189
-
190
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
191
- # Request and response metadata
192
- #
193
- # @param request_id [String] Unique identifier for this request (for tracing and support)
194
- #
195
- # @param timestamp [Time] Server timestamp when the response was generated
196
- #
197
- # @param version [String] API version used for this request
198
- end
199
- end
200
- end
201
- end
@@ -1,229 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Webhooks#create
6
- class WebhookCreateResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # The response data (null if error)
9
- #
10
- # @return [Sentdm::Models::WebhookCreateResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::WebhookCreateResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::WebhookCreateResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::WebhookCreateResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::WebhookCreateResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::WebhookCreateResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::WebhookCreateResponse::Data, nil] The response data (null if error)
35
- #
36
- # @param error [Sentdm::Models::WebhookCreateResponse::Error, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::WebhookCreateResponse::Meta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::WebhookCreateResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute id
45
- #
46
- # @return [String, nil]
47
- optional :id, String
48
-
49
- # @!attribute consecutive_failures
50
- #
51
- # @return [Integer, nil]
52
- optional :consecutive_failures, Integer
53
-
54
- # @!attribute created_at
55
- #
56
- # @return [Time, nil]
57
- optional :created_at, Time
58
-
59
- # @!attribute customer_id
60
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
61
- # Says whose resource this is, which the resource's own id does not.
62
- #
63
- # @return [String, nil]
64
- optional :customer_id, String
65
-
66
- # @!attribute display_name
67
- #
68
- # @return [String, nil]
69
- optional :display_name, String
70
-
71
- # @!attribute endpoint_url
72
- #
73
- # @return [String, nil]
74
- optional :endpoint_url, String
75
-
76
- # @!attribute event_filters
77
- #
78
- # @return [Hash{Symbol=>Array<String>}, nil]
79
- optional :event_filters,
80
- Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
81
- nil?: true
82
-
83
- # @!attribute event_types
84
- #
85
- # @return [Array<String>, nil]
86
- optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
87
-
88
- # @!attribute is_active
89
- #
90
- # @return [Boolean, nil]
91
- optional :is_active, Sentdm::Internal::Type::Boolean
92
-
93
- # @!attribute last_delivery_attempt_at
94
- #
95
- # @return [Time, nil]
96
- optional :last_delivery_attempt_at, Time, nil?: true
97
-
98
- # @!attribute last_successful_delivery_at
99
- #
100
- # @return [Time, nil]
101
- optional :last_successful_delivery_at, Time, nil?: true
102
-
103
- # @!attribute retry_count
104
- #
105
- # @return [Integer, nil]
106
- optional :retry_count, Integer
107
-
108
- # @!attribute signing_secret
109
- #
110
- # @return [String, nil]
111
- optional :signing_secret, String, nil?: true
112
-
113
- # @!attribute timeout_seconds
114
- #
115
- # @return [Integer, nil]
116
- optional :timeout_seconds, Integer
117
-
118
- # @!attribute updated_at
119
- #
120
- # @return [Time, nil]
121
- optional :updated_at, Time, nil?: true
122
-
123
- # @!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)
124
- # Some parameter documentations has been truncated, see
125
- # {Sentdm::Models::WebhookCreateResponse::Data} for more details.
126
- #
127
- # The response data (null if error)
128
- #
129
- # @param id [String]
130
- #
131
- # @param consecutive_failures [Integer]
132
- #
133
- # @param created_at [Time]
134
- #
135
- # @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
136
- #
137
- # @param display_name [String]
138
- #
139
- # @param endpoint_url [String]
140
- #
141
- # @param event_filters [Hash{Symbol=>Array<String>}, nil]
142
- #
143
- # @param event_types [Array<String>]
144
- #
145
- # @param is_active [Boolean]
146
- #
147
- # @param last_delivery_attempt_at [Time, nil]
148
- #
149
- # @param last_successful_delivery_at [Time, nil]
150
- #
151
- # @param retry_count [Integer]
152
- #
153
- # @param signing_secret [String, nil]
154
- #
155
- # @param timeout_seconds [Integer]
156
- #
157
- # @param updated_at [Time, nil]
158
- end
159
-
160
- # @see Sentdm::Models::WebhookCreateResponse#error
161
- class Error < Sentdm::Internal::Type::BaseModel
162
- # @!attribute code
163
- # Machine-readable error code (e.g., "RESOURCE_001")
164
- #
165
- # @return [String, nil]
166
- optional :code, String
167
-
168
- # @!attribute details
169
- # Additional validation error details (field-level errors)
170
- #
171
- # @return [Hash{Symbol=>Array<String>}, nil]
172
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
173
-
174
- # @!attribute doc_url
175
- # URL to documentation about this error
176
- #
177
- # @return [String, nil]
178
- optional :doc_url, String, nil?: true
179
-
180
- # @!attribute message
181
- # Human-readable error message
182
- #
183
- # @return [String, nil]
184
- optional :message, String
185
-
186
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
187
- # Error information
188
- #
189
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
190
- #
191
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
192
- #
193
- # @param doc_url [String, nil] URL to documentation about this error
194
- #
195
- # @param message [String] Human-readable error message
196
- end
197
-
198
- # @see Sentdm::Models::WebhookCreateResponse#meta
199
- class Meta < Sentdm::Internal::Type::BaseModel
200
- # @!attribute request_id
201
- # Unique identifier for this request (for tracing and support)
202
- #
203
- # @return [String, nil]
204
- optional :request_id, String
205
-
206
- # @!attribute timestamp
207
- # Server timestamp when the response was generated
208
- #
209
- # @return [Time, nil]
210
- optional :timestamp, Time
211
-
212
- # @!attribute version
213
- # API version used for this request
214
- #
215
- # @return [String, nil]
216
- optional :version, String
217
-
218
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
219
- # Request and response metadata
220
- #
221
- # @param request_id [String] Unique identifier for this request (for tracing and support)
222
- #
223
- # @param timestamp [Time] Server timestamp when the response was generated
224
- #
225
- # @param version [String] API version used for this request
226
- end
227
- end
228
- end
229
- end