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::TemplateListResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::TemplateListResponse::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::TemplateListResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::TemplateListResponse::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::TemplateListResponse::Data, nil] A paginated list of templates.
35
35
  #
36
- # @param error [Sentdm::Models::TemplateListResponse::Error, nil] Error information
36
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::TemplateListResponse::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,267 +44,21 @@ module Sentdm
44
44
  # @!attribute pagination
45
45
  # Pagination metadata for list responses
46
46
  #
47
- # @return [Sentdm::Models::TemplateListResponse::Data::Pagination, nil]
48
- optional :pagination, -> { Sentdm::Models::TemplateListResponse::Data::Pagination }
47
+ # @return [Sentdm::Models::PaginationMeta, nil]
48
+ optional :pagination, -> { Sentdm::PaginationMeta }
49
49
 
50
50
  # @!attribute templates
51
51
  # The templates on this page.
52
52
  #
53
- # @return [Array<Sentdm::Models::TemplateListResponse::Data::Template>, nil]
54
- optional :templates,
55
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::TemplateListResponse::Data::Template] }
53
+ # @return [Array<Sentdm::Models::Template>, nil]
54
+ optional :templates, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Template] }
56
55
 
57
56
  # @!method initialize(pagination: nil, templates: nil)
58
57
  # A paginated list of templates.
59
58
  #
60
- # @param pagination [Sentdm::Models::TemplateListResponse::Data::Pagination] Pagination metadata for list responses
59
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
61
60
  #
62
- # @param templates [Array<Sentdm::Models::TemplateListResponse::Data::Template>] The templates on this page.
63
-
64
- # @see Sentdm::Models::TemplateListResponse::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::TemplateListResponse::Data::Pagination::Cursors, nil]
72
- optional :cursors, -> { Sentdm::Models::TemplateListResponse::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::TemplateListResponse::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::TemplateListResponse::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 Template < Sentdm::Internal::Type::BaseModel
145
- # @!attribute customer_id
146
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
147
- # Says whose resource this is, which the resource's own id does not.
148
- #
149
- # @return [String]
150
- required :customer_id, String
151
-
152
- # @!attribute id
153
- # Unique template identifier
154
- #
155
- # @return [String, nil]
156
- optional :id, String
157
-
158
- # @!attribute category
159
- # Template category: MARKETING, UTILITY, AUTHENTICATION
160
- #
161
- # @return [String, nil]
162
- optional :category, String
163
-
164
- # @!attribute channels
165
- # Supported channels: sms, whatsapp
166
- #
167
- # @return [Array<String>, nil]
168
- optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
169
-
170
- # @!attribute created_at
171
- # When the template was created
172
- #
173
- # @return [Time, nil]
174
- optional :created_at, Time
175
-
176
- # @!attribute is_published
177
- # Whether the template is published and active
178
- #
179
- # @return [Boolean, nil]
180
- optional :is_published, Sentdm::Internal::Type::Boolean
181
-
182
- # @!attribute language
183
- # Template language code (e.g., en_US)
184
- #
185
- # @return [String, nil]
186
- optional :language, String
187
-
188
- # @!attribute name
189
- # Template display name
190
- #
191
- # @return [String, nil]
192
- optional :name, String
193
-
194
- # @!attribute status
195
- # Template status: APPROVED, PENDING, REJECTED
196
- #
197
- # @return [String, nil]
198
- optional :status, String
199
-
200
- # @!attribute updated_at
201
- # When the template was last updated
202
- #
203
- # @return [Time, nil]
204
- optional :updated_at, Time, nil?: true
205
-
206
- # @!attribute variables
207
- # Template variables for personalization
208
- #
209
- # @return [Array<String>, nil]
210
- optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
211
-
212
- # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
213
- # Some parameter documentations has been truncated, see
214
- # {Sentdm::Models::TemplateListResponse::Data::Template} for more details.
215
- #
216
- # Template response for v3 API
217
- #
218
- # @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
219
- #
220
- # @param id [String] Unique template identifier
221
- #
222
- # @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
223
- #
224
- # @param channels [Array<String>, nil] Supported channels: sms, whatsapp
225
- #
226
- # @param created_at [Time] When the template was created
227
- #
228
- # @param is_published [Boolean] Whether the template is published and active
229
- #
230
- # @param language [String] Template language code (e.g., en_US)
231
- #
232
- # @param name [String] Template display name
233
- #
234
- # @param status [String] Template status: APPROVED, PENDING, REJECTED
235
- #
236
- # @param updated_at [Time, nil] When the template was last updated
237
- #
238
- # @param variables [Array<String>, nil] Template variables for personalization
239
- end
240
- end
241
-
242
- # @see Sentdm::Models::TemplateListResponse#error
243
- class Error < Sentdm::Internal::Type::BaseModel
244
- # @!attribute code
245
- # Machine-readable error code (e.g., "RESOURCE_001")
246
- #
247
- # @return [String, nil]
248
- optional :code, String
249
-
250
- # @!attribute details
251
- # Additional validation error details (field-level errors)
252
- #
253
- # @return [Hash{Symbol=>Array<String>}, nil]
254
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
255
-
256
- # @!attribute doc_url
257
- # URL to documentation about this error
258
- #
259
- # @return [String, nil]
260
- optional :doc_url, String, nil?: true
261
-
262
- # @!attribute message
263
- # Human-readable error message
264
- #
265
- # @return [String, nil]
266
- optional :message, String
267
-
268
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
269
- # Error information
270
- #
271
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
272
- #
273
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
274
- #
275
- # @param doc_url [String, nil] URL to documentation about this error
276
- #
277
- # @param message [String] Human-readable error message
278
- end
279
-
280
- # @see Sentdm::Models::TemplateListResponse#meta
281
- class Meta < Sentdm::Internal::Type::BaseModel
282
- # @!attribute request_id
283
- # Unique identifier for this request (for tracing and support)
284
- #
285
- # @return [String, nil]
286
- optional :request_id, String
287
-
288
- # @!attribute timestamp
289
- # Server timestamp when the response was generated
290
- #
291
- # @return [Time, nil]
292
- optional :timestamp, Time
293
-
294
- # @!attribute version
295
- # API version used for this request
296
- #
297
- # @return [String, nil]
298
- optional :version, String
299
-
300
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
301
- # Request and response metadata
302
- #
303
- # @param request_id [String] Unique identifier for this request (for tracing and support)
304
- #
305
- # @param timestamp [Time] Server timestamp when the response was generated
306
- #
307
- # @param version [String] API version used for this request
61
+ # @param templates [Array<Sentdm::Models::Template>] The templates on this page.
308
62
  end
309
63
  end
310
64
  end
@@ -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