sentdm 0.27.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 (275) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +13 -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/me_retrieve_response.rb +242 -12
  15. data/lib/sentdm/models/message_retrieve_activities_response.rb +165 -7
  16. data/lib/sentdm/models/message_retrieve_status_response.rb +74 -6
  17. data/lib/sentdm/models/message_send_response.rb +113 -28
  18. data/lib/sentdm/models/number_lookup_response.rb +74 -6
  19. data/lib/sentdm/models/profile_complete_response.rb +74 -6
  20. data/lib/sentdm/models/profile_create_params.rb +378 -26
  21. data/lib/sentdm/models/profile_create_response.rb +760 -0
  22. data/lib/sentdm/models/profile_delete_params.rb +16 -2
  23. data/lib/sentdm/models/profile_list_response.rb +825 -14
  24. data/lib/sentdm/models/profile_retrieve_response.rb +762 -0
  25. data/lib/sentdm/models/profile_update_params.rb +391 -24
  26. data/lib/sentdm/models/profile_update_response.rb +760 -0
  27. data/lib/sentdm/models/profiles/campaign_create_params.rb +156 -3
  28. data/lib/sentdm/models/profiles/campaign_create_response.rb +420 -0
  29. data/lib/sentdm/models/profiles/campaign_delete_params.rb +17 -2
  30. data/lib/sentdm/models/profiles/campaign_list_response.rb +421 -0
  31. data/lib/sentdm/models/profiles/campaign_update_params.rb +156 -3
  32. data/lib/sentdm/models/profiles/campaign_update_response.rb +420 -0
  33. data/lib/sentdm/models/template_create_response.rb +209 -0
  34. data/lib/sentdm/models/template_list_params.rb +9 -2
  35. data/lib/sentdm/models/template_list_response.rb +262 -16
  36. data/lib/sentdm/models/template_retrieve_response.rb +209 -0
  37. data/lib/sentdm/models/template_update_response.rb +209 -0
  38. data/lib/sentdm/models/user_invite_response.rb +201 -0
  39. data/lib/sentdm/models/user_list_response.rb +259 -14
  40. data/lib/sentdm/models/user_remove_params.rb +16 -2
  41. data/lib/sentdm/models/user_retrieve_response.rb +201 -0
  42. data/lib/sentdm/models/user_update_role_response.rb +201 -0
  43. data/lib/sentdm/models/webhook_create_response.rb +229 -0
  44. data/lib/sentdm/models/webhook_list_event_types_response.rb +213 -13
  45. data/lib/sentdm/models/webhook_list_events_response.rb +162 -13
  46. data/lib/sentdm/models/webhook_list_response.rb +280 -15
  47. data/lib/sentdm/models/webhook_retrieve_response.rb +229 -0
  48. data/lib/sentdm/models/webhook_rotate_secret_params.rb +17 -2
  49. data/lib/sentdm/models/webhook_rotate_secret_response.rb +74 -6
  50. data/lib/sentdm/models/webhook_test_response.rb +74 -6
  51. data/lib/sentdm/models/webhook_toggle_status_response.rb +229 -0
  52. data/lib/sentdm/models/webhook_update_response.rb +229 -0
  53. data/lib/sentdm/models.rb +0 -52
  54. data/lib/sentdm/resources/contacts.rb +30 -13
  55. data/lib/sentdm/resources/conversations.rb +12 -4
  56. data/lib/sentdm/resources/me.rb +6 -1
  57. data/lib/sentdm/resources/messages.rb +11 -1
  58. data/lib/sentdm/resources/numbers.rb +6 -1
  59. data/lib/sentdm/resources/profiles/campaigns.rb +47 -9
  60. data/lib/sentdm/resources/profiles.rb +134 -58
  61. data/lib/sentdm/resources/templates.rb +14 -8
  62. data/lib/sentdm/resources/users.rb +12 -7
  63. data/lib/sentdm/resources/webhooks.rb +19 -9
  64. data/lib/sentdm/version.rb +1 -1
  65. data/lib/sentdm.rb +22 -32
  66. data/rbi/sentdm/client.rbi +71 -8
  67. data/rbi/sentdm/models/contact_create_response.rbi +407 -0
  68. data/rbi/sentdm/models/contact_delete_params.rbi +19 -2
  69. data/rbi/sentdm/models/contact_list_response.rbi +527 -21
  70. data/rbi/sentdm/models/contact_retrieve_message_summary_response.rbi +397 -0
  71. data/rbi/sentdm/models/contact_retrieve_response.rbi +409 -0
  72. data/rbi/sentdm/models/contact_update_response.rbi +407 -0
  73. data/rbi/sentdm/models/conversation_list_messages_response.rbi +843 -0
  74. data/rbi/sentdm/models/conversation_list_response.rbi +819 -0
  75. data/rbi/sentdm/models/me_retrieve_response.rbi +367 -16
  76. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +335 -11
  77. data/rbi/sentdm/models/message_retrieve_status_response.rbi +148 -8
  78. data/rbi/sentdm/models/message_send_response.rbi +178 -32
  79. data/rbi/sentdm/models/number_lookup_response.rbi +135 -8
  80. data/rbi/sentdm/models/profile_complete_response.rbi +137 -8
  81. data/rbi/sentdm/models/profile_create_params.rbi +592 -42
  82. data/rbi/sentdm/models/profile_create_response.rbi +1226 -0
  83. data/rbi/sentdm/models/profile_delete_params.rbi +19 -2
  84. data/rbi/sentdm/models/profile_list_response.rbi +1366 -18
  85. data/rbi/sentdm/models/profile_retrieve_response.rbi +1230 -0
  86. data/rbi/sentdm/models/profile_update_params.rbi +610 -30
  87. data/rbi/sentdm/models/profile_update_response.rbi +1226 -0
  88. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +218 -4
  89. data/rbi/sentdm/models/profiles/campaign_create_response.rbi +674 -0
  90. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +14 -1
  91. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +667 -0
  92. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +218 -4
  93. data/rbi/sentdm/models/profiles/campaign_update_response.rbi +674 -0
  94. data/rbi/sentdm/models/template_create_response.rbi +349 -0
  95. data/rbi/sentdm/models/template_list_params.rbi +10 -2
  96. data/rbi/sentdm/models/template_list_response.rbi +469 -21
  97. data/rbi/sentdm/models/template_retrieve_response.rbi +355 -0
  98. data/rbi/sentdm/models/template_update_response.rbi +349 -0
  99. data/rbi/sentdm/models/user_invite_response.rbi +336 -0
  100. data/rbi/sentdm/models/user_list_response.rbi +463 -18
  101. data/rbi/sentdm/models/user_remove_params.rbi +19 -2
  102. data/rbi/sentdm/models/user_retrieve_response.rbi +336 -0
  103. data/rbi/sentdm/models/user_update_role_response.rbi +341 -0
  104. data/rbi/sentdm/models/webhook_create_response.rbi +361 -0
  105. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +433 -16
  106. data/rbi/sentdm/models/webhook_list_events_response.rbi +319 -15
  107. data/rbi/sentdm/models/webhook_list_response.rbi +480 -19
  108. data/rbi/sentdm/models/webhook_retrieve_response.rbi +363 -0
  109. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +14 -1
  110. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +148 -8
  111. data/rbi/sentdm/models/webhook_test_response.rbi +135 -8
  112. data/rbi/sentdm/models/webhook_toggle_status_response.rbi +379 -0
  113. data/rbi/sentdm/models/webhook_update_response.rbi +361 -0
  114. data/rbi/sentdm/models.rbi +0 -54
  115. data/rbi/sentdm/resources/contacts.rbi +24 -9
  116. data/rbi/sentdm/resources/conversations.rbi +10 -2
  117. data/rbi/sentdm/resources/me.rbi +6 -1
  118. data/rbi/sentdm/resources/messages.rbi +11 -1
  119. data/rbi/sentdm/resources/numbers.rbi +6 -1
  120. data/rbi/sentdm/resources/profiles/campaigns.rbi +36 -6
  121. data/rbi/sentdm/resources/profiles.rbi +174 -66
  122. data/rbi/sentdm/resources/templates.rbi +15 -5
  123. data/rbi/sentdm/resources/users.rbi +9 -4
  124. data/rbi/sentdm/resources/webhooks.rbi +15 -5
  125. data/sig/sentdm/models/contact_create_response.rbs +216 -0
  126. data/sig/sentdm/models/contact_delete_params.rbs +10 -6
  127. data/sig/sentdm/models/contact_list_response.rbs +263 -20
  128. data/sig/sentdm/models/contact_retrieve_message_summary_response.rbs +182 -0
  129. data/sig/sentdm/models/contact_retrieve_response.rbs +216 -0
  130. data/sig/sentdm/models/contact_update_response.rbs +216 -0
  131. data/sig/sentdm/models/conversation_list_messages_response.rbs +404 -0
  132. data/sig/sentdm/models/conversation_list_response.rbs +404 -0
  133. data/sig/sentdm/models/me_retrieve_response.rbs +176 -18
  134. data/sig/sentdm/models/message_retrieve_activities_response.rbs +147 -12
  135. data/sig/sentdm/models/message_retrieve_status_response.rbs +71 -9
  136. data/sig/sentdm/models/message_send_response.rbs +71 -9
  137. data/sig/sentdm/models/number_lookup_response.rbs +71 -9
  138. data/sig/sentdm/models/profile_complete_response.rbs +71 -9
  139. data/sig/sentdm/models/profile_create_params.rbs +271 -24
  140. data/sig/sentdm/models/profile_create_response.rbs +559 -0
  141. data/sig/sentdm/models/profile_delete_params.rbs +10 -6
  142. data/sig/sentdm/models/profile_list_response.rbs +615 -15
  143. data/sig/sentdm/models/profile_retrieve_response.rbs +559 -0
  144. data/sig/sentdm/models/profile_update_params.rbs +263 -12
  145. data/sig/sentdm/models/profile_update_response.rbs +559 -0
  146. data/sig/sentdm/models/profiles/campaign_create_params.rbs +108 -4
  147. data/sig/sentdm/models/profiles/campaign_create_response.rbs +357 -0
  148. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +15 -8
  149. data/sig/sentdm/models/profiles/campaign_list_response.rbs +357 -0
  150. data/sig/sentdm/models/profiles/campaign_update_params.rbs +108 -4
  151. data/sig/sentdm/models/profiles/campaign_update_response.rbs +357 -0
  152. data/sig/sentdm/models/template_create_response.rbs +182 -0
  153. data/sig/sentdm/models/template_list_response.rbs +230 -19
  154. data/sig/sentdm/models/template_retrieve_response.rbs +182 -0
  155. data/sig/sentdm/models/template_update_response.rbs +182 -0
  156. data/sig/sentdm/models/user_invite_response.rbs +177 -0
  157. data/sig/sentdm/models/user_list_response.rbs +233 -15
  158. data/sig/sentdm/models/user_remove_params.rbs +10 -6
  159. data/sig/sentdm/models/user_retrieve_response.rbs +177 -0
  160. data/sig/sentdm/models/user_update_role_response.rbs +177 -0
  161. data/sig/sentdm/models/webhook_create_response.rbs +208 -0
  162. data/sig/sentdm/models/webhook_list_event_types_response.rbs +203 -15
  163. data/sig/sentdm/models/webhook_list_events_response.rbs +142 -14
  164. data/sig/sentdm/models/webhook_list_response.rbs +255 -20
  165. data/sig/sentdm/models/webhook_retrieve_response.rbs +208 -0
  166. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +17 -8
  167. data/sig/sentdm/models/webhook_rotate_secret_response.rbs +71 -9
  168. data/sig/sentdm/models/webhook_test_response.rbs +71 -9
  169. data/sig/sentdm/models/webhook_toggle_status_response.rbs +208 -0
  170. data/sig/sentdm/models/webhook_update_response.rbs +208 -0
  171. data/sig/sentdm/models.rbs +0 -52
  172. data/sig/sentdm/resources/contacts.rbs +4 -4
  173. data/sig/sentdm/resources/conversations.rbs +2 -2
  174. data/sig/sentdm/resources/profiles/campaigns.rbs +5 -5
  175. data/sig/sentdm/resources/profiles.rbs +11 -11
  176. data/sig/sentdm/resources/templates.rbs +3 -3
  177. data/sig/sentdm/resources/users.rbs +3 -3
  178. data/sig/sentdm/resources/webhooks.rbs +4 -4
  179. metadata +68 -98
  180. data/lib/sentdm/models/api_meta.rb +0 -34
  181. data/lib/sentdm/models/api_response_of_contact.rb +0 -46
  182. data/lib/sentdm/models/api_response_of_contact_message_summary.rb +0 -43
  183. data/lib/sentdm/models/api_response_of_conversation_messages_list.rb +0 -43
  184. data/lib/sentdm/models/api_response_of_profile_detail.rb +0 -43
  185. data/lib/sentdm/models/api_response_of_user.rb +0 -43
  186. data/lib/sentdm/models/api_response_template.rb +0 -43
  187. data/lib/sentdm/models/api_response_webhook.rb +0 -43
  188. data/lib/sentdm/models/billing_contact_info.rb +0 -47
  189. data/lib/sentdm/models/brand_business_info.rb +0 -114
  190. data/lib/sentdm/models/brand_compliance_info.rb +0 -67
  191. data/lib/sentdm/models/brand_contact_info.rb +0 -58
  192. data/lib/sentdm/models/brands_brand_data.rb +0 -34
  193. data/lib/sentdm/models/contact_message_summary.rb +0 -76
  194. data/lib/sentdm/models/contact_response.rb +0 -126
  195. data/lib/sentdm/models/conversation_messages_list.rb +0 -245
  196. data/lib/sentdm/models/error_detail.rb +0 -42
  197. data/lib/sentdm/models/mutation_request.rb +0 -20
  198. data/lib/sentdm/models/pagination_meta.rb +0 -80
  199. data/lib/sentdm/models/payment_details.rb +0 -44
  200. data/lib/sentdm/models/profile_detail.rb +0 -605
  201. data/lib/sentdm/models/profile_settings.rb +0 -66
  202. data/lib/sentdm/models/profiles/api_response_of_brand_campaign.rb +0 -45
  203. data/lib/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rb +0 -45
  204. data/lib/sentdm/models/profiles/brand_campaign.rb +0 -247
  205. data/lib/sentdm/models/profiles/campaign_data.rb +0 -130
  206. data/lib/sentdm/models/profiles/campaign_use_case.rb +0 -71
  207. data/lib/sentdm/models/profiles/campaign_use_case_data.rb +0 -29
  208. data/lib/sentdm/models/template.rb +0 -90
  209. data/lib/sentdm/models/user_response.rb +0 -82
  210. data/lib/sentdm/models/webhook_event_type.rb +0 -45
  211. data/lib/sentdm/models/webhook_response.rb +0 -95
  212. data/rbi/sentdm/models/api_meta.rbi +0 -55
  213. data/rbi/sentdm/models/api_response_of_contact.rbi +0 -74
  214. data/rbi/sentdm/models/api_response_of_contact_message_summary.rbi +0 -79
  215. data/rbi/sentdm/models/api_response_of_conversation_messages_list.rbi +0 -79
  216. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +0 -74
  217. data/rbi/sentdm/models/api_response_of_user.rbi +0 -74
  218. data/rbi/sentdm/models/api_response_template.rbi +0 -74
  219. data/rbi/sentdm/models/api_response_webhook.rbi +0 -74
  220. data/rbi/sentdm/models/billing_contact_info.rbi +0 -65
  221. data/rbi/sentdm/models/brand_business_info.rbi +0 -162
  222. data/rbi/sentdm/models/brand_compliance_info.rbi +0 -84
  223. data/rbi/sentdm/models/brand_contact_info.rbi +0 -78
  224. data/rbi/sentdm/models/brands_brand_data.rbi +0 -65
  225. data/rbi/sentdm/models/contact_message_summary.rbi +0 -144
  226. data/rbi/sentdm/models/contact_response.rbi +0 -183
  227. data/rbi/sentdm/models/conversation_messages_list.rbi +0 -419
  228. data/rbi/sentdm/models/error_detail.rbi +0 -66
  229. data/rbi/sentdm/models/mutation_request.rbi +0 -32
  230. data/rbi/sentdm/models/pagination_meta.rbi +0 -135
  231. data/rbi/sentdm/models/payment_details.rbi +0 -59
  232. data/rbi/sentdm/models/profile_detail.rbi +0 -872
  233. data/rbi/sentdm/models/profile_settings.rbi +0 -86
  234. data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi +0 -81
  235. data/rbi/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbi +0 -76
  236. data/rbi/sentdm/models/profiles/brand_campaign.rbi +0 -299
  237. data/rbi/sentdm/models/profiles/campaign_data.rbi +0 -146
  238. data/rbi/sentdm/models/profiles/campaign_use_case.rbi +0 -110
  239. data/rbi/sentdm/models/profiles/campaign_use_case_data.rbi +0 -51
  240. data/rbi/sentdm/models/template.rbi +0 -129
  241. data/rbi/sentdm/models/user_response.rbi +0 -118
  242. data/rbi/sentdm/models/webhook_event_type.rbi +0 -74
  243. data/rbi/sentdm/models/webhook_response.rbi +0 -140
  244. data/sig/sentdm/models/api_meta.rbs +0 -27
  245. data/sig/sentdm/models/api_response_of_contact.rbs +0 -39
  246. data/sig/sentdm/models/api_response_of_contact_message_summary.rbs +0 -39
  247. data/sig/sentdm/models/api_response_of_conversation_messages_list.rbs +0 -39
  248. data/sig/sentdm/models/api_response_of_profile_detail.rbs +0 -39
  249. data/sig/sentdm/models/api_response_of_user.rbs +0 -39
  250. data/sig/sentdm/models/api_response_template.rbs +0 -39
  251. data/sig/sentdm/models/api_response_webhook.rbs +0 -39
  252. data/sig/sentdm/models/billing_contact_info.rbs +0 -30
  253. data/sig/sentdm/models/brand_business_info.rbs +0 -89
  254. data/sig/sentdm/models/brand_compliance_info.rbs +0 -50
  255. data/sig/sentdm/models/brand_contact_info.rbs +0 -45
  256. data/sig/sentdm/models/brands_brand_data.rbs +0 -30
  257. data/sig/sentdm/models/contact_message_summary.rbs +0 -84
  258. data/sig/sentdm/models/contact_response.rbs +0 -111
  259. data/sig/sentdm/models/conversation_messages_list.rbs +0 -240
  260. data/sig/sentdm/models/error_detail.rbs +0 -39
  261. data/sig/sentdm/models/mutation_request.rbs +0 -15
  262. data/sig/sentdm/models/pagination_meta.rbs +0 -67
  263. data/sig/sentdm/models/payment_details.rbs +0 -30
  264. data/sig/sentdm/models/profile_detail.rbs +0 -469
  265. data/sig/sentdm/models/profile_settings.rbs +0 -50
  266. data/sig/sentdm/models/profiles/api_response_of_brand_campaign.rbs +0 -41
  267. data/sig/sentdm/models/profiles/api_response_of_list_of_brand_campaign.rbs +0 -41
  268. data/sig/sentdm/models/profiles/brand_campaign.rbs +0 -194
  269. data/sig/sentdm/models/profiles/campaign_data.rbs +0 -87
  270. data/sig/sentdm/models/profiles/campaign_use_case.rbs +0 -66
  271. data/sig/sentdm/models/profiles/campaign_use_case_data.rbs +0 -27
  272. data/sig/sentdm/models/template.rbs +0 -79
  273. data/sig/sentdm/models/user_response.rbs +0 -72
  274. data/sig/sentdm/models/webhook_event_type.rbs +0 -51
  275. data/sig/sentdm/models/webhook_response.rbs +0 -103
