sentdm 0.29.0 → 0.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (265) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +11 -0
  3. data/README.md +27 -1
  4. data/lib/sentdm/internal/type/base_model.rb +5 -5
  5. data/lib/sentdm/models/api_meta.rb +34 -0
  6. data/lib/sentdm/models/api_response_of_contact.rb +46 -0
  7. data/lib/sentdm/models/api_response_of_contact_message_summary.rb +43 -0
  8. data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +43 -0
  9. data/lib/sentdm/models/api_response_of_profile_detail.rb +43 -0
  10. data/lib/sentdm/models/api_response_of_user.rb +43 -0
  11. data/lib/sentdm/models/api_response_template.rb +43 -0
  12. data/lib/sentdm/models/api_response_webhook.rb +43 -0
  13. data/lib/sentdm/models/billing_contact_info.rb +47 -0
  14. data/lib/sentdm/models/brand_business_info.rb +114 -0
  15. data/lib/sentdm/models/brand_compliance_info.rb +59 -0
  16. data/lib/sentdm/models/brand_contact_info.rb +58 -0
  17. data/lib/sentdm/models/brands_brand_data.rb +34 -0
  18. data/lib/sentdm/models/contact_delete_params.rb +2 -16
  19. data/lib/sentdm/models/contact_list_response.rb +12 -295
  20. data/lib/sentdm/models/contact_message_summary.rb +76 -0
  21. data/lib/sentdm/models/contact_response.rb +139 -0
  22. data/lib/sentdm/models/conversation_messages_list.rb +245 -0
  23. data/lib/sentdm/models/error_detail.rb +42 -0
  24. data/lib/sentdm/models/me_retrieve_response.rb +12 -242
  25. data/lib/sentdm/models/message_retrieve_activities_response.rb +9 -159
  26. data/lib/sentdm/models/message_retrieve_status_response.rb +6 -74
  27. data/lib/sentdm/models/message_send_response.rb +6 -74
  28. data/lib/sentdm/models/mutation_request.rb +20 -0
  29. data/lib/sentdm/models/number_lookup_response.rb +6 -74
  30. data/lib/sentdm/models/pagination_meta.rb +84 -0
  31. data/lib/sentdm/models/payment_details.rb +40 -0
  32. data/lib/sentdm/models/profile_complete_response.rb +6 -74
  33. data/lib/sentdm/models/profile_create_params.rb +9 -345
  34. data/lib/sentdm/models/profile_delete_params.rb +2 -16
  35. data/lib/sentdm/models/profile_detail.rb +650 -0
  36. data/lib/sentdm/models/profile_list_response.rb +12 -815
  37. data/lib/sentdm/models/profile_settings.rb +85 -0
  38. data/lib/sentdm/models/profile_update_params.rb +9 -345
  39. data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +45 -0
  40. data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +45 -0
  41. data/lib/sentdm/models/profiles/brand_campaign.rb +247 -0
  42. data/lib/sentdm/models/profiles/campaign_create_params.rb +3 -156
  43. data/lib/sentdm/models/profiles/campaign_data.rb +136 -0
  44. data/lib/sentdm/models/profiles/campaign_delete_params.rb +2 -17
  45. data/lib/sentdm/models/profiles/campaign_update_params.rb +3 -156
  46. data/lib/sentdm/models/profiles/campaign_use_case.rb +71 -0
  47. data/lib/sentdm/models/profiles/campaign_use_case_data.rb +29 -0
  48. data/lib/sentdm/models/template.rb +102 -0
  49. data/lib/sentdm/models/template_list_response.rb +12 -258
  50. data/lib/sentdm/models/user_list_response.rb +12 -249
  51. data/lib/sentdm/models/user_remove_params.rb +2 -16
  52. data/lib/sentdm/models/user_response.rb +94 -0
  53. data/lib/sentdm/models/webhook_event_type.rb +45 -0
  54. data/lib/sentdm/models/webhook_list_event_types_response.rb +12 -203
  55. data/lib/sentdm/models/webhook_list_events_response.rb +9 -157
  56. data/lib/sentdm/models/webhook_list_response.rb +12 -276
  57. data/lib/sentdm/models/webhook_response.rb +120 -0
  58. data/lib/sentdm/models/webhook_rotate_secret_params.rb +2 -17
  59. data/lib/sentdm/models/webhook_rotate_secret_response.rb +6 -74
  60. data/lib/sentdm/models/webhook_test_response.rb +6 -74
  61. data/lib/sentdm/models.rb +52 -0
  62. data/lib/sentdm/resources/contacts.rb +8 -8
  63. data/lib/sentdm/resources/conversations.rb +4 -4
  64. data/lib/sentdm/resources/profiles/campaigns.rb +8 -8
  65. data/lib/sentdm/resources/profiles.rb +12 -12
  66. data/lib/sentdm/resources/templates.rb +6 -6
  67. data/lib/sentdm/resources/users.rb +6 -6
  68. data/lib/sentdm/resources/webhooks.rb +8 -8
  69. data/lib/sentdm/version.rb +1 -1
  70. data/lib/sentdm.rb +32 -22
  71. data/rbi/sentdm/models/api_meta.rbi +55 -0
  72. data/rbi/sentdm/models/api_response_of_contact.rbi +74 -0
  73. data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi +79 -0
  74. data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +79 -0
  75. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +74 -0
  76. data/rbi/sentdm/models/api_response_of_user.rbi +74 -0
  77. data/rbi/sentdm/models/api_response_template.rbi +74 -0
  78. data/rbi/sentdm/models/api_response_webhook.rbi +74 -0
  79. data/rbi/sentdm/models/billing_contact_info.rbi +65 -0
  80. data/rbi/sentdm/models/brand_business_info.rbi +162 -0
  81. data/rbi/sentdm/models/brand_compliance_info.rbi +76 -0
  82. data/rbi/sentdm/models/brand_contact_info.rbi +78 -0
  83. data/rbi/sentdm/models/brands_brand_data.rbi +65 -0
  84. data/rbi/sentdm/models/contact_delete_params.rbi +2 -19
  85. data/rbi/sentdm/models/contact_list_response.rbi +16 -522
  86. data/rbi/sentdm/models/contact_message_summary.rbi +144 -0
  87. data/rbi/sentdm/models/contact_response.rbi +200 -0
  88. data/rbi/sentdm/models/conversation_messages_list.rbi +419 -0
  89. data/rbi/sentdm/models/error_detail.rbi +66 -0
  90. data/rbi/sentdm/models/me_retrieve_response.rbi +16 -367
  91. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +12 -325
  92. data/rbi/sentdm/models/message_retrieve_status_response.rbi +8 -148
  93. data/rbi/sentdm/models/message_send_response.rbi +8 -135
  94. data/rbi/sentdm/models/mutation_request.rbi +32 -0
  95. data/rbi/sentdm/models/number_lookup_response.rbi +8 -135
  96. data/rbi/sentdm/models/pagination_meta.rbi +135 -0
  97. data/rbi/sentdm/models/payment_details.rbi +56 -0
  98. data/rbi/sentdm/models/profile_complete_response.rbi +8 -137
  99. data/rbi/sentdm/models/profile_create_params.rbi +12 -546
  100. data/rbi/sentdm/models/profile_delete_params.rbi +2 -19
  101. data/rbi/sentdm/models/profile_detail.rbi +918 -0
  102. data/rbi/sentdm/models/profile_list_response.rbi +16 -1347
  103. data/rbi/sentdm/models/profile_settings.rbi +102 -0
  104. data/rbi/sentdm/models/profile_update_params.rbi +12 -546
  105. data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +81 -0
  106. data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +76 -0
  107. data/rbi/sentdm/models/profiles/brand_campaign.rbi +299 -0
  108. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +4 -218
  109. data/rbi/sentdm/models/profiles/campaign_data.rbi +158 -0
  110. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -14
  111. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +4 -218
  112. data/rbi/sentdm/models/profiles/campaign_use_case.rbi +110 -0
  113. data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +51 -0
  114. data/rbi/sentdm/models/template.rbi +139 -0
  115. data/rbi/sentdm/models/template_list_response.rbi +16 -464
  116. data/rbi/sentdm/models/user_list_response.rbi +16 -444
  117. data/rbi/sentdm/models/user_remove_params.rbi +2 -19
  118. data/rbi/sentdm/models/user_response.rbi +131 -0
  119. data/rbi/sentdm/models/webhook_event_type.rbi +74 -0
  120. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +16 -414
  121. data/rbi/sentdm/models/webhook_list_events_response.rbi +12 -314
  122. data/rbi/sentdm/models/webhook_list_response.rbi +16 -475
  123. data/rbi/sentdm/models/webhook_response.rbi +153 -0
  124. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -14
  125. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +8 -148
  126. data/rbi/sentdm/models/webhook_test_response.rbi +8 -135
  127. data/rbi/sentdm/models.rbi +54 -0
  128. data/rbi/sentdm/resources/contacts.rbi +4 -4
  129. data/rbi/sentdm/resources/conversations.rbi +2 -2
  130. data/rbi/sentdm/resources/profiles/campaigns.rbi +5 -5
  131. data/rbi/sentdm/resources/profiles.rbi +9 -13
  132. data/rbi/sentdm/resources/templates.rbi +3 -3
  133. data/rbi/sentdm/resources/users.rbi +3 -3
  134. data/rbi/sentdm/resources/webhooks.rbi +4 -4
  135. data/sig/sentdm/models/api_meta.rbs +27 -0
  136. data/sig/sentdm/models/api_response_of_contact.rbs +39 -0
  137. data/sig/sentdm/models/api_response_of_contact_message_summary.rbs +39 -0
  138. data/sig/sentdm/models/api_response_of_conversation_messages_list.rbs +39 -0
  139. data/sig/sentdm/models/api_response_of_profile_detail.rbs +39 -0
  140. data/sig/sentdm/models/api_response_of_user.rbs +39 -0
  141. data/sig/sentdm/models/api_response_template.rbs +39 -0
  142. data/sig/sentdm/models/api_response_webhook.rbs +39 -0
  143. data/sig/sentdm/models/billing_contact_info.rbs +30 -0
  144. data/sig/sentdm/models/brand_business_info.rbs +89 -0
  145. data/sig/sentdm/models/brand_compliance_info.rbs +45 -0
  146. data/sig/sentdm/models/brand_contact_info.rbs +45 -0
  147. data/sig/sentdm/models/brands_brand_data.rbs +30 -0
  148. data/sig/sentdm/models/contact_delete_params.rbs +6 -10
  149. data/sig/sentdm/models/contact_list_response.rbs +20 -263
  150. data/sig/sentdm/models/contact_message_summary.rbs +84 -0
  151. data/sig/sentdm/models/contact_response.rbs +118 -0
  152. data/sig/sentdm/models/conversation_messages_list.rbs +240 -0
  153. data/sig/sentdm/models/error_detail.rbs +39 -0
  154. data/sig/sentdm/models/me_retrieve_response.rbs +18 -176
  155. data/sig/sentdm/models/message_retrieve_activities_response.rbs +14 -142
  156. data/sig/sentdm/models/message_retrieve_status_response.rbs +9 -71
  157. data/sig/sentdm/models/message_send_response.rbs +9 -71
  158. data/sig/sentdm/models/mutation_request.rbs +15 -0
  159. data/sig/sentdm/models/number_lookup_response.rbs +9 -71
  160. data/sig/sentdm/models/pagination_meta.rbs +67 -0
  161. data/sig/sentdm/models/payment_details.rbs +30 -0
  162. data/sig/sentdm/models/profile_complete_response.rbs +9 -71
  163. data/sig/sentdm/models/profile_create_params.rbs +12 -263
  164. data/sig/sentdm/models/profile_delete_params.rbs +6 -10
  165. data/sig/sentdm/models/profile_detail.rbs +461 -0
  166. data/sig/sentdm/models/profile_list_response.rbs +20 -606
  167. data/sig/sentdm/models/profile_settings.rbs +50 -0
  168. data/sig/sentdm/models/profile_update_params.rbs +12 -263
  169. data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +41 -0
  170. data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +41 -0
  171. data/sig/sentdm/models/profiles/brand_campaign.rbs +194 -0
  172. data/sig/sentdm/models/profiles/campaign_create_params.rbs +4 -108
  173. data/sig/sentdm/models/profiles/campaign_data.rbs +87 -0
  174. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +8 -15
  175. data/sig/sentdm/models/profiles/campaign_update_params.rbs +4 -108
  176. data/sig/sentdm/models/profiles/campaign_use_case.rbs +66 -0
  177. data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +27 -0
  178. data/sig/sentdm/models/template.rbs +84 -0
  179. data/sig/sentdm/models/template_list_response.rbs +19 -230
  180. data/sig/sentdm/models/user_list_response.rbs +20 -224
  181. data/sig/sentdm/models/user_remove_params.rbs +6 -10
  182. data/sig/sentdm/models/user_response.rbs +79 -0
  183. data/sig/sentdm/models/webhook_event_type.rbs +51 -0
  184. data/sig/sentdm/models/webhook_list_event_types_response.rbs +20 -196
  185. data/sig/sentdm/models/webhook_list_events_response.rbs +14 -142
  186. data/sig/sentdm/models/webhook_list_response.rbs +20 -255
  187. data/sig/sentdm/models/webhook_response.rbs +110 -0
  188. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -17
  189. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +9 -71
  190. data/sig/sentdm/models/webhook_test_response.rbs +9 -71
  191. data/sig/sentdm/models.rbs +52 -0
  192. data/sig/sentdm/resources/contacts.rbs +4 -4
  193. data/sig/sentdm/resources/conversations.rbs +2 -2
  194. data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
  195. data/sig/sentdm/resources/profiles.rbs +9 -9
  196. data/sig/sentdm/resources/templates.rbs +3 -3
  197. data/sig/sentdm/resources/users.rbs +3 -3
  198. data/sig/sentdm/resources/webhooks.rbs +4 -4
  199. metadata +98 -68
  200. data/lib/sentdm/models/contact_create_response.rb +0 -249
  201. data/lib/sentdm/models/contact_retrieve_message_summary_response.rb +0 -186
  202. data/lib/sentdm/models/contact_retrieve_response.rb +0 -249
  203. data/lib/sentdm/models/contact_update_response.rb +0 -249
  204. data/lib/sentdm/models/conversation_list_messages_response.rb +0 -436
  205. data/lib/sentdm/models/conversation_list_response.rb +0 -433
  206. data/lib/sentdm/models/profile_create_response.rb +0 -760
  207. data/lib/sentdm/models/profile_retrieve_response.rb +0 -762
  208. data/lib/sentdm/models/profile_update_response.rb +0 -760
  209. data/lib/sentdm/models/profiles/campaign_create_response.rb +0 -420
  210. data/lib/sentdm/models/profiles/campaign_list_response.rb +0 -421
  211. data/lib/sentdm/models/profiles/campaign_update_response.rb +0 -420
  212. data/lib/sentdm/models/template_create_response.rb +0 -209
  213. data/lib/sentdm/models/template_retrieve_response.rb +0 -209
  214. data/lib/sentdm/models/template_update_response.rb +0 -209
  215. data/lib/sentdm/models/user_invite_response.rb +0 -201
  216. data/lib/sentdm/models/user_retrieve_response.rb +0 -201
  217. data/lib/sentdm/models/user_update_role_response.rb +0 -201
  218. data/lib/sentdm/models/webhook_create_response.rb +0 -229
  219. data/lib/sentdm/models/webhook_retrieve_response.rb +0 -229
  220. data/lib/sentdm/models/webhook_toggle_status_response.rb +0 -229
  221. data/lib/sentdm/models/webhook_update_response.rb +0 -229
  222. data/rbi/sentdm/models/contact_create_response.rbi +0 -407
  223. data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +0 -397
  224. data/rbi/sentdm/models/contact_retrieve_response.rbi +0 -409
  225. data/rbi/sentdm/models/contact_update_response.rbi +0 -407
  226. data/rbi/sentdm/models/conversation_list_messages_response.rbi +0 -843
  227. data/rbi/sentdm/models/conversation_list_response.rbi +0 -819
  228. data/rbi/sentdm/models/profile_create_response.rbi +0 -1226
  229. data/rbi/sentdm/models/profile_retrieve_response.rbi +0 -1230
  230. data/rbi/sentdm/models/profile_update_response.rbi +0 -1226
  231. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +0 -674
  232. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +0 -667
  233. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +0 -674
  234. data/rbi/sentdm/models/template_create_response.rbi +0 -349
  235. data/rbi/sentdm/models/template_retrieve_response.rbi +0 -355
  236. data/rbi/sentdm/models/template_update_response.rbi +0 -349
  237. data/rbi/sentdm/models/user_invite_response.rbi +0 -336
  238. data/rbi/sentdm/models/user_retrieve_response.rbi +0 -336
  239. data/rbi/sentdm/models/user_update_role_response.rbi +0 -341
  240. data/rbi/sentdm/models/webhook_create_response.rbi +0 -361
  241. data/rbi/sentdm/models/webhook_retrieve_response.rbi +0 -363
  242. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +0 -379
  243. data/rbi/sentdm/models/webhook_update_response.rbi +0 -361
  244. data/sig/sentdm/models/contact_create_response.rbs +0 -216
  245. data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +0 -182
  246. data/sig/sentdm/models/contact_retrieve_response.rbs +0 -216
  247. data/sig/sentdm/models/contact_update_response.rbs +0 -216
  248. data/sig/sentdm/models/conversation_list_messages_response.rbs +0 -404
  249. data/sig/sentdm/models/conversation_list_response.rbs +0 -404
  250. data/sig/sentdm/models/profile_create_response.rbs +0 -559
  251. data/sig/sentdm/models/profile_retrieve_response.rbs +0 -559
  252. data/sig/sentdm/models/profile_update_response.rbs +0 -559
  253. data/sig/sentdm/models/profiles/campaign_create_response.rbs +0 -357
  254. data/sig/sentdm/models/profiles/campaign_list_response.rbs +0 -357
  255. data/sig/sentdm/models/profiles/campaign_update_response.rbs +0 -357
  256. data/sig/sentdm/models/template_create_response.rbs +0 -182
  257. data/sig/sentdm/models/template_retrieve_response.rbs +0 -182
  258. data/sig/sentdm/models/template_update_response.rbs +0 -182
  259. data/sig/sentdm/models/user_invite_response.rbs +0 -177
  260. data/sig/sentdm/models/user_retrieve_response.rbs +0 -177
  261. data/sig/sentdm/models/user_update_role_response.rbs +0 -177
  262. data/sig/sentdm/models/webhook_create_response.rbs +0 -208
  263. data/sig/sentdm/models/webhook_retrieve_response.rbs +0 -208
  264. data/sig/sentdm/models/webhook_toggle_status_response.rbs +0 -208
  265. data/sig/sentdm/models/webhook_update_response.rbs +0 -208
