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