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,74 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Sentdm::APIResponseTemplate, Sentdm::Internal::AnyHash)
9
- end
10
-
11
- # Template response for v3 API
12
- sig { returns(T.nilable(Sentdm::Template)) }
13
- attr_reader :data
14
-
15
- sig { params(data: T.nilable(Sentdm::Template::OrHash)).void }
16
- attr_writer :data
17
-
18
- # Error information
19
- sig { returns(T.nilable(Sentdm::ErrorDetail)) }
20
- attr_reader :error
21
-
22
- sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
23
- attr_writer :error
24
-
25
- # Request and response metadata
26
- sig { returns(T.nilable(Sentdm::APIMeta)) }
27
- attr_reader :meta
28
-
29
- sig { params(meta: Sentdm::APIMeta::OrHash).void }
30
- attr_writer :meta
31
-
32
- # Indicates whether the request was successful
33
- sig { returns(T.nilable(T::Boolean)) }
34
- attr_reader :success
35
-
36
- sig { params(success: T::Boolean).void }
37
- attr_writer :success
38
-
39
- # Standard API response envelope for all v3 endpoints
40
- sig do
41
- params(
42
- data: T.nilable(Sentdm::Template::OrHash),
43
- error: T.nilable(Sentdm::ErrorDetail::OrHash),
44
- meta: Sentdm::APIMeta::OrHash,
45
- success: T::Boolean
46
- ).returns(T.attached_class)
47
- end
48
- def self.new(
49
- # Template response for v3 API
50
- data: nil,
51
- # Error information
52
- error: nil,
53
- # Request and response metadata
54
- meta: nil,
55
- # Indicates whether the request was successful
56
- success: nil
57
- )
58
- end
59
-
60
- sig do
61
- override.returns(
62
- {
63
- data: T.nilable(Sentdm::Template),
64
- error: T.nilable(Sentdm::ErrorDetail),
65
- meta: Sentdm::APIMeta,
66
- success: T::Boolean
67
- }
68
- )
69
- end
70
- def to_hash
71
- end
72
- end
73
- end
74
- end
@@ -1,74 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Sentdm::APIResponseWebhook, Sentdm::Internal::AnyHash)
9
- end
10
-
11
- # The response data (null if error)
12
- sig { returns(T.nilable(Sentdm::WebhookResponse)) }
13
- attr_reader :data
14
-
15
- sig { params(data: T.nilable(Sentdm::WebhookResponse::OrHash)).void }
16
- attr_writer :data
17
-
18
- # Error information
19
- sig { returns(T.nilable(Sentdm::ErrorDetail)) }
20
- attr_reader :error
21
-
22
- sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
23
- attr_writer :error
24
-
25
- # Request and response metadata
26
- sig { returns(T.nilable(Sentdm::APIMeta)) }
27
- attr_reader :meta
28
-
29
- sig { params(meta: Sentdm::APIMeta::OrHash).void }
30
- attr_writer :meta
31
-
32
- # Indicates whether the request was successful
33
- sig { returns(T.nilable(T::Boolean)) }
34
- attr_reader :success
35
-
36
- sig { params(success: T::Boolean).void }
37
- attr_writer :success
38
-
39
- # Standard API response envelope for all v3 endpoints
40
- sig do
41
- params(
42
- data: T.nilable(Sentdm::WebhookResponse::OrHash),
43
- error: T.nilable(Sentdm::ErrorDetail::OrHash),
44
- meta: Sentdm::APIMeta::OrHash,
45
- success: T::Boolean
46
- ).returns(T.attached_class)
47
- end
48
- def self.new(
49
- # The response data (null if error)
50
- data: nil,
51
- # Error information
52
- error: nil,
53
- # Request and response metadata
54
- meta: nil,
55
- # Indicates whether the request was successful
56
- success: nil
57
- )
58
- end
59
-
60
- sig do
61
- override.returns(
62
- {
63
- data: T.nilable(Sentdm::WebhookResponse),
64
- error: T.nilable(Sentdm::ErrorDetail),
65
- meta: Sentdm::APIMeta,
66
- success: T::Boolean
67
- }
68
- )
69
- end
70
- def to_hash
71
- end
72
- end
73
- end
74
- end
@@ -1,65 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class BillingContactInfo < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Sentdm::BillingContactInfo, Sentdm::Internal::AnyHash)
9
- end
10
-
11
- # Email address where invoices will be sent (required)
12
- sig { returns(String) }
13
- attr_accessor :email
14
-
15
- # Full name of the billing contact or company (required)
16
- sig { returns(String) }
17
- attr_accessor :name
18
-
19
- # Billing address (optional). Free-form text including street, city, state, postal
20
- # code, and country.
21
- sig { returns(T.nilable(String)) }
22
- attr_accessor :address
23
-
24
- # Phone number for the billing contact (optional)
25
- sig { returns(T.nilable(String)) }
26
- attr_accessor :phone
27
-
28
- # Billing contact information for a profile. Required when billing_model is
29
- # "profile" or "profile_and_organization".
30
- sig do
31
- params(
32
- email: String,
33
- name: String,
34
- address: T.nilable(String),
35
- phone: T.nilable(String)
36
- ).returns(T.attached_class)
37
- end
38
- def self.new(
39
- # Email address where invoices will be sent (required)
40
- email:,
41
- # Full name of the billing contact or company (required)
42
- name:,
43
- # Billing address (optional). Free-form text including street, city, state, postal
44
- # code, and country.
45
- address: nil,
46
- # Phone number for the billing contact (optional)
47
- phone: nil
48
- )
49
- end
50
-
51
- sig do
52
- override.returns(
53
- {
54
- email: String,
55
- name: String,
56
- address: T.nilable(String),
57
- phone: T.nilable(String)
58
- }
59
- )
60
- end
61
- def to_hash
62
- end
63
- end
64
- end
65
- end
@@ -1,162 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class BrandBusinessInfo < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Sentdm::BrandBusinessInfo, Sentdm::Internal::AnyHash)
9
- end
10
-
11
- # City
12
- sig { returns(T.nilable(String)) }
13
- attr_accessor :city
14
-
15
- # Country code (e.g., US, CA)
16
- sig { returns(T.nilable(String)) }
17
- attr_accessor :country
18
-
19
- # Country where the business is registered
20
- sig { returns(T.nilable(String)) }
21
- attr_accessor :country_of_registration
22
-
23
- sig do
24
- returns(T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol))
25
- end
26
- attr_accessor :entity_type
27
-
28
- # Legal business name
29
- sig { returns(T.nilable(String)) }
30
- attr_accessor :legal_name
31
-
32
- # Postal/ZIP code
33
- sig { returns(T.nilable(String)) }
34
- attr_accessor :postal_code
35
-
36
- # State/province code
37
- sig { returns(T.nilable(String)) }
38
- attr_accessor :state
39
-
40
- # Street address
41
- sig { returns(T.nilable(String)) }
42
- attr_accessor :street
43
-
44
- # Tax ID/EIN number
45
- sig { returns(T.nilable(String)) }
46
- attr_accessor :tax_id
47
-
48
- # Type of tax ID (e.g., us_ein, ca_bn)
49
- sig { returns(T.nilable(String)) }
50
- attr_accessor :tax_id_type
51
-
52
- # Business website URL
53
- sig { returns(T.nilable(String)) }
54
- attr_accessor :url
55
-
56
- # Business details and address for brand KYC
57
- sig do
58
- params(
59
- city: T.nilable(String),
60
- country: T.nilable(String),
61
- country_of_registration: T.nilable(String),
62
- entity_type:
63
- T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol),
64
- legal_name: T.nilable(String),
65
- postal_code: T.nilable(String),
66
- state: T.nilable(String),
67
- street: T.nilable(String),
68
- tax_id: T.nilable(String),
69
- tax_id_type: T.nilable(String),
70
- url: T.nilable(String)
71
- ).returns(T.attached_class)
72
- end
73
- def self.new(
74
- # City
75
- city: nil,
76
- # Country code (e.g., US, CA)
77
- country: nil,
78
- # Country where the business is registered
79
- country_of_registration: nil,
80
- entity_type: nil,
81
- # Legal business name
82
- legal_name: nil,
83
- # Postal/ZIP code
84
- postal_code: nil,
85
- # State/province code
86
- state: nil,
87
- # Street address
88
- street: nil,
89
- # Tax ID/EIN number
90
- tax_id: nil,
91
- # Type of tax ID (e.g., us_ein, ca_bn)
92
- tax_id_type: nil,
93
- # Business website URL
94
- url: nil
95
- )
96
- end
97
-
98
- sig do
99
- override.returns(
100
- {
101
- city: T.nilable(String),
102
- country: T.nilable(String),
103
- country_of_registration: T.nilable(String),
104
- entity_type:
105
- T.nilable(Sentdm::BrandBusinessInfo::EntityType::OrSymbol),
106
- legal_name: T.nilable(String),
107
- postal_code: T.nilable(String),
108
- state: T.nilable(String),
109
- street: T.nilable(String),
110
- tax_id: T.nilable(String),
111
- tax_id_type: T.nilable(String),
112
- url: T.nilable(String)
113
- }
114
- )
115
- end
116
- def to_hash
117
- end
118
-
119
- module EntityType
120
- extend Sentdm::Internal::Type::Enum
121
-
122
- TaggedSymbol =
123
- T.type_alias { T.all(Symbol, Sentdm::BrandBusinessInfo::EntityType) }
124
- OrSymbol = T.type_alias { T.any(Symbol, String) }
125
-
126
- PRIVATE_PROFIT =
127
- T.let(
128
- :PRIVATE_PROFIT,
129
- Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
130
- )
131
- PUBLIC_PROFIT =
132
- T.let(
133
- :PUBLIC_PROFIT,
134
- Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
135
- )
136
- NON_PROFIT =
137
- T.let(
138
- :NON_PROFIT,
139
- Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
140
- )
141
- SOLE_PROPRIETOR =
142
- T.let(
143
- :SOLE_PROPRIETOR,
144
- Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
145
- )
146
- GOVERNMENT =
147
- T.let(
148
- :GOVERNMENT,
149
- Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol
150
- )
151
-
152
- sig do
153
- override.returns(
154
- T::Array[Sentdm::BrandBusinessInfo::EntityType::TaggedSymbol]
155
- )
156
- end
157
- def self.values
158
- end
159
- end
160
- end
161
- end
162
- end
@@ -1,84 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class BrandComplianceInfo < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Sentdm::BrandComplianceInfo, Sentdm::Internal::AnyHash)
9
- end
10
-
11
- sig { returns(Sentdm::TcrBrandRelationship::OrSymbol) }
12
- attr_accessor :brand_relationship
13
-
14
- sig { returns(Sentdm::TcrVertical::OrSymbol) }
15
- attr_accessor :vertical
16
-
17
- # List of destination countries for messaging
18
- sig { returns(T.nilable(T::Array[Sentdm::DestinationCountry])) }
19
- attr_accessor :destination_countries
20
-
21
- # Whether this is a TCR (Campaign Registry) application
22
- sig { returns(T.nilable(T::Boolean)) }
23
- attr_accessor :is_tcr_application
24
-
25
- # Additional notes about the business or use case
26
- sig { returns(T.nilable(String)) }
27
- attr_accessor :notes
28
-
29
- # Phone number prefix for messaging (e.g., "+1")
30
- sig { returns(T.nilable(String)) }
31
- attr_accessor :phone_number_prefix
32
-
33
- # Primary messaging use case description
34
- sig { returns(T.nilable(String)) }
35
- attr_accessor :primary_use_case
36
-
37
- # Compliance and TCR information for brand registration
38
- sig do
39
- params(
40
- brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
41
- vertical: Sentdm::TcrVertical::OrSymbol,
42
- destination_countries:
43
- T.nilable(T::Array[Sentdm::DestinationCountry::OrHash]),
44
- is_tcr_application: T.nilable(T::Boolean),
45
- notes: T.nilable(String),
46
- phone_number_prefix: T.nilable(String),
47
- primary_use_case: T.nilable(String)
48
- ).returns(T.attached_class)
49
- end
50
- def self.new(
51
- brand_relationship:,
52
- vertical:,
53
- # List of destination countries for messaging
54
- destination_countries: nil,
55
- # Whether this is a TCR (Campaign Registry) application
56
- is_tcr_application: nil,
57
- # Additional notes about the business or use case
58
- notes: nil,
59
- # Phone number prefix for messaging (e.g., "+1")
60
- phone_number_prefix: nil,
61
- # Primary messaging use case description
62
- primary_use_case: nil
63
- )
64
- end
65
-
66
- sig do
67
- override.returns(
68
- {
69
- brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
70
- vertical: Sentdm::TcrVertical::OrSymbol,
71
- destination_countries:
72
- T.nilable(T::Array[Sentdm::DestinationCountry]),
73
- is_tcr_application: T.nilable(T::Boolean),
74
- notes: T.nilable(String),
75
- phone_number_prefix: T.nilable(String),
76
- primary_use_case: T.nilable(String)
77
- }
78
- )
79
- end
80
- def to_hash
81
- end
82
- end
83
- end
84
- end
@@ -1,78 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class BrandContactInfo < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Sentdm::BrandContactInfo, Sentdm::Internal::AnyHash)
9
- end
10
-
11
- # Primary contact name (required)
12
- sig { returns(String) }
13
- attr_accessor :name
14
-
15
- # Business/brand name
16
- sig { returns(T.nilable(String)) }
17
- attr_accessor :business_name
18
-
19
- # Contact email address
20
- sig { returns(T.nilable(String)) }
21
- attr_accessor :email
22
-
23
- # Contact phone number in E.164 format
24
- sig { returns(T.nilable(String)) }
25
- attr_accessor :phone
26
-
27
- # Contact phone country code (e.g., "1" for US)
28
- sig { returns(T.nilable(String)) }
29
- attr_accessor :phone_country_code
30
-
31
- # Contact's role in the business
32
- sig { returns(T.nilable(String)) }
33
- attr_accessor :role
34
-
35
- # Contact information for brand KYC
36
- sig do
37
- params(
38
- name: String,
39
- business_name: T.nilable(String),
40
- email: T.nilable(String),
41
- phone: T.nilable(String),
42
- phone_country_code: T.nilable(String),
43
- role: T.nilable(String)
44
- ).returns(T.attached_class)
45
- end
46
- def self.new(
47
- # Primary contact name (required)
48
- name:,
49
- # Business/brand name
50
- business_name: nil,
51
- # Contact email address
52
- email: nil,
53
- # Contact phone number in E.164 format
54
- phone: nil,
55
- # Contact phone country code (e.g., "1" for US)
56
- phone_country_code: nil,
57
- # Contact's role in the business
58
- role: nil
59
- )
60
- end
61
-
62
- sig do
63
- override.returns(
64
- {
65
- name: String,
66
- business_name: T.nilable(String),
67
- email: T.nilable(String),
68
- phone: T.nilable(String),
69
- phone_country_code: T.nilable(String),
70
- role: T.nilable(String)
71
- }
72
- )
73
- end
74
- def to_hash
75
- end
76
- end
77
- end
78
- end
@@ -1,65 +0,0 @@
1
- # typed: strong
2
-
3
- module Sentdm
4
- module Models
5
- class BrandsBrandData < Sentdm::Internal::Type::BaseModel
6
- OrHash =
7
- T.type_alias do
8
- T.any(Sentdm::BrandsBrandData, Sentdm::Internal::AnyHash)
9
- end
10
-
11
- # Compliance and TCR information for brand registration
12
- sig { returns(Sentdm::BrandComplianceInfo) }
13
- attr_reader :compliance
14
-
15
- sig { params(compliance: Sentdm::BrandComplianceInfo::OrHash).void }
16
- attr_writer :compliance
17
-
18
- # Contact information for brand KYC
19
- sig { returns(Sentdm::BrandContactInfo) }
20
- attr_reader :contact
21
-
22
- sig { params(contact: Sentdm::BrandContactInfo::OrHash).void }
23
- attr_writer :contact
24
-
25
- # Business details and address for brand KYC
26
- sig { returns(T.nilable(Sentdm::BrandBusinessInfo)) }
27
- attr_reader :business
28
-
29
- sig do
30
- params(business: T.nilable(Sentdm::BrandBusinessInfo::OrHash)).void
31
- end
32
- attr_writer :business
33
-
34
- # Brand and KYC data grouped into contact, business, and compliance sections
35
- sig do
36
- params(
37
- compliance: Sentdm::BrandComplianceInfo::OrHash,
38
- contact: Sentdm::BrandContactInfo::OrHash,
39
- business: T.nilable(Sentdm::BrandBusinessInfo::OrHash)
40
- ).returns(T.attached_class)
41
- end
42
- def self.new(
43
- # Compliance and TCR information for brand registration
44
- compliance:,
45
- # Contact information for brand KYC
46
- contact:,
47
- # Business details and address for brand KYC
48
- business: nil
49
- )
50
- end
51
-
52
- sig do
53
- override.returns(
54
- {
55
- compliance: Sentdm::BrandComplianceInfo,
56
- contact: Sentdm::BrandContactInfo,
57
- business: T.nilable(Sentdm::BrandBusinessInfo)
58
- }
59
- )
60
- end
61
- def to_hash
62
- end
63
- end
64
- end
65
- end