@@ -1,605 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- class ProfileDetail < Sentdm::Internal::Type::BaseModel
6
- # @!attribute id
7
- # Profile unique identifier
8
- #
9
- # @return [String, nil]
10
- optional :id, String
11
-
12
- # @!attribute allow_contact_sharing
13
- # Whether contacts are shared across profiles in the organization
14
- #
15
- # @return [Boolean, nil]
16
- optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean
17
-
18
- # @!attribute allow_number_change_during_onboarding
19
- # Whether number changes are allowed during onboarding
20
- #
21
- # @return [Boolean, nil]
22
- optional :allow_number_change_during_onboarding, Sentdm::Internal::Type::Boolean, nil?: true
23
-
24
- # @!attribute allow_template_sharing
25
- # Whether templates are shared across profiles in the organization
26
- #
27
- # @return [Boolean, nil]
28
- optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
29
-
30
- # @!attribute billing_contact
31
- # Billing contact info returned in profile responses
32
- #
33
- # @return [Sentdm::Models::ProfileDetail::BillingContact, nil]
34
- optional :billing_contact, -> { Sentdm::ProfileDetail::BillingContact }, nil?: true
35
-
36
- # @!attribute billing_model
37
- # Billing model: profile, organization, or profile_and_organization
38
- #
39
- # @return [String, nil]
40
- optional :billing_model, String
41
-
42
- # @!attribute brand
43
- # Brand response with nested contact, business, and compliance sections — mirrors
44
- # the request structure.
45
- #
46
- # @return [Sentdm::Models::ProfileDetail::Brand, nil]
47
- optional :brand, -> { Sentdm::ProfileDetail::Brand }, nil?: true
48
-
49
- # @!attribute created_at
50
- # When the profile was created
51
- #
52
- # @return [Time, nil]
53
- optional :created_at, Time
54
-
55
- # @!attribute description
56
- # Profile description
57
- #
58
- # @return [String, nil]
59
- optional :description, String, nil?: true
60
-
61
- # @!attribute email
62
- # Profile email (inherited from organization)
63
- #
64
- # @return [String, nil]
65
- optional :email, String, nil?: true
66
-
67
- # @!attribute icon
68
- # Profile icon URL
69
- #
70
- # @return [String, nil]
71
- optional :icon, String, nil?: true
72
-
73
- # @!attribute inherit_contacts
74
- # Whether this profile inherits contacts from the organization
75
- #
76
- # @return [Boolean, nil]
77
- optional :inherit_contacts, Sentdm::Internal::Type::Boolean
78
-
79
- # @!attribute inherit_tcr_brand
80
- # Whether this profile inherits TCR brand from the organization
81
- #
82
- # @return [Boolean, nil]
83
- optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean
84
-
85
- # @!attribute inherit_tcr_campaign
86
- # Whether this profile inherits TCR campaign from the organization
87
- #
88
- # @return [Boolean, nil]
89
- optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean
90
-
91
- # @!attribute inherit_templates
92
- # Whether this profile inherits templates from the organization
93
- #
94
- # @return [Boolean, nil]
95
- optional :inherit_templates, Sentdm::Internal::Type::Boolean
96
-
97
- # @!attribute name
98
- # Profile name
99
- #
100
- # @return [String, nil]
101
- optional :name, String
102
-
103
- # @!attribute organization_id
104
- # Parent organization ID
105
- #
106
- # @return [String, nil]
107
- optional :organization_id, String, nil?: true
108
-
109
- # @!attribute sending_phone_number
110
- # Direct SMS phone number
111
- #
112
- # @return [String, nil]
113
- optional :sending_phone_number, String, nil?: true
114
-
115
- # @!attribute sending_phone_number_profile_id
116
- # Reference to another profile whose SMS configuration this profile uses
117
- #
118
- # @return [String, nil]
119
- optional :sending_phone_number_profile_id, String, nil?: true
120
-
121
- # @!attribute sending_whatsapp_number_profile_id
122
- # Reference to another profile for WhatsApp configuration
123
- #
124
- # @return [String, nil]
125
- optional :sending_whatsapp_number_profile_id, String, nil?: true
126
-
127
- # @!attribute short_name
128
- # Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces
129
- # only, with at least one letter.
130
- #
131
- # @return [String, nil]
132
- optional :short_name, String, nil?: true
133
-
134
- # @!attribute status
135
- # Profile setup status: incomplete, pending_review, approved, rejected
136
- #
137
- # @return [String, nil]
138
- optional :status, String
139
-
140
- # @!attribute updated_at
141
- # When the profile was last updated
142
- #
143
- # @return [Time, nil]
144
- optional :updated_at, Time, nil?: true
145
-
146
- # @!attribute waba_id
147
- # WhatsApp Business Account ID associated with this profile. Present whether the
148
- # WABA is inherited from the organization or configured directly.
149
- #
150
- # @return [String, nil]
151
- optional :waba_id, String, nil?: true
152
-
153
- # @!attribute whatsapp_phone_number
154
- # Direct WhatsApp phone number
155
- #
156
- # @return [String, nil]
157
- optional :whatsapp_phone_number, String, nil?: true
158
-
159
- # @!method initialize(id: nil, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, created_at: nil, description: nil, email: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, organization_id: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, status: nil, updated_at: nil, waba_id: nil, whatsapp_phone_number: nil)
160
- # Some parameter documentations has been truncated, see
161
- # {Sentdm::Models::ProfileDetail} for more details.
162
- #
163
- # Detailed profile response for v3 API
164
- #
165
- # @param id [String] Profile unique identifier
166
- #
167
- # @param allow_contact_sharing [Boolean] Whether contacts are shared across profiles in the organization
168
- #
169
- # @param allow_number_change_during_onboarding [Boolean, nil] Whether number changes are allowed during onboarding
170
- #
171
- # @param allow_template_sharing [Boolean] Whether templates are shared across profiles in the organization
172
- #
173
- # @param billing_contact [Sentdm::Models::ProfileDetail::BillingContact, nil] Billing contact info returned in profile responses
174
- #
175
- # @param billing_model [String] Billing model: profile, organization, or profile_and_organization
176
- #
177
- # @param brand [Sentdm::Models::ProfileDetail::Brand, nil] Brand response with nested contact, business, and compliance sections — mirrors
178
- #
179
- # @param created_at [Time] When the profile was created
180
- #
181
- # @param description [String, nil] Profile description
182
- #
183
- # @param email [String, nil] Profile email (inherited from organization)
184
- #
185
- # @param icon [String, nil] Profile icon URL
186
- #
187
- # @param inherit_contacts [Boolean] Whether this profile inherits contacts from the organization
188
- #
189
- # @param inherit_tcr_brand [Boolean] Whether this profile inherits TCR brand from the organization
190
- #
191
- # @param inherit_tcr_campaign [Boolean] Whether this profile inherits TCR campaign from the organization
192
- #
193
- # @param inherit_templates [Boolean] Whether this profile inherits templates from the organization
194
- #
195
- # @param name [String] Profile name
196
- #
197
- # @param organization_id [String, nil] Parent organization ID
198
- #
199
- # @param sending_phone_number [String, nil] Direct SMS phone number
200
- #
201
- # @param sending_phone_number_profile_id [String, nil] Reference to another profile whose SMS configuration this profile uses
202
- #
203
- # @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile for WhatsApp configuration
204
- #
205
- # @param short_name [String, nil] Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces o
206
- #
207
- # @param status [String] Profile setup status: incomplete, pending_review, approved, rejected
208
- #
209
- # @param updated_at [Time, nil] When the profile was last updated
210
- #
211
- # @param waba_id [String, nil] WhatsApp Business Account ID associated with this profile.
212
- #
213
- # @param whatsapp_phone_number [String, nil] Direct WhatsApp phone number
214
-
215
- # @see Sentdm::Models::ProfileDetail#billing_contact
216
- class BillingContact < Sentdm::Internal::Type::BaseModel
217
- # @!attribute address
218
- #
219
- # @return [String, nil]
220
- optional :address, String, nil?: true
221
-
222
- # @!attribute email
223
- #
224
- # @return [String, nil]
225
- optional :email, String, nil?: true
226
-
227
- # @!attribute name
228
- #
229
- # @return [String, nil]
230
- optional :name, String, nil?: true
231
-
232
- # @!attribute phone
233
- #
234
- # @return [String, nil]
235
- optional :phone, String, nil?: true
236
-
237
- # @!method initialize(address: nil, email: nil, name: nil, phone: nil)
238
- # Billing contact info returned in profile responses
239
- #
240
- # @param address [String, nil]
241
- # @param email [String, nil]
242
- # @param name [String, nil]
243
- # @param phone [String, nil]
244
- end
245
-
246
- # @see Sentdm::Models::ProfileDetail#brand
247
- class Brand < Sentdm::Internal::Type::BaseModel
248
- # @!attribute id
249
- # Unique identifier for the brand
250
- #
251
- # @return [String, nil]
252
- optional :id, String
253
-
254
- # @!attribute business
255
- # Business details and address information
256
- #
257
- # @return [Sentdm::Models::ProfileDetail::Brand::Business, nil]
258
- optional :business, -> { Sentdm::ProfileDetail::Brand::Business }, nil?: true
259
-
260
- # @!attribute compliance
261
- # Compliance and TCR-related information
262
- #
263
- # @return [Sentdm::Models::ProfileDetail::Brand::Compliance, nil]
264
- optional :compliance, -> { Sentdm::ProfileDetail::Brand::Compliance }, nil?: true
265
-
266
- # @!attribute contact
267
- # Contact information for the brand
268
- #
269
- # @return [Sentdm::Models::ProfileDetail::Brand::Contact, nil]
270
- optional :contact, -> { Sentdm::ProfileDetail::Brand::Contact }, nil?: true
271
-
272
- # @!attribute created_at
273
- # When the brand was created
274
- #
275
- # @return [Time, nil]
276
- optional :created_at, Time
277
-
278
- # @!attribute csp_id
279
- # @deprecated
280
- #
281
- # Deprecated and scheduled for removal. Identifies the Campaign Service Provider
282
- # that registered the brand, which is Sent, so the value is the same for every
283
- # brand and every account. Nothing on your side can act on it and there is no
284
- # replacement. Stop reading it.
285
- #
286
- # @return [String, nil]
287
- optional :csp_id, String, nil?: true
288
-
289
- # @!attribute identity_status
290
- #
291
- # @return [Symbol, Sentdm::Models::ProfileDetail::Brand::IdentityStatus, nil]
292
- optional :identity_status, enum: -> { Sentdm::ProfileDetail::Brand::IdentityStatus }, nil?: true
293
-
294
- # @!attribute is_inherited
295
- # Whether this brand is inherited from the parent organization
296
- #
297
- # @return [Boolean, nil]
298
- optional :is_inherited, Sentdm::Internal::Type::Boolean
299
-
300
- # @!attribute status
301
- #
302
- # @return [Symbol, Sentdm::Models::ProfileDetail::Brand::Status, nil]
303
- optional :status, enum: -> { Sentdm::ProfileDetail::Brand::Status }, nil?: true
304
-
305
- # @!attribute submitted_at
306
- # When the brand was submitted to TCR
307
- #
308
- # @return [Time, nil]
309
- optional :submitted_at, Time, nil?: true
310
-
311
- # @!attribute submitted_to_tcr
312
- # Whether this brand has been submitted to TCR
313
- #
314
- # @return [Boolean, nil]
315
- optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean
316
-
317
- # @!attribute tcr_brand_id
318
- # TCR brand ID (populated after TCR submission)
319
- #
320
- # @return [String, nil]
321
- optional :tcr_brand_id, String, nil?: true
322
-
323
- # @!attribute universal_ein
324
- # Universal EIN from TCR
325
- #
326
- # @return [String, nil]
327
- optional :universal_ein, String, nil?: true
328
-
329
- # @!attribute updated_at
330
- # When the brand was last updated
331
- #
332
- # @return [Time, nil]
333
- optional :updated_at, Time, nil?: true
334
-
335
- # @!method initialize(id: nil, business: nil, compliance: nil, contact: nil, created_at: nil, csp_id: nil, identity_status: nil, is_inherited: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil)
336
- # Some parameter documentations has been truncated, see
337
- # {Sentdm::Models::ProfileDetail::Brand} for more details.
338
- #
339
- # Brand response with nested contact, business, and compliance sections — mirrors
340
- # the request structure.
341
- #
342
- # @param id [String] Unique identifier for the brand
343
- #
344
- # @param business [Sentdm::Models::ProfileDetail::Brand::Business, nil] Business details and address information
345
- #
346
- # @param compliance [Sentdm::Models::ProfileDetail::Brand::Compliance, nil] Compliance and TCR-related information
347
- #
348
- # @param contact [Sentdm::Models::ProfileDetail::Brand::Contact, nil] Contact information for the brand
349
- #
350
- # @param created_at [Time] When the brand was created
351
- #
352
- # @param csp_id [String, nil] Deprecated and scheduled for removal. Identifies the Campaign Service Provider t
353
- #
354
- # @param identity_status [Symbol, Sentdm::Models::ProfileDetail::Brand::IdentityStatus, nil]
355
- #
356
- # @param is_inherited [Boolean] Whether this brand is inherited from the parent organization
357
- #
358
- # @param status [Symbol, Sentdm::Models::ProfileDetail::Brand::Status, nil]
359
- #
360
- # @param submitted_at [Time, nil] When the brand was submitted to TCR
361
- #
362
- # @param submitted_to_tcr [Boolean] Whether this brand has been submitted to TCR
363
- #
364
- # @param tcr_brand_id [String, nil] TCR brand ID (populated after TCR submission)
365
- #
366
- # @param universal_ein [String, nil] Universal EIN from TCR
367
- #
368
- # @param updated_at [Time, nil] When the brand was last updated
369
-
370
- # @see Sentdm::Models::ProfileDetail::Brand#business
371
- class Business < Sentdm::Internal::Type::BaseModel
372
- # @!attribute city
373
- # City
374
- #
375
- # @return [String, nil]
376
- optional :city, String, nil?: true
377
-
378
- # @!attribute country
379
- # Country code (e.g., US, CA)
380
- #
381
- # @return [String, nil]
382
- optional :country, String, nil?: true
383
-
384
- # @!attribute country_of_registration
385
- # Country where the business is registered
386
- #
387
- # @return [String, nil]
388
- optional :country_of_registration, String, nil?: true
389
-
390
- # @!attribute entity_type
391
- # Business entity type
392
- #
393
- # @return [String, nil]
394
- optional :entity_type, String, nil?: true
395
-
396
- # @!attribute legal_name
397
- # Legal business name
398
- #
399
- # @return [String, nil]
400
- optional :legal_name, String, nil?: true
401
-
402
- # @!attribute postal_code
403
- # Postal/ZIP code
404
- #
405
- # @return [String, nil]
406
- optional :postal_code, String, nil?: true
407
-
408
- # @!attribute state
409
- # State/province code
410
- #
411
- # @return [String, nil]
412
- optional :state, String, nil?: true
413
-
414
- # @!attribute street
415
- # Street address
416
- #
417
- # @return [String, nil]
418
- optional :street, String, nil?: true
419
-
420
- # @!attribute tax_id
421
- # Tax ID/EIN number
422
- #
423
- # @return [String, nil]
424
- optional :tax_id, String, nil?: true
425
-
426
- # @!attribute tax_id_type
427
- # Type of tax ID (e.g., us_ein, ca_bn)
428
- #
429
- # @return [String, nil]
430
- optional :tax_id_type, String, nil?: true
431
-
432
- # @!attribute url
433
- # Business website URL
434
- #
435
- # @return [String, nil]
436
- optional :url, String, nil?: true
437
-
438
- # @!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)
439
- # Business details and address information
440
- #
441
- # @param city [String, nil] City
442
- #
443
- # @param country [String, nil] Country code (e.g., US, CA)
444
- #
445
- # @param country_of_registration [String, nil] Country where the business is registered
446
- #
447
- # @param entity_type [String, nil] Business entity type
448
- #
449
- # @param legal_name [String, nil] Legal business name
450
- #
451
- # @param postal_code [String, nil] Postal/ZIP code
452
- #
453
- # @param state [String, nil] State/province code
454
- #
455
- # @param street [String, nil] Street address
456
- #
457
- # @param tax_id [String, nil] Tax ID/EIN number
458
- #
459
- # @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
460
- #
461
- # @param url [String, nil] Business website URL
462
- end
463
-
464
- # @see Sentdm::Models::ProfileDetail::Brand#compliance
465
- class Compliance < Sentdm::Internal::Type::BaseModel
466
- # @!attribute brand_relationship
467
- #
468
- # @return [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
469
- optional :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, nil?: true
470
-
471
- # @!attribute destination_countries
472
- # List of destination countries for messaging
473
- #
474
- # @return [Array<Sentdm::Models::DestinationCountry>, nil]
475
- optional :destination_countries, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] }
476
-
477
- # @!attribute is_tcr_application
478
- # Whether this is a TCR (Campaign Registry) application
479
- #
480
- # @return [Boolean, nil]
481
- optional :is_tcr_application, Sentdm::Internal::Type::Boolean
482
-
483
- # @!attribute notes
484
- # Additional notes about the business or use case
485
- #
486
- # @return [String, nil]
487
- optional :notes, String, nil?: true
488
-
489
- # @!attribute phone_number_prefix
490
- # Phone number prefix for messaging (e.g., "+1")
491
- #
492
- # @return [String, nil]
493
- optional :phone_number_prefix, String, nil?: true
494
-
495
- # @!attribute primary_use_case
496
- # Primary messaging use case description
497
- #
498
- # @return [String, nil]
499
- optional :primary_use_case, String, nil?: true
500
-
501
- # @!attribute vertical
502
- #
503
- # @return [Symbol, Sentdm::Models::TcrVertical, nil]
504
- optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
505
-
506
- # @!method initialize(brand_relationship: nil, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
507
- # Compliance and TCR-related information
508
- #
509
- # @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
510
- #
511
- # @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
512
- #
513
- # @param is_tcr_application [Boolean] Whether this is a TCR (Campaign Registry) application
514
- #
515
- # @param notes [String, nil] Additional notes about the business or use case
516
- #
517
- # @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
518
- #
519
- # @param primary_use_case [String, nil] Primary messaging use case description
520
- #
521
- # @param vertical [Symbol, Sentdm::Models::TcrVertical, nil]
522
- end
523
-
524
- # @see Sentdm::Models::ProfileDetail::Brand#contact
525
- class Contact < Sentdm::Internal::Type::BaseModel
526
- # @!attribute business_name
527
- # Business/brand name
528
- #
529
- # @return [String, nil]
530
- optional :business_name, String, nil?: true
531
-
532
- # @!attribute email
533
- # Contact email address
534
- #
535
- # @return [String, nil]
536
- optional :email, String, nil?: true
537
-
538
- # @!attribute name
539
- # Primary contact name
540
- #
541
- # @return [String, nil]
542
- optional :name, String
543
-
544
- # @!attribute phone
545
- # Contact phone number in E.164 format
546
- #
547
- # @return [String, nil]
548
- optional :phone, String, nil?: true
549
-
550
- # @!attribute phone_country_code
551
- # Contact phone country code (e.g., "1" for US)
552
- #
553
- # @return [String, nil]
554
- optional :phone_country_code, String, nil?: true
555
-
556
- # @!attribute role
557
- # Contact's role in the business
558
- #
559
- # @return [String, nil]
560
- optional :role, String, nil?: true
561
-
562
- # @!method initialize(business_name: nil, email: nil, name: nil, phone: nil, phone_country_code: nil, role: nil)
563
- # Contact information for the brand
564
- #
565
- # @param business_name [String, nil] Business/brand name
566
- #
567
- # @param email [String, nil] Contact email address
568
- #
569
- # @param name [String] Primary contact name
570
- #
571
- # @param phone [String, nil] Contact phone number in E.164 format
572
- #
573
- # @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
574
- #
575
- # @param role [String, nil] Contact's role in the business
576
- end
577
-
578
- # @see Sentdm::Models::ProfileDetail::Brand#identity_status
579
- module IdentityStatus
580
- extend Sentdm::Internal::Type::Enum
581
-
582
- SELF_DECLARED = :SELF_DECLARED
583
- UNVERIFIED = :UNVERIFIED
584
- VERIFIED = :VERIFIED
585
- VETTED_VERIFIED = :VETTED_VERIFIED
586
-
587
- # @!method self.values
588
- # @return [Array<Symbol>]
589
- end
590
-
591
- # @see Sentdm::Models::ProfileDetail::Brand#status
592
- module Status
593
- extend Sentdm::Internal::Type::Enum
594
-
595
- ACTIVE = :ACTIVE
596
- INACTIVE = :INACTIVE
597
- SUSPENDED = :SUSPENDED
598
-
599
- # @!method self.values
600
- # @return [Array<Symbol>]
601
- end
602
- end
603
- end
604
- end
605
- end
@@ -1,66 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module Sentdm
4
- module Models
5
- class ProfileSettings < Sentdm::Internal::Type::BaseModel
6
- # @!attribute allow_contact_sharing
7
- # Whether contacts are shared across profiles in the organization
8
- #
9
- # @return [Boolean, nil]
10
- optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
11
-
12
- # @!attribute allow_template_sharing
13
- # Whether templates are shared across profiles in the organization
14
- #
15
- # @return [Boolean, nil]
16
- optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
17
-
18
- # @!attribute billing_model
19
- # Billing model: profile, organization, or profile_and_organization
20
- #
21
- # @return [String, nil]
22
- optional :billing_model, String, nil?: true
23
-
24
- # @!attribute inherit_contacts
25
- # Whether this profile inherits contacts from the organization
26
- #
27
- # @return [Boolean, nil]
28
- optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
29
-
30
- # @!attribute inherit_tcr_brand
31
- # Whether this profile inherits TCR brand from the organization
32
- #
33
- # @return [Boolean, nil]
34
- optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
35
-
36
- # @!attribute inherit_tcr_campaign
37
- # Whether this profile inherits TCR campaign from the organization
38
- #
39
- # @return [Boolean, nil]
40
- optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
41
-
42
- # @!attribute inherit_templates
43
- # Whether this profile inherits templates from the organization
44
- #
45
- # @return [Boolean, nil]
46
- optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
47
-
48
- # @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil)
49
- # Profile configuration settings
50
- #
51
- # @param allow_contact_sharing [Boolean, nil] Whether contacts are shared across profiles in the organization
52
- #
53
- # @param allow_template_sharing [Boolean, nil] Whether templates are shared across profiles in the organization
54
- #
55
- # @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization
56
- #
57
- # @param inherit_contacts [Boolean, nil] Whether this profile inherits contacts from the organization
58
- #
59
- # @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from the organization
60
- #
61
- # @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from the organization
62
- #
63
- # @param inherit_templates [Boolean, nil] Whether this profile inherits templates from the organization
64
- end
65
- end
66
- end