@@ -13,14 +13,14 @@ module Sentdm
13
13
  # @!attribute error
14
14
  # Error information
15
15
  #
16
- # @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::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::MessageRetrieveActivitiesResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::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::MessageRetrieveActivitiesResponse::Data, nil] Response for GET /messages/{id}/activities
35
35
  #
36
- # @param error [Sentdm::Models::MessageRetrieveActivitiesResponse::Error, nil] Error information
36
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::MessageRetrieveActivitiesResponse::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
 
@@ -57,8 +57,8 @@ module Sentdm
57
57
  # @!attribute pagination
58
58
  # Pagination metadata for list responses
59
59
  #
60
- # @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination, nil]
61
- optional :pagination, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination }
60
+ # @return [Sentdm::Models::PaginationMeta, nil]
61
+ optional :pagination, -> { Sentdm::PaginationMeta }
62
62
 
63
63
  # @!method initialize(activities: nil, message_id: nil, pagination: nil)
64
64
  # Response for GET /messages/{id}/activities
@@ -67,7 +67,7 @@ module Sentdm
67
67
  #
68
68
  # @param message_id [String] The message ID these activities belong to
69
69
  #
70
- # @param pagination [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination] Pagination metadata for list responses
70
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
71
71
 
72
72
  class Activity < Sentdm::Internal::Type::BaseModel
