sentdm 0.28.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (276) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +27 -1
  4. data/lib/sentdm/internal/type/base_model.rb +5 -5
  5. data/lib/sentdm/models/api_meta.rb +34 -0
  6. data/lib/sentdm/models/api_response_of_contact.rb +46 -0
  7. data/lib/sentdm/models/api_response_of_contact_message_summary.rb +43 -0
  8. data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +43 -0
  9. data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
  10. data/lib/sentdm/models/api_response_of_user.rb +43 -0
  11. data/lib/sentdm/models/api_response_template.rb +43 -0
  12. data/lib/sentdm/models/api_response_webhook.rb +43 -0
  13. data/lib/sentdm/models/billing_contact_info.rb +47 -0
  14. data/lib/sentdm/models/brand_business_info.rb +114 -0
  15. data/lib/sentdm/models/brand_compliance_info.rb +59 -0
  16. data/lib/sentdm/models/brand_contact_info.rb +58 -0
  17. data/lib/sentdm/models/brands_brand_data.rb +34 -0
  18. data/lib/sentdm/models/contact_delete_params.rb +2 -16
  19. data/lib/sentdm/models/contact_list_response.rb +12 -295
  20. data/lib/sentdm/models/contact_message_summary.rb +76 -0
  21. data/lib/sentdm/models/contact_response.rb +139 -0
  22. data/lib/sentdm/models/conversation_messages_list.rb +245 -0
  23. data/lib/sentdm/models/error_detail.rb +42 -0
  24. data/lib/sentdm/models/inbound_message_event_payload.rb +17 -17
  25. data/lib/sentdm/models/me_retrieve_response.rb +43 -243
  26. data/lib/sentdm/models/message_event_payload.rb +11 -11
  27. data/lib/sentdm/models/message_retrieve_activities_response.rb +9 -159
  28. data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
  29. data/lib/sentdm/models/message_send_response.rb +6 -74
  30. data/lib/sentdm/models/mutation_request.rb +20 -0
  31. data/lib/sentdm/models/number_lookup_response.rb +6 -74
  32. data/lib/sentdm/models/pagination_meta.rb +84 -0
  33. data/lib/sentdm/models/payment_details.rb +40 -0
  34. data/lib/sentdm/models/profile_complete_response.rb +6 -74
  35. data/lib/sentdm/models/profile_create_params.rb +9 -345
  36. data/lib/sentdm/models/profile_delete_params.rb +2 -16
  37. data/lib/sentdm/models/profile_detail.rb +650 -0
  38. data/lib/sentdm/models/profile_list_response.rb +12 -815
  39. data/lib/sentdm/models/profile_settings.rb +85 -0
  40. data/lib/sentdm/models/profile_update_params.rb +9 -345
  41. data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +45 -0
  42. data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +45 -0
  43. data/lib/sentdm/models/profiles/brand_campaign.rb +247 -0
  44. data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -156
  45. data/lib/sentdm/models/profiles/campaign_data.rb +136 -0
  46. data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
  47. data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -156
  48. data/lib/sentdm/models/profiles/campaign_use_case.rb +71 -0
  49. data/lib/sentdm/models/profiles/campaign_use_case_data.rb +29 -0
  50. data/lib/sentdm/models/template.rb +102 -0
  51. data/lib/sentdm/models/template_event_payload.rb +18 -18
  52. data/lib/sentdm/models/template_list_response.rb +12 -258
  53. data/lib/sentdm/models/user_list_response.rb +12 -249
  54. data/lib/sentdm/models/user_remove_params.rb +2 -16
  55. data/lib/sentdm/models/user_response.rb +94 -0
  56. data/lib/sentdm/models/webhook_event_type.rb +45 -0
  57. data/lib/sentdm/models/webhook_list_event_types_response.rb +12 -203
  58. data/lib/sentdm/models/webhook_list_events_response.rb +9 -157
  59. data/lib/sentdm/models/webhook_list_response.rb +12 -276
  60. data/lib/sentdm/models/webhook_response.rb +120 -0
  61. data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
  62. data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
  63. data/lib/sentdm/models/webhook_test_response.rb +6 -74
  64. data/lib/sentdm/models.rb +52 -0
  65. data/lib/sentdm/resources/contacts.rb +8 -8
  66. data/lib/sentdm/resources/conversations.rb +4 -4
  67. data/lib/sentdm/resources/me.rb +11 -0
  68. data/lib/sentdm/resources/profiles/campaigns.rb +8 -8
  69. data/lib/sentdm/resources/profiles.rb +12 -12
  70. data/lib/sentdm/resources/templates.rb +6 -6
  71. data/lib/sentdm/resources/users.rb +6 -6
  72. data/lib/sentdm/resources/webhooks.rb +8 -8
  73. data/lib/sentdm/version.rb +1 -1
  74. data/lib/sentdm.rb +32 -22
  75. data/rbi/sentdm/models/api_meta.rbi +55 -0
  76. data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
  77. data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi +79 -0
  78. data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +79 -0
  79. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
  80. data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
  81. data/rbi/sentdm/models/api_response_template.rbi +74 -0
  82. data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
  83. data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
  84. data/rbi/sentdm/models/brand_business_info.rbi +162 -0
  85. data/rbi/sentdm/models/brand_compliance_info.rbi +76 -0
  86. data/rbi/sentdm/models/brand_contact_info.rbi +78 -0
  87. data/rbi/sentdm/models/brands_brand_data.rbi +65 -0
  88. data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
  89. data/rbi/sentdm/models/contact_list_response.rbi +16 -522
  90. data/rbi/sentdm/models/contact_message_summary.rbi +144 -0
  91. data/rbi/sentdm/models/contact_response.rbi +200 -0
  92. data/rbi/sentdm/models/conversation_messages_list.rbi +419 -0
  93. data/rbi/sentdm/models/error_detail.rbi +66 -0
  94. data/rbi/sentdm/models/inbound_message_event_payload.rbi +16 -22
  95. data/rbi/sentdm/models/me_retrieve_response.rbi +60 -367
  96. data/rbi/sentdm/models/message_event_payload.rbi +12 -15
  97. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +12 -325
  98. data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
  99. data/rbi/sentdm/models/message_send_response.rbi +8 -135
  100. data/rbi/sentdm/models/mutation_request.rbi +32 -0
  101. data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
  102. data/rbi/sentdm/models/pagination_meta.rbi +135 -0
  103. data/rbi/sentdm/models/payment_details.rbi +56 -0
  104. data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
  105. data/rbi/sentdm/models/profile_create_params.rbi +12 -546
  106. data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
  107. data/rbi/sentdm/models/profile_detail.rbi +918 -0
  108. data/rbi/sentdm/models/profile_list_response.rbi +16 -1347
  109. data/rbi/sentdm/models/profile_settings.rbi +102 -0
  110. data/rbi/sentdm/models/profile_update_params.rbi +12 -546
  111. data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +81 -0
  112. data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +76 -0
  113. data/rbi/sentdm/models/profiles/brand_campaign.rbi +299 -0
  114. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -218
  115. data/rbi/sentdm/models/profiles/campaign_data.rbi +158 -0
  116. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
  117. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -218
  118. data/rbi/sentdm/models/profiles/campaign_use_case.rbi +110 -0
  119. data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +51 -0
  120. data/rbi/sentdm/models/template.rbi +139 -0
  121. data/rbi/sentdm/models/template_event_payload.rbi +21 -27
  122. data/rbi/sentdm/models/template_list_response.rbi +16 -464
  123. data/rbi/sentdm/models/user_list_response.rbi +16 -444
  124. data/rbi/sentdm/models/user_remove_params.rbi +2 -19
  125. data/rbi/sentdm/models/user_response.rbi +131 -0
  126. data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
  127. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +16 -414
  128. data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
  129. data/rbi/sentdm/models/webhook_list_response.rbi +16 -475
  130. data/rbi/sentdm/models/webhook_response.rbi +153 -0
  131. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
  132. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
  133. data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
  134. data/rbi/sentdm/models.rbi +54 -0
  135. data/rbi/sentdm/resources/contacts.rbi +4 -4
  136. data/rbi/sentdm/resources/conversations.rbi +2 -2
  137. data/rbi/sentdm/resources/me.rbi +11 -0
  138. data/rbi/sentdm/resources/profiles/campaigns.rbi +5 -5
  139. data/rbi/sentdm/resources/profiles.rbi +9 -13
  140. data/rbi/sentdm/resources/templates.rbi +3 -3
  141. data/rbi/sentdm/resources/users.rbi +3 -3
  142. data/rbi/sentdm/resources/webhooks.rbi +4 -4
  143. data/sig/sentdm/models/api_meta.rbs +27 -0
  144. data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
  145. data/sig/sentdm/models/api_response_of_contact_message_summary.rbs +39 -0
  146. data/sig/sentdm/models/api_response_of_conversation_messages_list.rbs +39 -0
  147. data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
  148. data/sig/sentdm/models/api_response_of_user.rbs +39 -0
  149. data/sig/sentdm/models/api_response_template.rbs +39 -0
  150. data/sig/sentdm/models/api_response_webhook.rbs +39 -0
  151. data/sig/sentdm/models/billing_contact_info.rbs +30 -0
  152. data/sig/sentdm/models/brand_business_info.rbs +89 -0
  153. data/sig/sentdm/models/brand_compliance_info.rbs +45 -0
  154. data/sig/sentdm/models/brand_contact_info.rbs +45 -0
  155. data/sig/sentdm/models/brands_brand_data.rbs +30 -0
  156. data/sig/sentdm/models/contact_delete_params.rbs +6 -10
  157. data/sig/sentdm/models/contact_list_response.rbs +20 -263
  158. data/sig/sentdm/models/contact_message_summary.rbs +84 -0
  159. data/sig/sentdm/models/contact_response.rbs +118 -0
  160. data/sig/sentdm/models/conversation_messages_list.rbs +240 -0
  161. data/sig/sentdm/models/error_detail.rbs +39 -0
  162. data/sig/sentdm/models/inbound_message_event_payload.rbs +10 -14
  163. data/sig/sentdm/models/me_retrieve_response.rbs +28 -176
  164. data/sig/sentdm/models/message_event_payload.rbs +5 -7
  165. data/sig/sentdm/models/message_retrieve_activities_response.rbs +14 -142
  166. data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
  167. data/sig/sentdm/models/message_send_response.rbs +9 -71
  168. data/sig/sentdm/models/mutation_request.rbs +15 -0
  169. data/sig/sentdm/models/number_lookup_response.rbs +9 -71
  170. data/sig/sentdm/models/pagination_meta.rbs +67 -0
  171. data/sig/sentdm/models/payment_details.rbs +30 -0
  172. data/sig/sentdm/models/profile_complete_response.rbs +9 -71
  173. data/sig/sentdm/models/profile_create_params.rbs +12 -263
  174. data/sig/sentdm/models/profile_delete_params.rbs +6 -10
  175. data/sig/sentdm/models/profile_detail.rbs +461 -0
  176. data/sig/sentdm/models/profile_list_response.rbs +20 -606
  177. data/sig/sentdm/models/profile_settings.rbs +50 -0
  178. data/sig/sentdm/models/profile_update_params.rbs +12 -263
  179. data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +41 -0
  180. data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +41 -0
  181. data/sig/sentdm/models/profiles/brand_campaign.rbs +194 -0
  182. data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -108
  183. data/sig/sentdm/models/profiles/campaign_data.rbs +87 -0
  184. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
  185. data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -108
  186. data/sig/sentdm/models/profiles/campaign_use_case.rbs +66 -0
  187. data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +27 -0
  188. data/sig/sentdm/models/template.rbs +84 -0
  189. data/sig/sentdm/models/template_event_payload.rbs +13 -17
  190. data/sig/sentdm/models/template_list_response.rbs +19 -230
  191. data/sig/sentdm/models/user_list_response.rbs +20 -224
  192. data/sig/sentdm/models/user_remove_params.rbs +6 -10
  193. data/sig/sentdm/models/user_response.rbs +79 -0
  194. data/sig/sentdm/models/webhook_event_type.rbs +51 -0
  195. data/sig/sentdm/models/webhook_list_event_types_response.rbs +20 -196
  196. data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
  197. data/sig/sentdm/models/webhook_list_response.rbs +20 -255
  198. data/sig/sentdm/models/webhook_response.rbs +110 -0
  199. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
  200. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
  201. data/sig/sentdm/models/webhook_test_response.rbs +9 -71
  202. data/sig/sentdm/models.rbs +52 -0
  203. data/sig/sentdm/resources/contacts.rbs +4 -4
  204. data/sig/sentdm/resources/conversations.rbs +2 -2
  205. data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
  206. data/sig/sentdm/resources/profiles.rbs +9 -9
  207. data/sig/sentdm/resources/templates.rbs +3 -3
  208. data/sig/sentdm/resources/users.rbs +3 -3
  209. data/sig/sentdm/resources/webhooks.rbs +4 -4
  210. metadata +98 -68
  211. data/lib/sentdm/models/contact_create_response.rb +0 -249
  212. data/lib/sentdm/models/contact_retrieve_message_summary_response.rb +0 -186
  213. data/lib/sentdm/models/contact_retrieve_response.rb +0 -249
  214. data/lib/sentdm/models/contact_update_response.rb +0 -249
  215. data/lib/sentdm/models/conversation_list_messages_response.rb +0 -436
  216. data/lib/sentdm/models/conversation_list_response.rb +0 -433
  217. data/lib/sentdm/models/profile_create_response.rb +0 -760
  218. data/lib/sentdm/models/profile_retrieve_response.rb +0 -762
  219. data/lib/sentdm/models/profile_update_response.rb +0 -760
  220. data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -420
  221. data/lib/sentdm/models/profiles/campaign_list_response.rb +0 -421
  222. data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -420
  223. data/lib/sentdm/models/template_create_response.rb +0 -209
  224. data/lib/sentdm/models/template_retrieve_response.rb +0 -209
  225. data/lib/sentdm/models/template_update_response.rb +0 -209
  226. data/lib/sentdm/models/user_invite_response.rb +0 -201
  227. data/lib/sentdm/models/user_retrieve_response.rb +0 -201
  228. data/lib/sentdm/models/user_update_role_response.rb +0 -201
  229. data/lib/sentdm/models/webhook_create_response.rb +0 -229
  230. data/lib/sentdm/models/webhook_retrieve_response.rb +0 -229
  231. data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -229
  232. data/lib/sentdm/models/webhook_update_response.rb +0 -229
  233. data/rbi/sentdm/models/contact_create_response.rbi +0 -407
  234. data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +0 -397
  235. data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -409
  236. data/rbi/sentdm/models/contact_update_response.rbi +0 -407
  237. data/rbi/sentdm/models/conversation_list_messages_response.rbi +0 -843
  238. data/rbi/sentdm/models/conversation_list_response.rbi +0 -819
  239. data/rbi/sentdm/models/profile_create_response.rbi +0 -1226
  240. data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1230
  241. data/rbi/sentdm/models/profile_update_response.rbi +0 -1226
  242. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -674
  243. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +0 -667
  244. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -674
  245. data/rbi/sentdm/models/template_create_response.rbi +0 -349
  246. data/rbi/sentdm/models/template_retrieve_response.rbi +0 -355
  247. data/rbi/sentdm/models/template_update_response.rbi +0 -349
  248. data/rbi/sentdm/models/user_invite_response.rbi +0 -336
  249. data/rbi/sentdm/models/user_retrieve_response.rbi +0 -336
  250. data/rbi/sentdm/models/user_update_role_response.rbi +0 -341
  251. data/rbi/sentdm/models/webhook_create_response.rbi +0 -361
  252. data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -363
  253. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -379
  254. data/rbi/sentdm/models/webhook_update_response.rbi +0 -361
  255. data/sig/sentdm/models/contact_create_response.rbs +0 -216
  256. data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +0 -182
  257. data/sig/sentdm/models/contact_retrieve_response.rbs +0 -216
  258. data/sig/sentdm/models/contact_update_response.rbs +0 -216
  259. data/sig/sentdm/models/conversation_list_messages_response.rbs +0 -404
  260. data/sig/sentdm/models/conversation_list_response.rbs +0 -404
  261. data/sig/sentdm/models/profile_create_response.rbs +0 -559
  262. data/sig/sentdm/models/profile_retrieve_response.rbs +0 -559
  263. data/sig/sentdm/models/profile_update_response.rbs +0 -559
  264. data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -357
  265. data/sig/sentdm/models/profiles/campaign_list_response.rbs +0 -357
  266. data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -357
  267. data/sig/sentdm/models/template_create_response.rbs +0 -182
  268. data/sig/sentdm/models/template_retrieve_response.rbs +0 -182
  269. data/sig/sentdm/models/template_update_response.rbs +0 -182
  270. data/sig/sentdm/models/user_invite_response.rbs +0 -177
  271. data/sig/sentdm/models/user_retrieve_response.rbs +0 -177
  272. data/sig/sentdm/models/user_update_role_response.rbs +0 -177
  273. data/sig/sentdm/models/webhook_create_response.rbs +0 -208
  274. data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -208
  275. data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -208
  276. data/sig/sentdm/models/webhook_update_response.rbs +0 -208
