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
@@ -39,8 +39,8 @@ module Sentdm
39
39
  # Billing contact information for a profile. Required when billing_model is
40
40
  # "profile" or "profile_and_organization".
41
41
  #
42
- # @return [Sentdm::Models::ProfileCreateParams::BillingContact, nil]
43
- optional :billing_contact, -> { Sentdm::ProfileCreateParams::BillingContact }, nil?: true
42
+ # @return [Sentdm::Models::BillingContactInfo, nil]
43
+ optional :billing_contact, -> { Sentdm::BillingContactInfo }, nil?: true
44
44
 
45
45
  # @!attribute billing_model
46
46
  # Billing model: profile, organization, or profile_and_organization (default:
@@ -58,8 +58,8 @@ module Sentdm
58
58
  # @!attribute brand
59
59
  # Brand and KYC data grouped into contact, business, and compliance sections
60
60
  #
61
- # @return [Sentdm::Models::ProfileCreateParams::Brand, nil]
62
- optional :brand, -> { Sentdm::ProfileCreateParams::Brand }, nil?: true
61
+ # @return [Sentdm::Models::BrandsBrandData, nil]
62
+ optional :brand, -> { Sentdm::BrandsBrandData }, nil?: true
63
63
 
64
64
  # @!attribute description
65
65
  # Profile description (optional)
@@ -108,8 +108,8 @@ module Sentdm
108
108
  # "profile" or "profile_and_organization". Not persisted on our servers —
109
109
  # forwarded to the payment processor.
110
110
  #
111
- # @return [Sentdm::Models::ProfileCreateParams::PaymentDetails, nil]
112
- optional :payment_details, -> { Sentdm::ProfileCreateParams::PaymentDetails }, nil?: true
111
+ # @return [Sentdm::Models::PaymentDetails, nil]
112
+ optional :payment_details, -> { Sentdm::PaymentDetails }, nil?: true
113
113
 
114
114
  # @!attribute sandbox
115
115
  # Sandbox flag - when true, the operation is simulated without side effects Useful
@@ -156,11 +156,11 @@ module Sentdm
156
156
  #
157
157
  # @param allow_template_sharing [Boolean, nil]
158
158
  #
159
- # @param billing_contact [Sentdm::Models::ProfileCreateParams::BillingContact, nil] Billing contact information for a profile.
159
+ # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Billing contact information for a profile.
160
160
  #
161
161
  # @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization (default: prof
162
162
  #
163
- # @param brand [Sentdm::Models::ProfileCreateParams::Brand, nil] Brand and KYC data grouped into contact, business, and compliance sections
163
+ # @param brand [Sentdm::Models::BrandsBrandData, nil] Brand and KYC data grouped into contact, business, and compliance sections
164
164
  #
165
165
  # @param description [String, nil] Profile description (optional)
166
166
  #
@@ -176,7 +176,7 @@ module Sentdm
176
176
  #
177
177
  # @param name [String] Profile name (required)
178
178
  #
179
- # @param payment_details [Sentdm::Models::ProfileCreateParams::PaymentDetails, nil] Payment card details for this profile (optional).
179
+ # @param payment_details [Sentdm::Models::PaymentDetails, nil] Payment card details for this profile (optional).
180
180
  #
181
181
  # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
182
182
  #
@@ -190,342 +190,6 @@ module Sentdm
190
190
  #
191
191
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
192
192
 