73
73
  # @!attribute active_contact_price
@@ -130,156 +130,6 @@ module Sentdm
130
130
  #
131
131
  # @param timestamp [Time] When this activity occurred
132
132
  end
133
-
134
- # @see Sentdm::Models::MessageRetrieveActivitiesResponse::Data#pagination
135
- class Pagination < Sentdm::Internal::Type::BaseModel
136
- # @!attribute cursors
137
- # @deprecated
138
- #
139
- # Cursor-based pagination. Never populated — see Cursors.
140
- #
141
- # @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors, nil]
142
- optional :cursors,
143
- -> { Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors },
144
- nil?: true
145
-
146
- # @!attribute has_more
147
- # Whether there are more pages after this one
148
- #
149
- # @return [Boolean, nil]
150
- optional :has_more, Sentdm::Internal::Type::Boolean
151
-
152
- # @!attribute page
153
- # Current page number (1-indexed)
154
- #
155
- # @return [Integer, nil]
156
- optional :page, Integer
157
-
158
- # @!attribute page_size
159
- # Number of items per page
160
- #
161
- # @return [Integer, nil]
162
- optional :page_size, Integer
163
-
164
- # @!attribute total_count
165
- # Total number of items across all pages
166
- #
167
- # @return [Integer, nil]
168
- optional :total_count, Integer
169
-
170
- # @!attribute total_pages
171
- # Total number of pages
172
- #
173
- # @return [Integer, nil]
174
- optional :total_pages, Integer
175
-
176
- # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
177
- # Pagination metadata for list responses
178
- #
179
- # @param cursors [Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
180
- #
181
- # @param has_more [Boolean] Whether there are more pages after this one
182
- #
183
- # @param page [Integer] Current page number (1-indexed)
184
- #
185
- # @param page_size [Integer] Number of items per page
186
- #
187
- # @param total_count [Integer] Total number of items across all pages
188
- #
189
- # @param total_pages [Integer] Total number of pages
190
-
191
- # @deprecated
192
- #
193
- # @see Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination#cursors
194
- class Cursors < Sentdm::Internal::Type::BaseModel
195
- # @!attribute after
196
- # Cursor to fetch the next page.
197
- #
198
- # @return [String, nil]
199
- optional :after, String, nil?: true
200
-
201
- # @!attribute before
202
- # Cursor to fetch the previous page.
203
- #
204
- # @return [String, nil]
205
- optional :before, String, nil?: true
206
-
207
- # @!method initialize(after: nil, before: nil)
208
- # Cursor-based pagination. Never populated — see Cursors.
209
- #
210
- # @param after [String, nil] Cursor to fetch the next page.
211
- #
212
- # @param before [String, nil] Cursor to fetch the previous page.
213
- end
214
- end
215
- end
216
-
217
- # @see Sentdm::Models::MessageRetrieveActivitiesResponse#error
218
- class Error < Sentdm::Internal::Type::BaseModel
219
- # @!attribute code
220
- # Machine-readable error code (e.g., "RESOURCE_001")
221
- #
222
- # @return [String, nil]
223
- optional :code, String
224
-
225
- # @!attribute details
226
- # Additional validation error details (field-level errors)
227
- #
228
- # @return [Hash{Symbol=>Array<String>}, nil]
229
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
230
-
231
- # @!attribute doc_url
232
- # URL to documentation about this error
233
- #
234
- # @return [String, nil]
235
- optional :doc_url, String, nil?: true
236
-
237
- # @!attribute message
238
- # Human-readable error message
239
- #
240
- # @return [String, nil]
241
- optional :message, String
242
-
243
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
244
- # Error information
245
- #
246
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
247
- #
248
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
249
- #
250
- # @param doc_url [String, nil] URL to documentation about this error
251
- #
252
- # @param message [String] Human-readable error message
253
- end
254
-
255
- # @see Sentdm::Models::MessageRetrieveActivitiesResponse#meta
256
- class Meta < Sentdm::Internal::Type::BaseModel
257
- # @!attribute request_id
258
- # Unique identifier for this request (for tracing and support)
259
- #
260
- # @return [String, nil]
261
- optional :request_id, String
262
-
263
- # @!attribute timestamp
264
- # Server timestamp when the response was generated
265
- #
266
- # @return [Time, nil]
267
- optional :timestamp, Time
268
-
269
- # @!attribute version
270
- # API version used for this request
271
- #
272
- # @return [String, nil]
273
- optional :version, String
274
-
275
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
276
- # Request and response metadata
277
- #
278
- # @param request_id [String] Unique identifier for this request (for tracing and support)
279
- #
280
- # @param timestamp [Time] Server timestamp when the response was generated
281
- #
282
- # @param version [String] API version used for this request
283
133
  end