@@ -1,186 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Contacts#retrieve_message_summary
6
- class ContactRetrieveMessageSummaryResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # The response data (null if error)
9
- #
10
- # @return [Sentdm::Models::ContactRetrieveMessageSummaryResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::ContactRetrieveMessageSummaryResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::ContactRetrieveMessageSummaryResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::ContactRetrieveMessageSummaryResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::ContactRetrieveMessageSummaryResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::ContactRetrieveMessageSummaryResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Standard API response envelope for all v3 endpoints
33
- #
34
- # @param data [Sentdm::Models::ContactRetrieveMessageSummaryResponse::Data, nil] The response data (null if error)
35
- #
36
- # @param error [Sentdm::Models::ContactRetrieveMessageSummaryResponse::Error, nil] Error information
37
- #
38
- # @param meta [Sentdm::Models::ContactRetrieveMessageSummaryResponse::Meta] Request and response metadata
39
- #
40
- # @param success [Boolean] Indicates whether the request was successful
41
-
42
- # @see Sentdm::Models::ContactRetrieveMessageSummaryResponse#data
43
- class Data < Sentdm::Internal::Type::BaseModel
44
- # @!attribute channel_scores
45
- #
46
- # @return [Array<Sentdm::Models::ContactRetrieveMessageSummaryResponse::Data::ChannelScore>, nil]
47
- optional :channel_scores,
48
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::ContactRetrieveMessageSummaryResponse::Data::ChannelScore] }
49
-
50
- # @!attribute channels_used
51
- #
52
- # @return [Array<String>, nil]
53
- optional :channels_used, Sentdm::Internal::Type::ArrayOf[String]
54
-
55
- # @!attribute contact_id
56
- #
57
- # @return [String, nil]
58
- optional :contact_id, String
59
-
60
- # @!attribute first_message_at
61
- #
62
- # @return [Time, nil]
63
- optional :first_message_at, Time, nil?: true
64
-
65
- # @!attribute last_message_at
66
- #
67
- # @return [Time, nil]
68
- optional :last_message_at, Time, nil?: true
69
-
70
- # @!attribute message_count
71
- #
72
- # @return [Integer, nil]
73
- optional :message_count, Integer
74
-
75
- # @!method initialize(channel_scores: nil, channels_used: nil, contact_id: nil, first_message_at: nil, last_message_at: nil, message_count: nil)
76
- # The response data (null if error)
77
- #
78
- # @param channel_scores [Array<Sentdm::Models::ContactRetrieveMessageSummaryResponse::Data::ChannelScore>]
79
- # @param channels_used [Array<String>]
80
- # @param contact_id [String]
81
- # @param first_message_at [Time, nil]
82
- # @param last_message_at [Time, nil]
83
- # @param message_count [Integer]
84
-
85
- class ChannelScore < Sentdm::Internal::Type::BaseModel
86
- # @!attribute channel
87
- #
88
- # @return [String, nil]
89
- optional :channel, String
90
-
91
- # @!attribute fail_score
92
- # Percentage (0-100) of messages on this channel that ended in FAILED.
93
- #
94
- # @return [Integer, nil]
95
- optional :fail_score, Integer
96
-
97
- # @!attribute success_score
98
- # Percentage (0-100) of messages on this channel that reached a successful
99
- # terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
100
- #
101
- # @return [Integer, nil]
102
- optional :success_score, Integer
103
-
104
- # @!method initialize(channel: nil, fail_score: nil, success_score: nil)
105
- # Some parameter documentations has been truncated, see
106
- # {Sentdm::Models::ContactRetrieveMessageSummaryResponse::Data::ChannelScore} for
107
- # more details.
108
- #
109
- # @param channel [String]
110
- #
111
- # @param fail_score [Integer] Percentage (0-100) of messages on this channel that ended in FAILED.
112
- #
113
- # @param success_score [Integer] Percentage (0-100) of messages on this channel that reached a successful termina
114
- end
115
- end
116
-
117
- # @see Sentdm::Models::ContactRetrieveMessageSummaryResponse#error
118
- class Error < Sentdm::Internal::Type::BaseModel
119
- # @!attribute code
120
- # Machine-readable error code (e.g., "RESOURCE_001")
121
- #
122
- # @return [String, nil]
123
- optional :code, String
124
-
125
- # @!attribute details
126
- # Additional validation error details (field-level errors)
127
- #
128
- # @return [Hash{Symbol=>Array<String>}, nil]
129
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
130
-
131
- # @!attribute doc_url
132
- # URL to documentation about this error
133
- #
134
- # @return [String, nil]
135
- optional :doc_url, String, nil?: true
136
-
137
- # @!attribute message
138
- # Human-readable error message
139
- #
140
- # @return [String, nil]
141
- optional :message, String
142
-
143
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
144
- # Error information
145
- #
146
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
147
- #
148
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
149
- #
150
- # @param doc_url [String, nil] URL to documentation about this error
151
- #
152
- # @param message [String] Human-readable error message
153
- end
154
-
155
- # @see Sentdm::Models::ContactRetrieveMessageSummaryResponse#meta
156
- class Meta < Sentdm::Internal::Type::BaseModel
157
- # @!attribute request_id
158
- # Unique identifier for this request (for tracing and support)
159
- #
160
- # @return [String, nil]
161
- optional :request_id, String
162
-
163
- # @!attribute timestamp
164
- # Server timestamp when the response was generated
165
- #
166
- # @return [Time, nil]
167
- optional :timestamp, Time
168
-
169
- # @!attribute version
170
- # API version used for this request
171
- #
172
- # @return [String, nil]
173
- optional :version, String
174
-
175
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
176
- # Request and response metadata
177
- #
178
- # @param request_id [String] Unique identifier for this request (for tracing and support)
179
- #
180
- # @param timestamp [Time] Server timestamp when the response was generated
181
- #
182
- # @param version [String] API version used for this request
183
- end
184
- end
185
- end
186
- end
@@ -1,249 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Contacts#retrieve
6
- class ContactRetrieveResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # Contact response for v3 API Uses snake_case for JSON property names
9
- #
10
- # @return [Sentdm::Models::ContactRetrieveResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::ContactRetrieveResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::ContactRetrieveResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::ContactRetrieveResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::ContactRetrieveResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::ContactRetrieveResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Some parameter documentations has been truncated, see
33
- # {Sentdm::Models::ContactRetrieveResponse} for more details.
34
- #
35
- # Standard API response envelope for all v3 endpoints
36
- #
37
- # @param data [Sentdm::Models::ContactRetrieveResponse::Data, nil] Contact response for v3 API
38
- #
39
- # @param error [Sentdm::Models::ContactRetrieveResponse::Error, nil] Error information
40
- #
41
- # @param meta [Sentdm::Models::ContactRetrieveResponse::Meta] Request and response metadata
42
- #
43
- # @param success [Boolean] Indicates whether the request was successful
44
-
45
- # @see Sentdm::Models::ContactRetrieveResponse#data
46
- class Data < Sentdm::Internal::Type::BaseModel
47
- # @!attribute id
48
- # Unique identifier for the contact
49
- #
50
- # @return [String, nil]
51
- optional :id, String
52
-
53
- # @!attribute available_channels
54
- # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
55
- #
56
- # @return [String, nil]
57
- optional :available_channels, String
58
-
59
- # @!attribute country_code
60
- # Country calling code (e.g., 1 for US/Canada)
61
- #
62
- # @return [String, nil]
63
- optional :country_code, String
64
-
65
- # @!attribute created_at
66
- # When the contact was created
67
- #
68
- # @return [Time, nil]
69
- optional :created_at, Time
70
-
71
- # @!attribute customer_id
72
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
73
- # Says whose resource this is, which the resource's own id does not.
74
- #
75
- # @return [String, nil]
76
- optional :customer_id, String
77
-
78
- # @!attribute default_channel
79
- # Default messaging channel to use (e.g., "sms" or "whatsapp")
80
- #
81
- # @return [String, nil]
82
- optional :default_channel, String
83
-
84
- # @!attribute format_e164
85
- # Phone number in E.164 format (e.g., +1234567890)
86
- #
87
- # @return [String, nil]
88
- optional :format_e164, String
89
-
90
- # @!attribute format_international
91
- # Phone number in international format (e.g., +1 234-567-890)
92
- #
93
- # @return [String, nil]
94
- optional :format_international, String
95
-
96
- # @!attribute format_national
97
- # Phone number in national format (e.g., (234) 567-890)
98
- #
99
- # @return [String, nil]
100
- optional :format_national, String
101
-
102
- # @!attribute format_rfc
103
- # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
104
- #
105
- # @return [String, nil]
106
- optional :format_rfc, String
107
-
108
- # @!attribute is_inherited
109
- # @deprecated
110
- #
111
- # Always false. Contacts are no longer shared or inherited between sender profiles
112
- # — a profile sees only the contacts it owns. Retained so existing v3 clients
113
- # reading is_inherited keep deserializing; it carries no information.
114
- #
115
- # @return [Boolean, nil]
116
- optional :is_inherited, Sentdm::Internal::Type::Boolean
117
-
118
- # @!attribute opt_out
119
- # Whether the contact has opted out of messaging. Single source of truth — opt-out
120
- # is per-contact, not per-channel.
121
- #
122
- # @return [Boolean, nil]
123
- optional :opt_out, Sentdm::Internal::Type::Boolean
124
-
125
- # @!attribute phone_number
126
- # Phone number in original format
127
- #
128
- # @return [String, nil]
129
- optional :phone_number, String
130
-
131
- # @!attribute region_code
132
- # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
133
- #
134
- # @return [String, nil]
135
- optional :region_code, String
136
-
137
- # @!attribute updated_at
138
- # When the contact was last updated
139
- #
140
- # @return [Time, nil]
141
- optional :updated_at, Time, nil?: true
142
-
143
- # @!method initialize(id: nil, available_channels: nil, country_code: nil, created_at: nil, customer_id: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
144
- # Some parameter documentations has been truncated, see
145
- # {Sentdm::Models::ContactRetrieveResponse::Data} for more details.
146
- #
147
- # Contact response for v3 API Uses snake_case for JSON property names
148
- #
149
- # @param id [String] Unique identifier for the contact
150
- #
151
- # @param available_channels [String] Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
152
- #
153
- # @param country_code [String] Country calling code (e.g., 1 for US/Canada)
154
- #
155
- # @param created_at [Time] When the contact was created
156
- #
157
- # @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
158
- #
159
- # @param default_channel [String] Default messaging channel to use (e.g., "sms" or "whatsapp")
160
- #
161
- # @param format_e164 [String] Phone number in E.164 format (e.g., +1234567890)
162
- #
163
- # @param format_international [String] Phone number in international format (e.g., +1 234-567-890)
164
- #
165
- # @param format_national [String] Phone number in national format (e.g., (234) 567-890)
166
- #
167
- # @param format_rfc [String] Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
168
- #
169
- # @param is_inherited [Boolean] Always false. Contacts are no longer shared or inherited between sender profiles
170
- #
171
- # @param opt_out [Boolean] Whether the contact has opted out of messaging. Single source of truth — opt-out
172
- #
173
- # @param phone_number [String] Phone number in original format
174
- #
175
- # @param region_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
176
- #
177
- # @param updated_at [Time, nil] When the contact was last updated
178
- end
179
-
180
- # @see Sentdm::Models::ContactRetrieveResponse#error
181
- class Error < Sentdm::Internal::Type::BaseModel
182
- # @!attribute code
183
- # Machine-readable error code (e.g., "RESOURCE_001")
184
- #
185
- # @return [String, nil]
186
- optional :code, String
187
-
188
- # @!attribute details
189
- # Additional validation error details (field-level errors)
190
- #
191
- # @return [Hash{Symbol=>Array<String>}, nil]
192
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
193
-
194
- # @!attribute doc_url
195
- # URL to documentation about this error
196
- #
197
- # @return [String, nil]
198
- optional :doc_url, String, nil?: true
199
-
200
- # @!attribute message
201
- # Human-readable error message
202
- #
203
- # @return [String, nil]
204
- optional :message, String
205
-
206
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
207
- # Error information
208
- #
209
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
210
- #
211
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
212
- #
213
- # @param doc_url [String, nil] URL to documentation about this error
214
- #
215
- # @param message [String] Human-readable error message
216
- end
217
-
218
- # @see Sentdm::Models::ContactRetrieveResponse#meta
219
- class Meta < Sentdm::Internal::Type::BaseModel
220
- # @!attribute request_id
221
- # Unique identifier for this request (for tracing and support)
222
- #
223
- # @return [String, nil]
224
- optional :request_id, String
225
-
226
- # @!attribute timestamp
227
- # Server timestamp when the response was generated
228
- #
229
- # @return [Time, nil]
230
- optional :timestamp, Time
231
-
232
- # @!attribute version
233
- # API version used for this request
234
- #
235
- # @return [String, nil]
236
- optional :version, String
237
-
238
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
239
- # Request and response metadata
240
- #
241
- # @param request_id [String] Unique identifier for this request (for tracing and support)
242
- #
243
- # @param timestamp [Time] Server timestamp when the response was generated
244
- #
245
- # @param version [String] API version used for this request
246
- end
247
- end
248
- end
249
- end
@@ -1,249 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- # @see Sentdm::Resources::Contacts#update
6
- class ContactUpdateResponse < Sentdm::Internal::Type::BaseModel
7
- # @!attribute data
8
- # Contact response for v3 API Uses snake_case for JSON property names
9
- #
10
- # @return [Sentdm::Models::ContactUpdateResponse::Data, nil]
11
- optional :data, -> { Sentdm::Models::ContactUpdateResponse::Data }, nil?: true
12
-
13
- # @!attribute error
14
- # Error information
15
- #
16
- # @return [Sentdm::Models::ContactUpdateResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::ContactUpdateResponse::Error }, nil?: true
18
-
19
- # @!attribute meta
20
- # Request and response metadata
21
- #
22
- # @return [Sentdm::Models::ContactUpdateResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::ContactUpdateResponse::Meta }
24
-
25
- # @!attribute success
26
- # Indicates whether the request was successful
27
- #
28
- # @return [Boolean, nil]
29
- optional :success, Sentdm::Internal::Type::Boolean
30
-
31
- # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
- # Some parameter documentations has been truncated, see
33
- # {Sentdm::Models::ContactUpdateResponse} for more details.
34
- #
35
- # Standard API response envelope for all v3 endpoints
36
- #
37
- # @param data [Sentdm::Models::ContactUpdateResponse::Data, nil] Contact response for v3 API
38
- #
39
- # @param error [Sentdm::Models::ContactUpdateResponse::Error, nil] Error information
40
- #
41
- # @param meta [Sentdm::Models::ContactUpdateResponse::Meta] Request and response metadata
42
- #
43
- # @param success [Boolean] Indicates whether the request was successful
44
-
45
- # @see Sentdm::Models::ContactUpdateResponse#data
46
- class Data < Sentdm::Internal::Type::BaseModel
47
- # @!attribute id
48
- # Unique identifier for the contact
49
- #
50
- # @return [String, nil]
51
- optional :id, String
52
-
53
- # @!attribute available_channels
54
- # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
55
- #
56
- # @return [String, nil]
57
- optional :available_channels, String
58
-
59
- # @!attribute country_code
60
- # Country calling code (e.g., 1 for US/Canada)
61
- #
62
- # @return [String, nil]
63
- optional :country_code, String
64
-
65
- # @!attribute created_at
66
- # When the contact was created
67
- #
68
- # @return [Time, nil]
69
- optional :created_at, Time
70
-
71
- # @!attribute customer_id
72
- # Which customer owns this — the key's own, or the profile named in x-profile-id.
73
- # Says whose resource this is, which the resource's own id does not.
74
- #
75
- # @return [String, nil]
76
- optional :customer_id, String
77
-
78
- # @!attribute default_channel
79
- # Default messaging channel to use (e.g., "sms" or "whatsapp")
80
- #
81
- # @return [String, nil]
82
- optional :default_channel, String
83
-
84
- # @!attribute format_e164
85
- # Phone number in E.164 format (e.g., +1234567890)
86
- #
87
- # @return [String, nil]
88
- optional :format_e164, String
89
-
90
- # @!attribute format_international
91
- # Phone number in international format (e.g., +1 234-567-890)
92
- #
93
- # @return [String, nil]
94
- optional :format_international, String
95
-
96
- # @!attribute format_national
97
- # Phone number in national format (e.g., (234) 567-890)
98
- #
99
- # @return [String, nil]
100
- optional :format_national, String
101
-
102
- # @!attribute format_rfc
103
- # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
104
- #
105
- # @return [String, nil]
106
- optional :format_rfc, String
107
-
108
- # @!attribute is_inherited
109
- # @deprecated
110
- #
111
- # Always false. Contacts are no longer shared or inherited between sender profiles
112
- # — a profile sees only the contacts it owns. Retained so existing v3 clients
113
- # reading is_inherited keep deserializing; it carries no information.
114
- #
115
- # @return [Boolean, nil]
116
- optional :is_inherited, Sentdm::Internal::Type::Boolean
117
-
118
- # @!attribute opt_out
119
- # Whether the contact has opted out of messaging. Single source of truth — opt-out
120
- # is per-contact, not per-channel.
121
- #
122
- # @return [Boolean, nil]
123
- optional :opt_out, Sentdm::Internal::Type::Boolean
124
-
125
- # @!attribute phone_number
126
- # Phone number in original format
127
- #
128
- # @return [String, nil]
129
- optional :phone_number, String
130
-
131
- # @!attribute region_code
132
- # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
133
- #
134
- # @return [String, nil]
135
- optional :region_code, String
136
-
137
- # @!attribute updated_at
138
- # When the contact was last updated
139
- #
140
- # @return [Time, nil]
141
- optional :updated_at, Time, nil?: true
142
-
143
- # @!method initialize(id: nil, available_channels: nil, country_code: nil, created_at: nil, customer_id: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
144
- # Some parameter documentations has been truncated, see
145
- # {Sentdm::Models::ContactUpdateResponse::Data} for more details.
146
- #
147
- # Contact response for v3 API Uses snake_case for JSON property names
148
- #
149
- # @param id [String] Unique identifier for the contact
150
- #
151
- # @param available_channels [String] Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
152
- #
153
- # @param country_code [String] Country calling code (e.g., 1 for US/Canada)
154
- #
155
- # @param created_at [Time] When the contact was created
156
- #
157
- # @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
158
- #
159
- # @param default_channel [String] Default messaging channel to use (e.g., "sms" or "whatsapp")
160
- #
161
- # @param format_e164 [String] Phone number in E.164 format (e.g., +1234567890)
162
- #
163
- # @param format_international [String] Phone number in international format (e.g., +1 234-567-890)
164
- #
165
- # @param format_national [String] Phone number in national format (e.g., (234) 567-890)
166
- #
167
- # @param format_rfc [String] Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
168
- #
169
- # @param is_inherited [Boolean] Always false. Contacts are no longer shared or inherited between sender profiles
170
- #
171
- # @param opt_out [Boolean] Whether the contact has opted out of messaging. Single source of truth — opt-out
172
- #
173
- # @param phone_number [String] Phone number in original format
174
- #
175
- # @param region_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
176
- #
177
- # @param updated_at [Time, nil] When the contact was last updated
178
- end
179
-
180
- # @see Sentdm::Models::ContactUpdateResponse#error
181
- class Error < Sentdm::Internal::Type::BaseModel
182
- # @!attribute code
183
- # Machine-readable error code (e.g., "RESOURCE_001")
184
- #
185
- # @return [String, nil]
186
- optional :code, String
187
-
188
- # @!attribute details
189
- # Additional validation error details (field-level errors)
190
- #
191
- # @return [Hash{Symbol=>Array<String>}, nil]
192
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
193
-
194
- # @!attribute doc_url
195
- # URL to documentation about this error
196
- #
197
- # @return [String, nil]
198
- optional :doc_url, String, nil?: true
199
-
200
- # @!attribute message
201
- # Human-readable error message
202
- #
203
- # @return [String, nil]
204
- optional :message, String
205
-
206
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
207
- # Error information
208
- #
209
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
210
- #
211
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
212
- #
213
- # @param doc_url [String, nil] URL to documentation about this error
214
- #
215
- # @param message [String] Human-readable error message
216
- end
217
-
218
- # @see Sentdm::Models::ContactUpdateResponse#meta
219
- class Meta < Sentdm::Internal::Type::BaseModel
220
- # @!attribute request_id
221
- # Unique identifier for this request (for tracing and support)
222
- #
223
- # @return [String, nil]
224
- optional :request_id, String
225
-
226
- # @!attribute timestamp
227
- # Server timestamp when the response was generated
228
- #
229
- # @return [Time, nil]
230
- optional :timestamp, Time
231
-
232
- # @!attribute version
233
- # API version used for this request
234
- #
235
- # @return [String, nil]
236
- optional :version, String
237
-
238
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
239
- # Request and response metadata
240
- #
241
- # @param request_id [String] Unique identifier for this request (for tracing and support)
242
- #
243
- # @param timestamp [Time] Server timestamp when the response was generated
244
- #
245
- # @param version [String] API version used for this request
246
- end
247
- end
248
- end
249
- end