193
- class BillingContact < Sentdm::Internal::Type::BaseModel
194
- # @!attribute email
195
- # Email address where invoices will be sent (required)
196
- #
197
- # @return [String]
198
- required :email, String
199
-
200
- # @!attribute name
201
- # Full name of the billing contact or company (required)
202
- #
203
- # @return [String]
204
- required :name, String
205
-
206
- # @!attribute address
207
- # Billing address (optional). Free-form text including street, city, state, postal
208
- # code, and country.
209
- #
210
- # @return [String, nil]
211
- optional :address, String, nil?: true
212
-
213
- # @!attribute phone
214
- # Phone number for the billing contact (optional)
215
- #
216
- # @return [String, nil]
217
- optional :phone, String, nil?: true
218
-
219
- # @!method initialize(email:, name:, address: nil, phone: nil)
220
- # Some parameter documentations has been truncated, see
221
- # {Sentdm::Models::ProfileCreateParams::BillingContact} for more details.
222
- #
223
- # Billing contact information for a profile. Required when billing_model is
224
- # "profile" or "profile_and_organization".
225
- #
226
- # @param email [String] Email address where invoices will be sent (required)
227
- #
228
- # @param name [String] Full name of the billing contact or company (required)
229
- #
230
- # @param address [String, nil] Billing address (optional). Free-form text including street, city, state, postal
231
- #
232
- # @param phone [String, nil] Phone number for the billing contact (optional)
233
- end
234
-
235
- class Brand < Sentdm::Internal::Type::BaseModel
236
- # @!attribute compliance
237
- # Compliance and TCR information for brand registration
238
- #
239
- # @return [Sentdm::Models::ProfileCreateParams::Brand::Compliance]
240
- required :compliance, -> { Sentdm::ProfileCreateParams::Brand::Compliance }
241
-
242
- # @!attribute contact
243
- # Contact information for brand KYC
244
- #
245
- # @return [Sentdm::Models::ProfileCreateParams::Brand::Contact]
246
- required :contact, -> { Sentdm::ProfileCreateParams::Brand::Contact }
247
-
248
- # @!attribute business
249
- # Business details and address for brand KYC
250
- #
251
- # @return [Sentdm::Models::ProfileCreateParams::Brand::Business, nil]
252
- optional :business, -> { Sentdm::ProfileCreateParams::Brand::Business }, nil?: true
253
-
254
- # @!method initialize(compliance:, contact:, business: nil)
255
- # Brand and KYC data grouped into contact, business, and compliance sections
256
- #
257
- # @param compliance [Sentdm::Models::ProfileCreateParams::Brand::Compliance] Compliance and TCR information for brand registration
258
- #
259
- # @param contact [Sentdm::Models::ProfileCreateParams::Brand::Contact] Contact information for brand KYC
260
- #
261
- # @param business [Sentdm::Models::ProfileCreateParams::Brand::Business, nil] Business details and address for brand KYC
262
-
263
- # @see Sentdm::Models::ProfileCreateParams::Brand#compliance
264
- class Compliance < Sentdm::Internal::Type::BaseModel
265
- # @!attribute brand_relationship
266
- #
267
- # @return [Symbol, Sentdm::Models::TcrBrandRelationship]
268
- required :brand_relationship,
269
- enum: -> {
270
- Sentdm::TcrBrandRelationship
271
- },
272
- api_name: :brandRelationship
273
-
274
- # @!attribute vertical
275
- #
276
- # @return [Symbol, Sentdm::Models::TcrVertical]
277
- required :vertical, enum: -> { Sentdm::TcrVertical }
278
-
279
- # @!attribute destination_countries
280
- # List of destination countries for messaging
281
- #
282
- # @return [Array<Sentdm::Models::DestinationCountry>, nil]
283
- optional :destination_countries,
284
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
285
- api_name: :destinationCountries,
286
- nil?: true
287
-
288
- # @!attribute is_tcr_application
289
- # Whether this is a TCR (Campaign Registry) application
290
- #
291
- # @return [Boolean, nil]
292
- optional :is_tcr_application,
293
- Sentdm::Internal::Type::Boolean,
294
- api_name: :isTcrApplication,
295
- nil?: true
296
-
297
- # @!attribute notes
298
- # Additional notes about the business or use case
299
- #
300
- # @return [String, nil]
301
- optional :notes, String, nil?: true
302
-
303
- # @!attribute phone_number_prefix
304
- # Phone number prefix for messaging (e.g., "+1")
305
- #
306
- # @return [String, nil]
307
- optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
308
-
309
- # @!method initialize(brand_relationship:, vertical:, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil)
310
- # Compliance and TCR information for brand registration
311
- #
312
- # @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship]
313
- #
314
- # @param vertical [Symbol, Sentdm::Models::TcrVertical]
315
- #
316
- # @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
317
- #
318
- # @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
319
- #
320
- # @param notes [String, nil] Additional notes about the business or use case
321
- #
322
- # @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
323
- end
324
-
325
- # @see Sentdm::Models::ProfileCreateParams::Brand#contact
326
- class Contact < Sentdm::Internal::Type::BaseModel
327
- # @!attribute name
328
- # Primary contact name (required)
329
- #
330
- # @return [String]
331
- required :name, String
332
-
333
- # @!attribute business_name
334
- # Business/brand name
335
- #
336
- # @return [String, nil]
337
- optional :business_name, String, api_name: :businessName, nil?: true
338
-
339
- # @!attribute email
340
- # Contact email address
341
- #
342
- # @return [String, nil]
343
- optional :email, String, nil?: true
344
-
345
- # @!attribute phone
346
- # Contact phone number in E.164 format
347
- #
348
- # @return [String, nil]
349
- optional :phone, String, nil?: true
350
-
351
- # @!attribute phone_country_code
352
- # Contact phone country code (e.g., "1" for US)
353
- #
354
- # @return [String, nil]
355
- optional :phone_country_code, String, api_name: :phoneCountryCode, nil?: true
356
-
357
- # @!attribute role
358
- # Contact's role in the business
359
- #
360
- # @return [String, nil]
361
- optional :role, String, nil?: true
362
-
363
- # @!method initialize(name:, business_name: nil, email: nil, phone: nil, phone_country_code: nil, role: nil)
364
- # Contact information for brand KYC
365
- #
366
- # @param name [String] Primary contact name (required)
367
- #
368
- # @param business_name [String, nil] Business/brand name
369
- #
370
- # @param email [String, nil] Contact email address
371
- #
372
- # @param phone [String, nil] Contact phone number in E.164 format
373
- #
374
- # @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
375
- #
376
- # @param role [String, nil] Contact's role in the business
377
- end
378
-
379
- # @see Sentdm::Models::ProfileCreateParams::Brand#business
380
- class Business < Sentdm::Internal::Type::BaseModel
381
- # @!attribute city
382
- # City
383
- #
384
- # @return [String, nil]
385
- optional :city, String, nil?: true
386
-
387
- # @!attribute country
388
- # Country code (e.g., US, CA)
389
- #
390
- # @return [String, nil]
391
- optional :country, String, nil?: true
392
-
393
- # @!attribute country_of_registration
394
- # Country where the business is registered
395
- #
396
- # @return [String, nil]
397
- optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
398
-
399
- # @!attribute entity_type
400
- #
401
- # @return [Symbol, Sentdm::Models::ProfileCreateParams::Brand::Business::EntityType, nil]
402
- optional :entity_type,
403
- enum: -> { Sentdm::ProfileCreateParams::Brand::Business::EntityType },
404
- api_name: :entityType,
405
- nil?: true
406
-
407
- # @!attribute legal_name
408
- # Legal business name
409
- #
410
- # @return [String, nil]
411
- optional :legal_name, String, api_name: :legalName, nil?: true
412
-
413
- # @!attribute postal_code
414
- # Postal/ZIP code
415
- #
416
- # @return [String, nil]
417
- optional :postal_code, String, api_name: :postalCode, nil?: true
418
-
419
- # @!attribute state
420
- # State/province code
421
- #
422
- # @return [String, nil]
423
- optional :state, String, nil?: true
424
-
425
- # @!attribute street
426
- # Street address
427
- #
428
- # @return [String, nil]
429
- optional :street, String, nil?: true
430
-
431
- # @!attribute tax_id
432
- # Tax ID/EIN number
433
- #
434
- # @return [String, nil]
435
- optional :tax_id, String, api_name: :taxId, nil?: true
436
-
437
- # @!attribute tax_id_type
438
- # Type of tax ID (e.g., us_ein, ca_bn)
439
- #
440
- # @return [String, nil]
441
- optional :tax_id_type, String, api_name: :taxIdType, nil?: true
442
-
443
- # @!attribute url
444
- # Business website URL
445
- #
446
- # @return [String, nil]
447
- optional :url, String, nil?: true
448
-
449
- # @!method initialize(city: nil, country: nil, country_of_registration: nil, entity_type: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, url: nil)
450
- # Business details and address for brand KYC
451
- #
452
- # @param city [String, nil] City
453
- #
454
- # @param country [String, nil] Country code (e.g., US, CA)
455
- #
456
- # @param country_of_registration [String, nil] Country where the business is registered
457
- #
458
- # @param entity_type [Symbol, Sentdm::Models::ProfileCreateParams::Brand::Business::EntityType, nil]
459
- #
460
- # @param legal_name [String, nil] Legal business name
461
- #
462
- # @param postal_code [String, nil] Postal/ZIP code
463
- #
464
- # @param state [String, nil] State/province code
465
- #
466
- # @param street [String, nil] Street address
467
- #
468
- # @param tax_id [String, nil] Tax ID/EIN number
469
- #
470
- # @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
471
- #
472
- # @param url [String, nil] Business website URL
473
-
474
- # @see Sentdm::Models::ProfileCreateParams::Brand::Business#entity_type
475
- module EntityType
476
- extend Sentdm::Internal::Type::Enum
477
-
478
- PRIVATE_PROFIT = :PRIVATE_PROFIT
479
- PUBLIC_PROFIT = :PUBLIC_PROFIT
480
- NON_PROFIT = :NON_PROFIT
481
- SOLE_PROPRIETOR = :SOLE_PROPRIETOR
482
- GOVERNMENT = :GOVERNMENT
483
-
484
- # @!method self.values
485
- # @return [Array<Symbol>]
486
- end
487
- end
488
- end
489
-
490
- class PaymentDetails < Sentdm::Internal::Type::BaseModel
491
- # @!attribute card_number
492
- # Card number (digits only, 13–19 characters)
493
- #
494
- # @return [String]
495
- required :card_number, String
496
-
497
- # @!attribute cvc
498
- # Card security code (3–4 digits)
499
- #
500
- # @return [String]
501
- required :cvc, String
502
-
503
- # @!attribute expiry
504
- # Card expiry date in MM/YY format (e.g. "09/27")
505
- #
506
- # @return [String]
507
- required :expiry, String
508
-
509
- # @!attribute zip_code
510
- # Billing ZIP / postal code associated with the card
511
- #
512
- # @return [String]
513
- required :zip_code, String
514
-
515
- # @!method initialize(card_number:, cvc:, expiry:, zip_code:)
516
- # Payment card details for this profile (optional). Accepted when billing_model is
517
- # "profile" or "profile_and_organization". Not persisted on our servers —
518
- # forwarded to the payment processor.
519
- #
520
- # @param card_number [String] Card number (digits only, 13–19 characters)
521
- #
522
- # @param cvc [String] Card security code (3–4 digits)
523
- #
524
- # @param expiry [String] Card expiry date in MM/YY format (e.g. "09/27")
525
- #
526
- # @param zip_code [String] Billing ZIP / postal code associated with the card
527
- end
528
-
529
193
  class WhatsappBusinessAccount < Sentdm::Internal::Type::BaseModel
