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
@@ -14,14 +14,14 @@ module Sentdm
14
14
  # @!attribute error
15
15
  # Error information
16
16
  #
17
- # @return [Sentdm::Models::ProfileCompleteResponse::Error, nil]
18
- optional :error, -> { Sentdm::Models::ProfileCompleteResponse::Error }, nil?: true
17
+ # @return [Sentdm::Models::ErrorDetail, nil]
18
+ optional :error, -> { Sentdm::ErrorDetail }, nil?: true
19
19
 
20
20
  # @!attribute meta
21
21
  # Request and response metadata
22
22
  #
23
- # @return [Sentdm::Models::ProfileCompleteResponse::Meta, nil]
24
- optional :meta, -> { Sentdm::Models::ProfileCompleteResponse::Meta }
23
+ # @return [Sentdm::Models::APIMeta, nil]
24
+ optional :meta, -> { Sentdm::APIMeta }
25
25
 
26
26
  # @!attribute success
27
27
  # Indicates whether the request was successful
@@ -37,9 +37,9 @@ module Sentdm
37
37
  #
38
38
  # @param data [Sentdm::Models::ProfileCompleteResponse::Data, nil] Response when a profile is already in the completed state and no further action
39
39
  #
40
- # @param error [Sentdm::Models::ProfileCompleteResponse::Error, nil] Error information
40
+ # @param error [Sentdm::Models::ErrorDetail, nil] Error information
41
41
  #
42
- # @param meta [Sentdm::Models::ProfileCompleteResponse::Meta] Request and response metadata
42
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
43
43
  #
44
44
  # @param success [Boolean] Indicates whether the request was successful
45
45
 
@@ -69,74 +69,6 @@ module Sentdm
69
69
  #
70
70
  # @param status [String] Current process status of the profile (e.g., "completed", "submitted", "in_progr
71
71
  end
72
-
73
- # @see Sentdm::Models::ProfileCompleteResponse#error
74
- class Error < Sentdm::Internal::Type::BaseModel
75
- # @!attribute code
76
- # Machine-readable error code (e.g., "RESOURCE_001")
77
- #
78
- # @return [String, nil]
79
- optional :code, String
80
-
81
- # @!attribute details
82
- # Additional validation error details (field-level errors)
83
- #
84
- # @return [Hash{Symbol=>Array<String>}, nil]
85
- optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
86
-
87
- # @!attribute doc_url
88
- # URL to documentation about this error
89
- #
90
- # @return [String, nil]
91
- optional :doc_url, String, nil?: true
92
-
93
- # @!attribute message
94
- # Human-readable error message
95
- #
96
- # @return [String, nil]
97
- optional :message, String
98
-
99
- # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
100
- # Error information
101
- #
102
- # @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
103
- #
104
- # @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
105
- #
106
- # @param doc_url [String, nil] URL to documentation about this error
107
- #
108
- # @param message [String] Human-readable error message
109
- end
110
-
111
- # @see Sentdm::Models::ProfileCompleteResponse#meta
112
- class Meta < Sentdm::Internal::Type::BaseModel
113
- # @!attribute request_id
114
- # Unique identifier for this request (for tracing and support)
115
- #
116
- # @return [String, nil]
117
- optional :request_id, String
118
-
119
- # @!attribute timestamp
120
- # Server timestamp when the response was generated
121
- #
122
- # @return [Time, nil]
123
- optional :timestamp, Time
124
-
125
- # @!attribute version
126
- # API version used for this request
127
- #
128
- # @return [String, nil]
129
- optional :version, String
130
-
131
- # @!method initialize(request_id: nil, timestamp: nil, version: nil)
132
- # Request and response metadata
133
- #
134
- # @param request_id [String] Unique identifier for this request (for tracing and support)
135
- #
136
- # @param timestamp [Time] Server timestamp when the response was generated
137
- #
138
- # @param version [String] API version used for this request
139
- end
140
72
  end
141
73
  end
142
74
  end
@@ -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