284
134
  end
285
135
  end
@@ -13,14 +13,14 @@ module Sentdm
13
13
  # @!attribute error
14
14
  # Error information
15
15
  #
16
- # @return [Sentdm::Models::MessageRetrieveStatusResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::MessageRetrieveStatusResponse::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::MessageRetrieveStatusResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::MessageRetrieveStatusResponse::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::MessageRetrieveStatusResponse::Data, nil] Message response for v3 API — same shape as v2 with snake_case JSON conventions
35
35
  #
36
- # @param error [Sentdm::Models::MessageRetrieveStatusResponse::Error, nil] Error information
36
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::MessageRetrieveStatusResponse::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
 
@@ -258,74 +258,6 @@ module Sentdm
258
258
  end
259
259
  end
260
260
  end
261
-
262
- # @see Sentdm::Models::MessageRetrieveStatusResponse#error
263
- class Error < Sentdm::Internal::Type::BaseModel
264
- # @!attribute code
265
- # Machine-readable error code (e.g., "RESOURCE_001")
266
- #
267
- # @return [String, nil]
268
- optional :code, String
269
-
270
- # @!attribute details
271
- # Additional validation error details (field-level errors)
272
- #
273
- # @return [Hash{Symbol=>Array<String>}, nil]
274
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
275
-
276
- # @!attribute doc_url
277
- # URL to documentation about this error
278
- #
279
- # @return [String, nil]
280
- optional :doc_url, String, nil?: true
281
-
282
- # @!attribute message
283
- # Human-readable error message
284
- #
285
- # @return [String, nil]
286
- optional :message, String
287
-
288
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
289
- # Error information
290
- #
291
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
292
- #
293
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
294
- #
295
- # @param doc_url [String, nil] URL to documentation about this error
296
- #
297
- # @param message [String] Human-readable error message
298
- end
299
-
300
- # @see Sentdm::Models::MessageRetrieveStatusResponse#meta
301
- class Meta < Sentdm::Internal::Type::BaseModel
302
- # @!attribute request_id
303
- # Unique identifier for this request (for tracing and support)
304
- #
305
- # @return [String, nil]
306
- optional :request_id, String
307
-
308
- # @!attribute timestamp
309
- # Server timestamp when the response was generated
310
- #
311
- # @return [Time, nil]
312
- optional :timestamp, Time
313
-
314
- # @!attribute version
315
- # API version used for this request
316
- #
317
- # @return [String, nil]
318
- optional :version, String
319
-
320
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
321
- # Request and response metadata
322
- #
323
- # @param request_id [String] Unique identifier for this request (for tracing and support)
324
- #
325
- # @param timestamp [Time] Server timestamp when the response was generated
326
- #
327
- # @param version [String] API version used for this request
328
- end
329
261
  end
