sentdm 0.26.0 → 0.28.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 (293) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +40 -0
  3. data/README.md +1 -27
  4. data/lib/sentdm/client.rb +71 -8
  5. data/lib/sentdm/internal/type/base_model.rb +5 -5
  6. data/lib/sentdm/models/contact_create_response.rb +249 -0
  7. data/lib/sentdm/models/contact_delete_params.rb +16 -2
  8. data/lib/sentdm/models/contact_list_response.rb +299 -16
  9. data/lib/sentdm/models/contact_retrieve_message_summary_response.rb +186 -0
  10. data/lib/sentdm/models/contact_retrieve_response.rb +249 -0
  11. data/lib/sentdm/models/contact_update_response.rb +249 -0
  12. data/lib/sentdm/models/conversation_list_messages_response.rb +436 -0
  13. data/lib/sentdm/models/conversation_list_response.rb +433 -0
  14. data/lib/sentdm/models/inbound_message_event.rb +52 -0
  15. data/lib/sentdm/models/inbound_message_event_payload.rb +81 -0
  16. data/lib/sentdm/models/me_retrieve_response.rb +242 -12
  17. data/lib/sentdm/models/message_event.rb +53 -0
  18. data/lib/sentdm/models/message_event_payload.rb +92 -0
  19. data/lib/sentdm/models/message_retrieve_activities_response.rb +165 -7
  20. data/lib/sentdm/models/message_retrieve_status_response.rb +74 -6
  21. data/lib/sentdm/models/message_send_response.rb +113 -28
  22. data/lib/sentdm/models/number_lookup_response.rb +74 -6
  23. data/lib/sentdm/models/profile_complete_response.rb +74 -6
  24. data/lib/sentdm/models/profile_create_params.rb +378 -26
  25. data/lib/sentdm/models/profile_create_response.rb +760 -0
  26. data/lib/sentdm/models/profile_delete_params.rb +16 -2
  27. data/lib/sentdm/models/profile_list_response.rb +825 -14
  28. data/lib/sentdm/models/profile_retrieve_response.rb +762 -0
  29. data/lib/sentdm/models/profile_update_params.rb +391 -24
  30. data/lib/sentdm/models/profile_update_response.rb +760 -0
  31. data/lib/sentdm/models/profiles/campaign_create_params.rb +156 -3
  32. data/lib/sentdm/models/profiles/campaign_create_response.rb +420 -0
  33. data/lib/sentdm/models/profiles/campaign_delete_params.rb +17 -2
  34. data/lib/sentdm/models/profiles/campaign_list_response.rb +421 -0
  35. data/lib/sentdm/models/profiles/campaign_update_params.rb +156 -3
  36. data/lib/sentdm/models/profiles/campaign_update_response.rb +420 -0
  37. data/lib/sentdm/models/template_create_response.rb +209 -0
  38. data/lib/sentdm/models/template_event.rb +52 -0
  39. data/lib/sentdm/models/template_event_payload.rb +88 -0
  40. data/lib/sentdm/models/template_list_params.rb +9 -2
  41. data/lib/sentdm/models/template_list_response.rb +262 -16
  42. data/lib/sentdm/models/template_retrieve_response.rb +209 -0
  43. data/lib/sentdm/models/template_update_response.rb +209 -0
  44. data/lib/sentdm/models/user_invite_response.rb +201 -0
  45. data/lib/sentdm/models/user_list_response.rb +259 -14
  46. data/lib/sentdm/models/user_remove_params.rb +16 -2
  47. data/lib/sentdm/models/user_retrieve_response.rb +201 -0
  48. data/lib/sentdm/models/user_update_role_response.rb +201 -0
  49. data/lib/sentdm/models/webhook_create_response.rb +229 -0
  50. data/lib/sentdm/models/webhook_list_event_types_response.rb +213 -13
  51. data/lib/sentdm/models/webhook_list_events_response.rb +207 -16
  52. data/lib/sentdm/models/webhook_list_response.rb +280 -15
  53. data/lib/sentdm/models/webhook_retrieve_response.rb +229 -0
  54. data/lib/sentdm/models/webhook_rotate_secret_params.rb +17 -2
  55. data/lib/sentdm/models/webhook_rotate_secret_response.rb +74 -6
  56. data/lib/sentdm/models/webhook_test_response.rb +74 -6
  57. data/lib/sentdm/models/webhook_toggle_status_response.rb +229 -0
  58. data/lib/sentdm/models/webhook_update_response.rb +229 -0
  59. data/lib/sentdm/models.rb +11 -51
  60. data/lib/sentdm/resources/contacts.rb +30 -13
  61. data/lib/sentdm/resources/conversations.rb +12 -4
  62. data/lib/sentdm/resources/me.rb +6 -1
  63. data/lib/sentdm/resources/messages.rb +17 -5
  64. data/lib/sentdm/resources/numbers.rb +6 -1
  65. data/lib/sentdm/resources/profiles/campaigns.rb +47 -9
  66. data/lib/sentdm/resources/profiles.rb +137 -61
  67. data/lib/sentdm/resources/templates.rb +14 -8
  68. data/lib/sentdm/resources/users.rb +15 -10
  69. data/lib/sentdm/resources/webhooks.rb +19 -9
  70. data/lib/sentdm/version.rb +1 -1
  71. data/lib/sentdm.rb +28 -32
  72. data/rbi/sentdm/client.rbi +71 -8
  73. data/rbi/sentdm/models/contact_create_response.rbi +407 -0
  74. data/rbi/sentdm/models/contact_delete_params.rbi +19 -2
  75. data/rbi/sentdm/models/contact_list_response.rbi +527 -21
  76. data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +397 -0
  77. data/rbi/sentdm/models/contact_retrieve_response.rbi +409 -0
  78. data/rbi/sentdm/models/contact_update_response.rbi +407 -0
  79. data/rbi/sentdm/models/conversation_list_messages_response.rbi +843 -0
  80. data/rbi/sentdm/models/conversation_list_response.rbi +819 -0
  81. data/rbi/sentdm/models/inbound_message_event.rbi +88 -0
  82. data/rbi/sentdm/models/inbound_message_event_payload.rbi +122 -0
  83. data/rbi/sentdm/models/me_retrieve_response.rbi +367 -16
  84. data/rbi/sentdm/models/message_event.rbi +86 -0
  85. data/rbi/sentdm/models/message_event_payload.rbi +132 -0
  86. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +335 -11
  87. data/rbi/sentdm/models/message_retrieve_status_response.rbi +148 -8
  88. data/rbi/sentdm/models/message_send_response.rbi +178 -32
  89. data/rbi/sentdm/models/number_lookup_response.rbi +135 -8
  90. data/rbi/sentdm/models/profile_complete_response.rbi +137 -8
  91. data/rbi/sentdm/models/profile_create_params.rbi +592 -42
  92. data/rbi/sentdm/models/profile_create_response.rbi +1226 -0
  93. data/rbi/sentdm/models/profile_delete_params.rbi +19 -2
  94. data/rbi/sentdm/models/profile_list_response.rbi +1366 -18
  95. data/rbi/sentdm/models/profile_retrieve_response.rbi +1230 -0
  96. data/rbi/sentdm/models/profile_update_params.rbi +610 -30
  97. data/rbi/sentdm/models/profile_update_response.rbi +1226 -0
  98. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +218 -4
  99. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +674 -0
  100. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +14 -1
  101. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +667 -0
  102. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +218 -4
  103. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +674 -0
  104. data/rbi/sentdm/models/template_create_response.rbi +349 -0
  105. data/rbi/sentdm/models/template_event.rbi +84 -0
  106. data/rbi/sentdm/models/template_event_payload.rbi +131 -0
  107. data/rbi/sentdm/models/template_list_params.rbi +10 -2
  108. data/rbi/sentdm/models/template_list_response.rbi +469 -21
  109. data/rbi/sentdm/models/template_retrieve_response.rbi +355 -0
  110. data/rbi/sentdm/models/template_update_response.rbi +349 -0
  111. data/rbi/sentdm/models/user_invite_response.rbi +336 -0
  112. data/rbi/sentdm/models/user_list_response.rbi +463 -18
  113. data/rbi/sentdm/models/user_remove_params.rbi +19 -2
  114. data/rbi/sentdm/models/user_retrieve_response.rbi +336 -0
  115. data/rbi/sentdm/models/user_update_role_response.rbi +341 -0
  116. data/rbi/sentdm/models/webhook_create_response.rbi +361 -0
  117. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +433 -16
  118. data/rbi/sentdm/models/webhook_list_events_response.rbi +379 -19
  119. data/rbi/sentdm/models/webhook_list_response.rbi +480 -19
  120. data/rbi/sentdm/models/webhook_retrieve_response.rbi +363 -0
  121. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +14 -1
  122. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +148 -8
  123. data/rbi/sentdm/models/webhook_test_response.rbi +135 -8
  124. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +379 -0
  125. data/rbi/sentdm/models/webhook_update_response.rbi +361 -0
  126. data/rbi/sentdm/models.rbi +11 -53
  127. data/rbi/sentdm/resources/contacts.rbi +24 -9
  128. data/rbi/sentdm/resources/conversations.rbi +10 -2
  129. data/rbi/sentdm/resources/me.rbi +6 -1
  130. data/rbi/sentdm/resources/messages.rbi +17 -5
  131. data/rbi/sentdm/resources/numbers.rbi +6 -1
  132. data/rbi/sentdm/resources/profiles/campaigns.rbi +36 -6
  133. data/rbi/sentdm/resources/profiles.rbi +177 -68
  134. data/rbi/sentdm/resources/templates.rbi +15 -5
  135. data/rbi/sentdm/resources/users.rbi +12 -6
  136. data/rbi/sentdm/resources/webhooks.rbi +15 -5
  137. data/sig/sentdm/models/contact_create_response.rbs +216 -0
  138. data/sig/sentdm/models/contact_delete_params.rbs +10 -6
  139. data/sig/sentdm/models/contact_list_response.rbs +263 -20
  140. data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +182 -0
  141. data/sig/sentdm/models/contact_retrieve_response.rbs +216 -0
  142. data/sig/sentdm/models/contact_update_response.rbs +216 -0
  143. data/sig/sentdm/models/conversation_list_messages_response.rbs +404 -0
  144. data/sig/sentdm/models/conversation_list_response.rbs +404 -0
  145. data/sig/sentdm/models/inbound_message_event.rbs +39 -0
  146. data/sig/sentdm/models/inbound_message_event_payload.rbs +69 -0
  147. data/sig/sentdm/models/me_retrieve_response.rbs +176 -18
  148. data/sig/sentdm/models/message_event.rbs +39 -0
  149. data/sig/sentdm/models/message_event_payload.rbs +72 -0
  150. data/sig/sentdm/models/message_retrieve_activities_response.rbs +147 -12
  151. data/sig/sentdm/models/message_retrieve_status_response.rbs +71 -9
  152. data/sig/sentdm/models/message_send_response.rbs +71 -9
  153. data/sig/sentdm/models/number_lookup_response.rbs +71 -9
  154. data/sig/sentdm/models/profile_complete_response.rbs +71 -9
  155. data/sig/sentdm/models/profile_create_params.rbs +271 -24
  156. data/sig/sentdm/models/profile_create_response.rbs +559 -0
  157. data/sig/sentdm/models/profile_delete_params.rbs +10 -6
  158. data/sig/sentdm/models/profile_list_response.rbs +615 -15
  159. data/sig/sentdm/models/profile_retrieve_response.rbs +559 -0
  160. data/sig/sentdm/models/profile_update_params.rbs +263 -12
  161. data/sig/sentdm/models/profile_update_response.rbs +559 -0
  162. data/sig/sentdm/models/profiles/campaign_create_params.rbs +108 -4
  163. data/sig/sentdm/models/profiles/campaign_create_response.rbs +357 -0
  164. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +15 -8
  165. data/sig/sentdm/models/profiles/campaign_list_response.rbs +357 -0
  166. data/sig/sentdm/models/profiles/campaign_update_params.rbs +108 -4
  167. data/sig/sentdm/models/profiles/campaign_update_response.rbs +357 -0
  168. data/sig/sentdm/models/template_create_response.rbs +182 -0
  169. data/sig/sentdm/models/template_event.rbs +39 -0
  170. data/sig/sentdm/models/template_event_payload.rbs +76 -0
  171. data/sig/sentdm/models/template_list_response.rbs +230 -19
  172. data/sig/sentdm/models/template_retrieve_response.rbs +182 -0
  173. data/sig/sentdm/models/template_update_response.rbs +182 -0
  174. data/sig/sentdm/models/user_invite_response.rbs +177 -0
  175. data/sig/sentdm/models/user_list_response.rbs +233 -15
  176. data/sig/sentdm/models/user_remove_params.rbs +10 -6
  177. data/sig/sentdm/models/user_retrieve_response.rbs +177 -0
  178. data/sig/sentdm/models/user_update_role_response.rbs +177 -0
  179. data/sig/sentdm/models/webhook_create_response.rbs +208 -0
  180. data/sig/sentdm/models/webhook_list_event_types_response.rbs +203 -15
  181. data/sig/sentdm/models/webhook_list_events_response.rbs +160 -19
  182. data/sig/sentdm/models/webhook_list_response.rbs +255 -20
  183. data/sig/sentdm/models/webhook_retrieve_response.rbs +208 -0
  184. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +17 -8
  185. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +71 -9
  186. data/sig/sentdm/models/webhook_test_response.rbs +71 -9
  187. data/sig/sentdm/models/webhook_toggle_status_response.rbs +208 -0
  188. data/sig/sentdm/models/webhook_update_response.rbs +208 -0
  189. data/sig/sentdm/models.rbs +11 -51
  190. data/sig/sentdm/resources/contacts.rbs +4 -4
  191. data/sig/sentdm/resources/conversations.rbs +2 -2
  192. data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
  193. data/sig/sentdm/resources/profiles.rbs +11 -11
  194. data/sig/sentdm/resources/templates.rbs +3 -3
  195. data/sig/sentdm/resources/users.rbs +3 -3
  196. data/sig/sentdm/resources/webhooks.rbs +4 -4
  197. metadata +86 -98
  198. data/lib/sentdm/models/api_meta.rb +0 -34
  199. data/lib/sentdm/models/api_response_of_contact.rb +0 -46
  200. data/lib/sentdm/models/api_response_of_contact_message_summary.rb +0 -43
  201. data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +0 -43
  202. data/lib/sentdm/models/api_response_of_profile_detail.rb +0 -43
  203. data/lib/sentdm/models/api_response_of_user.rb +0 -43
  204. data/lib/sentdm/models/api_response_template.rb +0 -43
  205. data/lib/sentdm/models/api_response_webhook.rb +0 -43
  206. data/lib/sentdm/models/billing_contact_info.rb +0 -47
  207. data/lib/sentdm/models/brand_business_info.rb +0 -114
  208. data/lib/sentdm/models/brand_compliance_info.rb +0 -67
  209. data/lib/sentdm/models/brand_contact_info.rb +0 -58
  210. data/lib/sentdm/models/brands_brand_data.rb +0 -34
  211. data/lib/sentdm/models/contact_message_summary.rb +0 -76
  212. data/lib/sentdm/models/contact_response.rb +0 -126
  213. data/lib/sentdm/models/conversation_messages_list.rb +0 -245
  214. data/lib/sentdm/models/error_detail.rb +0 -42
  215. data/lib/sentdm/models/mutation_request.rb +0 -20
  216. data/lib/sentdm/models/pagination_meta.rb +0 -80
  217. data/lib/sentdm/models/payment_details.rb +0 -44
  218. data/lib/sentdm/models/profile_detail.rb +0 -597
  219. data/lib/sentdm/models/profile_settings.rb +0 -66
  220. data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +0 -45
  221. data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +0 -45
  222. data/lib/sentdm/models/profiles/brand_campaign.rb +0 -247
  223. data/lib/sentdm/models/profiles/campaign_data.rb +0 -130
  224. data/lib/sentdm/models/profiles/campaign_use_case.rb +0 -71
  225. data/lib/sentdm/models/profiles/campaign_use_case_data.rb +0 -29
  226. data/lib/sentdm/models/template.rb +0 -90
  227. data/lib/sentdm/models/user_response.rb +0 -82
  228. data/lib/sentdm/models/webhook_event_type.rb +0 -45
  229. data/lib/sentdm/models/webhook_response.rb +0 -95
  230. data/rbi/sentdm/models/api_meta.rbi +0 -55
  231. data/rbi/sentdm/models/api_response_of_contact.rbi +0 -74
  232. data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi +0 -79
  233. data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +0 -79
  234. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +0 -74
  235. data/rbi/sentdm/models/api_response_of_user.rbi +0 -74
  236. data/rbi/sentdm/models/api_response_template.rbi +0 -74
  237. data/rbi/sentdm/models/api_response_webhook.rbi +0 -74
  238. data/rbi/sentdm/models/billing_contact_info.rbi +0 -65
  239. data/rbi/sentdm/models/brand_business_info.rbi +0 -162
  240. data/rbi/sentdm/models/brand_compliance_info.rbi +0 -84
  241. data/rbi/sentdm/models/brand_contact_info.rbi +0 -78
  242. data/rbi/sentdm/models/brands_brand_data.rbi +0 -65
  243. data/rbi/sentdm/models/contact_message_summary.rbi +0 -144
  244. data/rbi/sentdm/models/contact_response.rbi +0 -183
  245. data/rbi/sentdm/models/conversation_messages_list.rbi +0 -419
  246. data/rbi/sentdm/models/error_detail.rbi +0 -66
  247. data/rbi/sentdm/models/mutation_request.rbi +0 -32
  248. data/rbi/sentdm/models/pagination_meta.rbi +0 -135
  249. data/rbi/sentdm/models/payment_details.rbi +0 -59
  250. data/rbi/sentdm/models/profile_detail.rbi +0 -866
  251. data/rbi/sentdm/models/profile_settings.rbi +0 -86
  252. data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +0 -81
  253. data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +0 -76
  254. data/rbi/sentdm/models/profiles/brand_campaign.rbi +0 -299
  255. data/rbi/sentdm/models/profiles/campaign_data.rbi +0 -146
  256. data/rbi/sentdm/models/profiles/campaign_use_case.rbi +0 -110
  257. data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +0 -51
  258. data/rbi/sentdm/models/template.rbi +0 -129
  259. data/rbi/sentdm/models/user_response.rbi +0 -118
  260. data/rbi/sentdm/models/webhook_event_type.rbi +0 -74
  261. data/rbi/sentdm/models/webhook_response.rbi +0 -140
  262. data/sig/sentdm/models/api_meta.rbs +0 -27
  263. data/sig/sentdm/models/api_response_of_contact.rbs +0 -39
  264. data/sig/sentdm/models/api_response_of_contact_message_summary.rbs +0 -39
  265. data/sig/sentdm/models/api_response_of_conversation_messages_list.rbs +0 -39
  266. data/sig/sentdm/models/api_response_of_profile_detail.rbs +0 -39
  267. data/sig/sentdm/models/api_response_of_user.rbs +0 -39
  268. data/sig/sentdm/models/api_response_template.rbs +0 -39
  269. data/sig/sentdm/models/api_response_webhook.rbs +0 -39
  270. data/sig/sentdm/models/billing_contact_info.rbs +0 -30
  271. data/sig/sentdm/models/brand_business_info.rbs +0 -89
  272. data/sig/sentdm/models/brand_compliance_info.rbs +0 -50
  273. data/sig/sentdm/models/brand_contact_info.rbs +0 -45
  274. data/sig/sentdm/models/brands_brand_data.rbs +0 -30
  275. data/sig/sentdm/models/contact_message_summary.rbs +0 -84
  276. data/sig/sentdm/models/contact_response.rbs +0 -111
  277. data/sig/sentdm/models/conversation_messages_list.rbs +0 -240
  278. data/sig/sentdm/models/error_detail.rbs +0 -39
  279. data/sig/sentdm/models/mutation_request.rbs +0 -15
  280. data/sig/sentdm/models/pagination_meta.rbs +0 -67
  281. data/sig/sentdm/models/payment_details.rbs +0 -30
  282. data/sig/sentdm/models/profile_detail.rbs +0 -469
  283. data/sig/sentdm/models/profile_settings.rbs +0 -50
  284. data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +0 -41
  285. data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +0 -41
  286. data/sig/sentdm/models/profiles/brand_campaign.rbs +0 -194
  287. data/sig/sentdm/models/profiles/campaign_data.rbs +0 -87
  288. data/sig/sentdm/models/profiles/campaign_use_case.rbs +0 -66
  289. data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +0 -27
  290. data/sig/sentdm/models/template.rbs +0 -79
  291. data/sig/sentdm/models/user_response.rbs +0 -72
  292. data/sig/sentdm/models/webhook_event_type.rbs +0 -51
  293. data/sig/sentdm/models/webhook_response.rbs +0 -103