530
194
  # @!attribute access_token
531
195
  # System User access token with whatsapp_business_messaging and
@@ -3,7 +3,7 @@
3
3
  module Sentdm
4
4
  module Models
5
5
  # @see Sentdm::Resources::Profiles#delete
6
- class ProfileDeleteParams < Sentdm::Internal::Type::BaseModel
6
+ class ProfileDeleteParams < Sentdm::Models::MutationRequest
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
@@ -12,28 +12,14 @@ module Sentdm
12
12
  # @return [String]
13
13
  required :profile_id, String
14
14
 
15
- # @!attribute sandbox
16
- # Sandbox flag - when true, the operation is simulated without side effects Useful
17
- # for testing integrations without actual execution
18
- #
19
- # @return [Boolean, nil]
20
- optional :sandbox, Sentdm::Internal::Type::Boolean
21
-
22
15
  # @!attribute x_profile_id
23
16
  #
24
17
  # @return [String, nil]
25
18
  optional :x_profile_id, String
26
19
 
27
- # @!method initialize(profile_id:, sandbox: nil, x_profile_id: nil, request_options: {})
28
- # Some parameter documentations has been truncated, see
29
- # {Sentdm::Models::ProfileDeleteParams} for more details.
30
- #
20
+ # @!method initialize(profile_id:, x_profile_id: nil, request_options: {})
31
21
  # @param profile_id [String]
32
- #
33
- # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
34
- #
35
22
  # @param x_profile_id [String]
36
- #
37
23
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
38
24
  end
39
25
  end