330
262
  end
331
263
  end
@@ -22,14 +22,14 @@ module Sentdm
22
22
  # @!attribute error
23
23
  # Error information
24
24
  #
25
- # @return [Sentdm::Models::MessageSendResponse::Error, nil]
26
- optional :error, -> { Sentdm::Models::MessageSendResponse::Error }, nil?: true
25
+ # @return [Sentdm::Models::ErrorDetail, nil]
26
+ optional :error, -> { Sentdm::ErrorDetail }, nil?: true
27
27
 
28
28
  # @!attribute meta
29
29
  # Request and response metadata
30
30
  #
31
- # @return [Sentdm::Models::MessageSendResponse::Meta, nil]
32
- optional :meta, -> { Sentdm::Models::MessageSendResponse::Meta }
31
+ # @return [Sentdm::Models::APIMeta, nil]
32
+ optional :meta, -> { Sentdm::APIMeta }
33
33
 
34
34
  # @!attribute success
35
35
  # Indicates whether the request was successful
@@ -45,9 +45,9 @@ module Sentdm
45
45
  #
46
46
  # @param data [Sentdm::Models::MessageSendResponse::Data, nil] The result of a multi-recipient send.
47
47
  #
48
- # @param error [Sentdm::Models::MessageSendResponse::Error, nil] Error information
48
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
49
49
  #