@@ -1,245 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- class ConversationMessagesList < Sentdm::Internal::Type::BaseModel
6
- # @!attribute messages
7
- # The messages on this page, most recent first.
8
- #
9
- # @return [Array<Sentdm::Models::ConversationMessagesList::Message>, nil]
10
- optional :messages, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message] }
11
-
12
- # @!attribute pagination
13
- # Pagination metadata for list responses
14
- #
15
- # @return [Sentdm::Models::PaginationMeta, nil]
16
- optional :pagination, -> { Sentdm::PaginationMeta }
17
-
18
- # @!method initialize(messages: nil, pagination: nil)
19
- # A paginated list of messages — used by both conversation read endpoints.
20
- #
21
- # @param messages [Array<Sentdm::Models::ConversationMessagesList::Message>] The messages on this page, most recent first.
22
- #
23
- # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
24
-
25
- class Message < Sentdm::Internal::Type::BaseModel
26
- # @!attribute id
27
- #
28
- # @return [String, nil]
29
- optional :id, String
30
-
31
- # @!attribute active_contact_price
32
- #
33
- # @return [Float, nil]
34
- optional :active_contact_price, Float, nil?: true
35
-
36
- # @!attribute channel
37
- #
38
- # @return [String, nil]
39
- optional :channel, String
40
-
41
- # @!attribute contact_id
42
- #
43
- # @return [String, nil]
44
- optional :contact_id, String
45
-
46
- # @!attribute created_at
47
- #
48
- # @return [Time, nil]
49
- optional :created_at, Time
50
-
51
- # @!attribute customer_id
52
- #
53
- # @return [String, nil]
54
- optional :customer_id, String
55
-
56
- # @!attribute direction
57
- #
58
- # @return [String, nil]
59
- optional :direction, String
60
-
61
- # @!attribute events
62
- #
63
- # @return [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
64
- optional :events,
65
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::Event] },
66
- nil?: true
67
-
68
- # @!attribute message_body
69
- # Structured message body format for database storage. Preserves channel-specific
70
- # components (header, body, footer, buttons).
71
- #
72
- # @return [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil]
73
- optional :message_body, -> { Sentdm::ConversationMessagesList::Message::MessageBody }, nil?: true
74
-
75
- # @!attribute phone
76
- #
77
- # @return [String, nil]
78
- optional :phone, String
79
-
80
- # @!attribute phone_international
81
- #
82
- # @return [String, nil]
83
- optional :phone_international, String
84
-
85
- # @!attribute price
86
- #
87
- # @return [Float, nil]
88
- optional :price, Float, nil?: true
89
-
90
- # @!attribute region_code
91
- #
92
- # @return [String, nil]
93
- optional :region_code, String
94
-
95
- # @!attribute status
96
- #
97
- # @return [String, nil]
98
- optional :status, String
99
-
100
- # @!attribute template_category
101
- #
102
- # @return [String, nil]
103
- optional :template_category, String, nil?: true
104
-
105
- # @!attribute template_id
106
- #
107
- # @return [String, nil]
108
- optional :template_id, String, nil?: true
109
-
110
- # @!attribute template_name
111
- #
112
- # @return [String, nil]
113
- optional :template_name, String, nil?: true
114
-
115
- # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
116
- # Some parameter documentations has been truncated, see
117
- # {Sentdm::Models::ConversationMessagesList::Message} for more details.
118
- #
119
- # Message response for v3 API — same shape as v2 with snake_case JSON conventions
120
- #
121
- # @param id [String]
122
- #
123
- # @param active_contact_price [Float, nil]
124
- #
125
- # @param channel [String]
126
- #
127
- # @param contact_id [String]
128
- #
129
- # @param created_at [Time]
130
- #
131
- # @param customer_id [String]
132
- #
133
- # @param direction [String]
134
- #
135
- # @param events [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
136
- #
137
- # @param message_body [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil] Structured message body format for database storage.
138
- #
139
- # @param phone [String]
140
- #
141
- # @param phone_international [String]
142
- #
143
- # @param price [Float, nil]
144
- #
145
- # @param region_code [String]
146
- #
147
- # @param status [String]
148
- #
149
- # @param template_category [String, nil]
150
- #
151
- # @param template_id [String, nil]
152
- #
153
- # @param template_name [String, nil]
154
-
155
- class Event < Sentdm::Internal::Type::BaseModel
156
- # @!attribute status
157
- #
158
- # @return [String]
159
- required :status, String
160
-
161
- # @!attribute timestamp
162
- #
163
- # @return [Time]
164
- required :timestamp, Time
165
-
166
- # @!attribute description
167
- #
168
- # @return [String, nil]
169
- optional :description, String, nil?: true
170
-
171
- # @!method initialize(status:, timestamp:, description: nil)
172
- # Represents a status change event in a message's lifecycle (v3)
173
- #
174
- # @param status [String]
175
- # @param timestamp [Time]
176
- # @param description [String, nil]
177
- end
178
-
179
- # @see Sentdm::Models::ConversationMessagesList::Message#message_body
180
- class MessageBody < Sentdm::Internal::Type::BaseModel
181
- # @!attribute buttons
182
- #
183
- # @return [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
184
- optional :buttons,
185
- -> {
186
- Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::MessageBody::Button]
187
- },
188
- nil?: true
189
-
190
- # @!attribute content
191
- #
192
- # @return [String, nil]
193
- optional :content, String
194
-
195
- # @!attribute footer
196
- #
197
- # @return [String, nil]
198
- optional :footer, String, nil?: true
199
-
200
- # @!attribute header
201
- #
202
- # @return [String, nil]
203
- optional :header, String, nil?: true
204
-
205
- # @!method initialize(buttons: nil, content: nil, footer: nil, header: nil)
206
- # Structured message body format for database storage. Preserves channel-specific
207
- # components (header, body, footer, buttons).
208
- #
209
- # @param buttons [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
210
- # @param content [String]
211
- # @param footer [String, nil]
212
- # @param header [String, nil]
213
-
214
- class Button < Sentdm::Internal::Type::BaseModel
215
- # @!attribute postback_data
216
- #
217
- # @return [String, nil]
218
- optional :postback_data, String, api_name: :postbackData, nil?: true
219
-
220
- # @!attribute text
221
- #
222
- # @return [String, nil]
223
- optional :text, String, nil?: true
224
-
225
- # @!attribute type
226
- #
227
- # @return [String, nil]
228
- optional :type, String
229
-
230
- # @!attribute value
231
- #
232
- # @return [String, nil]
233
- optional :value, String
234
-
235
- # @!method initialize(postback_data: nil, text: nil, type: nil, value: nil)
236
- # @param postback_data [String, nil]
237
- # @param text [String, nil]
238
- # @param type [String]
239
- # @param value [String]
240
- end
241
- end
242
- end
243
- end
244
- end
245
- end
@@ -1,42 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- class ErrorDetail < Sentdm::Internal::Type::BaseModel
6
- # @!attribute code
7
- # Machine-readable error code (e.g., "RESOURCE_001")
8
- #
9
- # @return [String, nil]
10
- optional :code, String
11
-
12
- # @!attribute details
13
- # Additional validation error details (field-level errors)
14
- #
15
- # @return [Hash{Symbol=>Array<String>}, nil]
16
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
17
-
18
- # @!attribute doc_url
19
- # URL to documentation about this error
20
- #
21
- # @return [String, nil]
22
- optional :doc_url, String, nil?: true
23
-
24
- # @!attribute message
25
- # Human-readable error message
26
- #
27
- # @return [String, nil]
28
- optional :message, String
29
-
30
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
31
- # Error information
32
- #
33
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
34
- #
35
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
36
- #
37
- # @param doc_url [String, nil] URL to documentation about this error
38
- #
39
- # @param message [String] Human-readable error message
40
- end
41
- end
42
- end
@@ -1,20 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- class MutationRequest < Sentdm::Internal::Type::BaseModel
6
- # @!attribute sandbox
7
- # Sandbox flag - when true, the operation is simulated without side effects Useful
8
- # for testing integrations without actual execution
9
- #
10
- # @return [Boolean, nil]
11
- optional :sandbox, Sentdm::Internal::Type::Boolean
12
-
13
- # @!method initialize(sandbox: nil)
14
- # Some parameter documentations has been truncated, see
15
- # {Sentdm::Models::MutationRequest} for more details.
16
- #
17
- # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
18
- end
19
- end
20
- end
@@ -1,80 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- class PaginationMeta < Sentdm::Internal::Type::BaseModel
6
- # @!attribute cursors
7
- # Cursor-based pagination pointers
8
- #
9
- # @return [Sentdm::Models::PaginationMeta::Cursors, nil]
10
- optional :cursors, -> { Sentdm::PaginationMeta::Cursors }, nil?: true
11
-
12
- # @!attribute has_more
13
- # Whether there are more pages after this one
14
- #
15
- # @return [Boolean, nil]
16
- optional :has_more, Sentdm::Internal::Type::Boolean
17
-
18
- # @!attribute page
19
- # Current page number (1-indexed)
20
- #
21
- # @return [Integer, nil]
22
- optional :page, Integer
23
-
24
- # @!attribute page_size
25
- # Number of items per page
26
- #
27
- # @return [Integer, nil]
28
- optional :page_size, Integer
29
-
30
- # @!attribute total_count
31
- # Total number of items across all pages
32
- #
33
- # @return [Integer, nil]
34
- optional :total_count, Integer
35
-
36
- # @!attribute total_pages
37
- # Total number of pages
38
- #
39
- # @return [Integer, nil]
40
- optional :total_pages, Integer
41
-
42
- # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
43
- # Pagination metadata for list responses
44
- #
45
- # @param cursors [Sentdm::Models::PaginationMeta::Cursors, nil] Cursor-based pagination pointers
46
- #
47
- # @param has_more [Boolean] Whether there are more pages after this one
48
- #
49
- # @param page [Integer] Current page number (1-indexed)
50
- #
51
- # @param page_size [Integer] Number of items per page
52
- #
53
- # @param total_count [Integer] Total number of items across all pages
54
- #
55
- # @param total_pages [Integer] Total number of pages
56
-
57
- # @see Sentdm::Models::PaginationMeta#cursors
58
- class Cursors < Sentdm::Internal::Type::BaseModel
59
- # @!attribute after
60
- # Cursor to fetch the next page
61
- #
62
- # @return [String, nil]
63
- optional :after, String, nil?: true
64
-
65
- # @!attribute before
66
- # Cursor to fetch the previous page
67
- #
68
- # @return [String, nil]
69
- optional :before, String, nil?: true
70
-
71
- # @!method initialize(after: nil, before: nil)
72
- # Cursor-based pagination pointers
73
- #
74
- # @param after [String, nil] Cursor to fetch the next page
75
- #
76
- # @param before [String, nil] Cursor to fetch the previous page
77
- end
78
- end
79
- end
80
- end
@@ -1,44 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- class PaymentDetails < Sentdm::Internal::Type::BaseModel
6
- # @!attribute card_number
7
- # Card number (digits only, 13–19 characters)
8
- #
9
- # @return [String]
10
- required :card_number, String
11
-
12
- # @!attribute cvc
13
- # Card security code (3–4 digits)
14
- #
15
- # @return [String]
16
- required :cvc, String
17
-
18
- # @!attribute expiry
19
- # Card expiry date in MM/YY format (e.g. "09/27")
20
- #
21
- # @return [String]
22
- required :expiry, String
23
-
24
- # @!attribute zip_code
25
- # Billing ZIP / postal code associated with the card
26
- #
27
- # @return [String]
28
- required :zip_code, String
29
-
30
- # @!method initialize(card_number:, cvc:, expiry:, zip_code:)
31
- # Payment card details for a profile. Accepted when billing_model is "profile" or
32
- # "profile_and_organization". These details are not stored on our servers and will
33
- # be forwarded to the payment processor.
34
- #
35
- # @param card_number [String] Card number (digits only, 13–19 characters)
36
- #
37
- # @param cvc [String] Card security code (3–4 digits)
38
- #
39
- # @param expiry [String] Card expiry date in MM/YY format (e.g. "09/27")
40
- #
41
- # @param zip_code [String] Billing ZIP / postal code associated with the card
42
- end
43
- end
44
- end