50
- # @param meta [Sentdm::Models::MessageSendResponse::Meta] Request and response metadata
50
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
51
51
  #
52
52
  # @param success [Boolean] Indicates whether the request was successful
53
53
 
@@ -136,74 +136,6 @@ module Sentdm
136
136
  # @param to [String] Phone number in E.164 format.
137
137
  end
138
138
  end
139
-
140
- # @see Sentdm::Models::MessageSendResponse#error
141
- class Error < Sentdm::Internal::Type::BaseModel
142
- # @!attribute code
143
- # Machine-readable error code (e.g., "RESOURCE_001")
144
- #
145
- # @return [String, nil]
146
- optional :code, String
147
-
148
- # @!attribute details
149
- # Additional validation error details (field-level errors)
150
- #
151
- # @return [Hash{Symbol=>Array<String>}, nil]
152
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
153
-
154
- # @!attribute doc_url
155
- # URL to documentation about this error
156
- #
157
- # @return [String, nil]
158
- optional :doc_url, String, nil?: true
159
-
160
- # @!attribute message
161
- # Human-readable error message
162
- #
163
- # @return [String, nil]
164
- optional :message, String
165
-
166
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
167
- # Error information
168
- #
169
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
170
- #
171
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
172
- #
173
- # @param doc_url [String, nil] URL to documentation about this error
174
- #
175
- # @param message [String] Human-readable error message
176
- end
177
-
178
- # @see Sentdm::Models::MessageSendResponse#meta
179
- class Meta < Sentdm::Internal::Type::BaseModel
180
- # @!attribute request_id
181
- # Unique identifier for this request (for tracing and support)
182
- #
183
- # @return [String, nil]
184
- optional :request_id, String
185
-
186
- # @!attribute timestamp
187
- # Server timestamp when the response was generated
188
- #
189
- # @return [Time, nil]
190
- optional :timestamp, Time
191
-
192
- # @!attribute version
193
- # API version used for this request
194
- #
195
- # @return [String, nil]
196
- optional :version, String
197
-
198
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
199
- # Request and response metadata
200
- #
201
- # @param request_id [String] Unique identifier for this request (for tracing and support)
202
- #
203
- # @param timestamp [Time] Server timestamp when the response was generated
204
- #
205
- # @param version [String] API version used for this request
206
- end
207
139
  end
208
140
  end
209
141
  end
@@ -0,0 +1,20 @@
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
@@ -13,14 +13,14 @@ module Sentdm
13
13
  # @!attribute error
14
14
  # Error information
15
15
  #
16
- # @return [Sentdm::Models::NumberLookupResponse::Error, nil]
17
- optional :error, -> { Sentdm::Models::NumberLookupResponse::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::NumberLookupResponse::Meta, nil]
23
- optional :meta, -> { Sentdm::Models::NumberLookupResponse::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::NumberLookupResponse::Data, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::NumberLookupResponse::Error, nil] Error information
36
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::NumberLookupResponse::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
 
@@ -99,74 +99,6 @@ module Sentdm
99
99
  # @param mobile_network_code [String, nil]
100
100
  # @param phone_number [String]
101
101
  end
102
-
103
- # @see Sentdm::Models::NumberLookupResponse#error
104
- class Error < Sentdm::Internal::Type::BaseModel
105
- # @!attribute code
106
- # Machine-readable error code (e.g., "RESOURCE_001")
107
- #
108
- # @return [String, nil]
109
- optional :code, String
110
-
111
- # @!attribute details
112
- # Additional validation error details (field-level errors)
113
- #
114
- # @return [Hash{Symbol=>Array<String>}, nil]
115
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
116
-
117
- # @!attribute doc_url
118
- # URL to documentation about this error
119
- #
120
- # @return [String, nil]
121
- optional :doc_url, String, nil?: true
122
-
123
- # @!attribute message
124
- # Human-readable error message
125
- #
126
- # @return [String, nil]
127
- optional :message, String
128
-
129
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
130
- # Error information
131
- #
132
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
133
- #
134
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
135
- #
136
- # @param doc_url [String, nil] URL to documentation about this error
137
- #
138
- # @param message [String] Human-readable error message
139
- end
140
-
141
- # @see Sentdm::Models::NumberLookupResponse#meta
142
- class Meta < Sentdm::Internal::Type::BaseModel
143
- # @!attribute request_id
144
- # Unique identifier for this request (for tracing and support)
145
- #
146
- # @return [String, nil]
147
- optional :request_id, String
148
-
149
- # @!attribute timestamp
150
- # Server timestamp when the response was generated
151
- #
152
- # @return [Time, nil]
153
- optional :timestamp, Time
154
-
155
- # @!attribute version
156
- # API version used for this request
157
- #
158
- # @return [String, nil]
159
- optional :version, String
160
-
161
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
162
- # Request and response metadata
163
- #
164
- # @param request_id [String] Unique identifier for this request (for tracing and support)
165
- #
166
- # @param timestamp [Time] Server timestamp when the response was generated
167
- #
168
- # @param version [String] API version used for this request
169
- end
170
102
  end
171
103
  end
172
104
  end
@@ -0,0 +1,84 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Sentdm
4
+ module Models
5
+ class PaginationMeta < Sentdm::Internal::Type::BaseModel
6
+ # @!attribute cursors
7
+ # @deprecated
8
+ #
9
+ # Cursor-based pagination. Never populated — see Cursors.
10
+ #
11
+ # @return [Sentdm::Models::PaginationMeta::Cursors, nil]
12
+ optional :cursors, -> { Sentdm::PaginationMeta::Cursors }, nil?: true
13
+
14
+ # @!attribute has_more
15
+ # Whether there are more pages after this one
16
+ #
17
+ # @return [Boolean, nil]
18
+ optional :has_more, Sentdm::Internal::Type::Boolean
19
+
20
+ # @!attribute page
21
+ # Current page number (1-indexed)
22
+ #
23
+ # @return [Integer, nil]
24
+ optional :page, Integer
25
+
26
+ # @!attribute page_size
27
+ # Number of items per page
28
+ #
29
+ # @return [Integer, nil]
30
+ optional :page_size, Integer
31
+
32
+ # @!attribute total_count
33
+ # Total number of items across all pages
34
+ #
35
+ # @return [Integer, nil]
36
+ optional :total_count, Integer
37
+
38
+ # @!attribute total_pages
39
+ # Total number of pages
40
+ #
41
+ # @return [Integer, nil]
42
+ optional :total_pages, Integer
43
+
44
+ # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
45
+ # Pagination metadata for list responses
46
+ #
47
+ # @param cursors [Sentdm::Models::PaginationMeta::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
48
+ #
49
+ # @param has_more [Boolean] Whether there are more pages after this one
50
+ #
51
+ # @param page [Integer] Current page number (1-indexed)
52
+ #
53
+ # @param page_size [Integer] Number of items per page
54
+ #
55
+ # @param total_count [Integer] Total number of items across all pages
56
+ #
57
+ # @param total_pages [Integer] Total number of pages
58
+
59
+ # @deprecated
60
+ #
61
+ # @see Sentdm::Models::PaginationMeta#cursors
62
+ class Cursors < Sentdm::Internal::Type::BaseModel
63
+ # @!attribute after
64
+ # Cursor to fetch the next page.
65
+ #
66
+ # @return [String, nil]
67
+ optional :after, String, nil?: true
68
+
69
+ # @!attribute before
70
+ # Cursor to fetch the previous page.
71
+ #
72
+ # @return [String, nil]
73
+ optional :before, String, nil?: true
74
+
75
+ # @!method initialize(after: nil, before: nil)
76
+ # Cursor-based pagination. Never populated — see Cursors.
77
+ #
78
+ # @param after [String, nil] Cursor to fetch the next page.
79
+ #
80
+ # @param before [String, nil] Cursor to fetch the previous page.
81
+ end
82
+ end
83
+ end
84
+ end
@@ -0,0 +1,40 @@
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
+ # @param card_number [String] Card number (digits only, 13–19 characters)
32
+ #
33
+ # @param cvc [String] Card security code (3–4 digits)
34
+ #
35
+ # @param expiry [String] Card expiry date in MM/YY format (e.g. "09/27")
36
+ #
37
+ # @param zip_code [String] Billing ZIP / postal code associated with the card
38
+ end
39
+ end
40
+ end