sentdm 0.3.1 → 0.4.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 (214) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +8 -0
  3. data/README.md +9 -9
  4. data/lib/sentdm/client.rb +0 -1
  5. data/lib/sentdm/models/api_meta.rb +1 -9
  6. data/lib/sentdm/models/brand_data.rb +235 -198
  7. data/lib/sentdm/models/brand_with_kyc.rb +249 -214
  8. data/lib/sentdm/models/brands/api_response_tcr_campaign_with_use_cases.rb +0 -1
  9. data/lib/sentdm/models/contact_create_params.rb +13 -6
  10. data/lib/sentdm/models/contact_delete_params.rb +8 -1
  11. data/lib/sentdm/models/contact_list_params.rb +10 -2
  12. data/lib/sentdm/models/contact_retrieve_params.rb +7 -1
  13. data/lib/sentdm/models/contact_update_params.rb +13 -6
  14. data/lib/sentdm/models/me_retrieve_params.rb +7 -1
  15. data/lib/sentdm/models/me_retrieve_response.rb +152 -7
  16. data/lib/sentdm/models/message_retrieve_activities_params.rb +7 -1
  17. data/lib/sentdm/models/message_retrieve_activities_response.rb +19 -5
  18. data/lib/sentdm/models/message_retrieve_status_params.rb +7 -1
  19. data/lib/sentdm/models/message_retrieve_status_response.rb +8 -1
  20. data/lib/sentdm/models/message_send_params.rb +17 -10
  21. data/lib/sentdm/models/mutation_request.rb +6 -6
  22. data/lib/sentdm/models/profile_complete_params.rb +13 -6
  23. data/lib/sentdm/models/profile_create_params.rb +192 -10
  24. data/lib/sentdm/models/profile_delete_params.rb +18 -18
  25. data/lib/sentdm/models/profile_detail.rb +144 -95
  26. data/lib/sentdm/models/profile_list_params.rb +7 -1
  27. data/lib/sentdm/models/profile_retrieve_params.rb +7 -1
  28. data/lib/sentdm/models/profile_update_params.rb +142 -22
  29. data/lib/sentdm/models/template_create_params.rb +17 -10
  30. data/lib/sentdm/models/template_delete_params.rb +13 -6
  31. data/lib/sentdm/models/template_list_params.rb +18 -2
  32. data/lib/sentdm/models/template_retrieve_params.rb +7 -1
  33. data/lib/sentdm/models/template_update_params.rb +17 -10
  34. data/lib/sentdm/models/template_variable.rb +7 -1
  35. data/lib/sentdm/models/user_invite_params.rb +13 -6
  36. data/lib/sentdm/models/user_list_params.rb +7 -1
  37. data/lib/sentdm/models/user_remove_params.rb +17 -17
  38. data/lib/sentdm/models/user_retrieve_params.rb +7 -1
  39. data/lib/sentdm/models/user_update_role_params.rb +15 -16
  40. data/lib/sentdm/models/webhook_create_params.rb +13 -6
  41. data/lib/sentdm/models/webhook_delete_params.rb +7 -1
  42. data/lib/sentdm/models/webhook_list_event_types_params.rb +7 -1
  43. data/lib/sentdm/models/webhook_list_events_params.rb +7 -1
  44. data/lib/sentdm/models/webhook_list_params.rb +7 -1
  45. data/lib/sentdm/models/webhook_retrieve_params.rb +7 -1
  46. data/lib/sentdm/models/webhook_rotate_secret_params.rb +7 -1
  47. data/lib/sentdm/models/webhook_test_params.rb +13 -6
  48. data/lib/sentdm/models/webhook_toggle_status_params.rb +13 -6
  49. data/lib/sentdm/models/webhook_update_params.rb +13 -6
  50. data/lib/sentdm/models.rb +0 -12
  51. data/lib/sentdm/resources/brands/campaigns.rb +0 -129
  52. data/lib/sentdm/resources/brands.rb +0 -112
  53. data/lib/sentdm/resources/contacts.rb +43 -20
  54. data/lib/sentdm/resources/lookup.rb +0 -21
  55. data/lib/sentdm/resources/me.rb +24 -5
  56. data/lib/sentdm/resources/messages.rb +24 -8
  57. data/lib/sentdm/resources/profiles.rb +116 -32
  58. data/lib/sentdm/resources/templates.rb +47 -24
  59. data/lib/sentdm/resources/users.rb +40 -23
  60. data/lib/sentdm/resources/webhooks.rb +92 -34
  61. data/lib/sentdm/version.rb +1 -1
  62. data/lib/sentdm.rb +1 -14
  63. data/rbi/sentdm/client.rbi +0 -1
  64. data/rbi/sentdm/models/api_meta.rbi +4 -18
  65. data/rbi/sentdm/models/brand_data.rbi +326 -203
  66. data/rbi/sentdm/models/brand_with_kyc.rbi +334 -216
  67. data/rbi/sentdm/models/brands/tcr_campaign_with_use_cases.rbi +6 -8
  68. data/rbi/sentdm/models/contact_create_params.rbi +19 -10
  69. data/rbi/sentdm/models/contact_delete_params.rbi +9 -0
  70. data/rbi/sentdm/models/contact_list_params.rbi +11 -0
  71. data/rbi/sentdm/models/contact_retrieve_params.rbi +13 -2
  72. data/rbi/sentdm/models/contact_update_params.rbi +19 -10
  73. data/rbi/sentdm/models/me_retrieve_params.rbi +16 -5
  74. data/rbi/sentdm/models/me_retrieve_response.rbi +316 -16
  75. data/rbi/sentdm/models/message_retrieve_activities_params.rbi +13 -2
  76. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +18 -6
  77. data/rbi/sentdm/models/message_retrieve_status_params.rbi +13 -2
  78. data/rbi/sentdm/models/message_retrieve_status_response.rbi +6 -0
  79. data/rbi/sentdm/models/message_send_params.rbi +22 -13
  80. data/rbi/sentdm/models/mutation_request.rbi +10 -10
  81. data/rbi/sentdm/models/profile_complete_params.rbi +19 -10
  82. data/rbi/sentdm/models/profile_create_params.rbi +323 -15
  83. data/rbi/sentdm/models/profile_delete_params.rbi +36 -24
  84. data/rbi/sentdm/models/profile_detail.rbi +184 -128
  85. data/rbi/sentdm/models/profile_list_params.rbi +16 -5
  86. data/rbi/sentdm/models/profile_retrieve_params.rbi +13 -2
  87. data/rbi/sentdm/models/profile_update_params.rbi +231 -30
  88. data/rbi/sentdm/models/template_create_params.rbi +22 -13
  89. data/rbi/sentdm/models/template_delete_params.rbi +19 -10
  90. data/rbi/sentdm/models/template_list_params.rbi +19 -0
  91. data/rbi/sentdm/models/template_retrieve_params.rbi +13 -2
  92. data/rbi/sentdm/models/template_update_params.rbi +22 -13
  93. data/rbi/sentdm/models/template_variable.rbi +6 -0
  94. data/rbi/sentdm/models/user_invite_params.rbi +19 -10
  95. data/rbi/sentdm/models/user_list_params.rbi +16 -5
  96. data/rbi/sentdm/models/user_remove_params.rbi +35 -23
  97. data/rbi/sentdm/models/user_retrieve_params.rbi +13 -2
  98. data/rbi/sentdm/models/user_update_role_params.rbi +23 -25
  99. data/rbi/sentdm/models/webhook_create_params.rbi +19 -10
  100. data/rbi/sentdm/models/webhook_delete_params.rbi +13 -2
  101. data/rbi/sentdm/models/webhook_list_event_types_params.rbi +16 -5
  102. data/rbi/sentdm/models/webhook_list_events_params.rbi +16 -1
  103. data/rbi/sentdm/models/webhook_list_params.rbi +9 -0
  104. data/rbi/sentdm/models/webhook_retrieve_params.rbi +13 -2
  105. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +15 -1
  106. data/rbi/sentdm/models/webhook_test_params.rbi +19 -10
  107. data/rbi/sentdm/models/webhook_toggle_status_params.rbi +19 -10
  108. data/rbi/sentdm/models/webhook_update_params.rbi +19 -10
  109. data/rbi/sentdm/models.rbi +0 -12
  110. data/rbi/sentdm/resources/brands/campaigns.rbi +0 -95
  111. data/rbi/sentdm/resources/brands.rbi +0 -80
  112. data/rbi/sentdm/resources/contacts.rbi +37 -12
  113. data/rbi/sentdm/resources/lookup.rbi +0 -12
  114. data/rbi/sentdm/resources/me.rbi +25 -7
  115. data/rbi/sentdm/resources/messages.rbi +17 -4
  116. data/rbi/sentdm/resources/profiles.rbi +178 -38
  117. data/rbi/sentdm/resources/templates.rbi +47 -19
  118. data/rbi/sentdm/resources/users.rbi +47 -25
  119. data/rbi/sentdm/resources/webhooks.rbi +92 -20
  120. data/sig/sentdm/models/api_meta.rbs +2 -16
  121. data/sig/sentdm/models/brand_data.rbs +188 -142
  122. data/sig/sentdm/models/brand_with_kyc.rbs +184 -133
  123. data/sig/sentdm/models/contact_create_params.rbs +16 -5
  124. data/sig/sentdm/models/contact_delete_params.rbs +11 -1
  125. data/sig/sentdm/models/contact_list_params.rbs +8 -1
  126. data/sig/sentdm/models/contact_retrieve_params.rbs +12 -2
  127. data/sig/sentdm/models/contact_update_params.rbs +13 -6
  128. data/sig/sentdm/models/me_retrieve_params.rbs +14 -3
  129. data/sig/sentdm/models/me_retrieve_response.rbs +134 -7
  130. data/sig/sentdm/models/message_retrieve_activities_params.rbs +12 -2
  131. data/sig/sentdm/models/message_retrieve_activities_response.rbs +9 -4
  132. data/sig/sentdm/models/message_retrieve_status_params.rbs +12 -2
  133. data/sig/sentdm/models/message_retrieve_status_response.rbs +5 -0
  134. data/sig/sentdm/models/message_send_params.rbs +15 -8
  135. data/sig/sentdm/models/mutation_request.rbs +5 -5
  136. data/sig/sentdm/models/profile_complete_params.rbs +13 -6
  137. data/sig/sentdm/models/profile_create_params.rbs +111 -7
  138. data/sig/sentdm/models/profile_delete_params.rbs +23 -13
  139. data/sig/sentdm/models/profile_detail.rbs +105 -84
  140. data/sig/sentdm/models/profile_list_params.rbs +14 -3
  141. data/sig/sentdm/models/profile_retrieve_params.rbs +8 -1
  142. data/sig/sentdm/models/profile_update_params.rbs +86 -17
  143. data/sig/sentdm/models/template_create_params.rbs +15 -8
  144. data/sig/sentdm/models/template_delete_params.rbs +16 -5
  145. data/sig/sentdm/models/template_list_params.rbs +13 -1
  146. data/sig/sentdm/models/template_retrieve_params.rbs +12 -2
  147. data/sig/sentdm/models/template_update_params.rbs +15 -8
  148. data/sig/sentdm/models/template_variable.rbs +5 -0
  149. data/sig/sentdm/models/user_invite_params.rbs +13 -6
  150. data/sig/sentdm/models/user_list_params.rbs +14 -3
  151. data/sig/sentdm/models/user_remove_params.rbs +23 -13
  152. data/sig/sentdm/models/user_retrieve_params.rbs +8 -1
  153. data/sig/sentdm/models/user_update_role_params.rbs +17 -17
  154. data/sig/sentdm/models/webhook_create_params.rbs +13 -6
  155. data/sig/sentdm/models/webhook_delete_params.rbs +12 -2
  156. data/sig/sentdm/models/webhook_list_event_types_params.rbs +13 -3
  157. data/sig/sentdm/models/webhook_list_events_params.rbs +13 -1
  158. data/sig/sentdm/models/webhook_list_params.rbs +13 -1
  159. data/sig/sentdm/models/webhook_retrieve_params.rbs +12 -2
  160. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +8 -1
  161. data/sig/sentdm/models/webhook_test_params.rbs +13 -6
  162. data/sig/sentdm/models/webhook_toggle_status_params.rbs +17 -5
  163. data/sig/sentdm/models/webhook_update_params.rbs +13 -6
  164. data/sig/sentdm/models.rbs +0 -12
  165. data/sig/sentdm/resources/brands/campaigns.rbs +0 -29
  166. data/sig/sentdm/resources/brands.rbs +0 -25
  167. data/sig/sentdm/resources/contacts.rbs +7 -2
  168. data/sig/sentdm/resources/lookup.rbs +0 -5
  169. data/sig/sentdm/resources/me.rbs +1 -0
  170. data/sig/sentdm/resources/messages.rbs +4 -1
  171. data/sig/sentdm/resources/profiles.rbs +19 -8
  172. data/sig/sentdm/resources/templates.rbs +9 -3
  173. data/sig/sentdm/resources/users.rbs +10 -7
  174. data/sig/sentdm/resources/webhooks.rbs +18 -5
  175. metadata +1 -40
  176. data/lib/sentdm/models/api_response_brand_with_kyc.rb +0 -43
  177. data/lib/sentdm/models/brand_create_params.rb +0 -41
  178. data/lib/sentdm/models/brand_delete_params.rb +0 -34
  179. data/lib/sentdm/models/brand_list_params.rb +0 -14
  180. data/lib/sentdm/models/brand_list_response.rb +0 -43
  181. data/lib/sentdm/models/brand_update_params.rb +0 -48
  182. data/lib/sentdm/models/brands/campaign_create_params.rb +0 -50
  183. data/lib/sentdm/models/brands/campaign_delete_params.rb +0 -43
  184. data/lib/sentdm/models/brands/campaign_list_params.rb +0 -22
  185. data/lib/sentdm/models/brands/campaign_list_response.rb +0 -47
  186. data/lib/sentdm/models/brands/campaign_update_params.rb +0 -57
  187. data/lib/sentdm/models/lookup_retrieve_phone_info_params.rb +0 -20
  188. data/lib/sentdm/models/lookup_retrieve_phone_info_response.rb +0 -104
  189. data/rbi/sentdm/models/api_response_brand_with_kyc.rbi +0 -74
  190. data/rbi/sentdm/models/brand_create_params.rbi +0 -68
  191. data/rbi/sentdm/models/brand_delete_params.rbi +0 -68
  192. data/rbi/sentdm/models/brand_list_params.rbi +0 -27
  193. data/rbi/sentdm/models/brand_list_response.rbi +0 -71
  194. data/rbi/sentdm/models/brand_update_params.rbi +0 -74
  195. data/rbi/sentdm/models/brands/campaign_create_params.rbi +0 -79
  196. data/rbi/sentdm/models/brands/campaign_delete_params.rbi +0 -84
  197. data/rbi/sentdm/models/brands/campaign_list_params.rbi +0 -37
  198. data/rbi/sentdm/models/brands/campaign_list_response.rbi +0 -82
  199. data/rbi/sentdm/models/brands/campaign_update_params.rbi +0 -85
  200. data/rbi/sentdm/models/lookup_retrieve_phone_info_params.rbi +0 -38
  201. data/rbi/sentdm/models/lookup_retrieve_phone_info_response.rbi +0 -183
  202. data/sig/sentdm/models/api_response_brand_with_kyc.rbs +0 -39
  203. data/sig/sentdm/models/brand_create_params.rbs +0 -36
  204. data/sig/sentdm/models/brand_delete_params.rbs +0 -36
  205. data/sig/sentdm/models/brand_list_params.rbs +0 -14
  206. data/sig/sentdm/models/brand_list_response.rbs +0 -39
  207. data/sig/sentdm/models/brand_update_params.rbs +0 -45
  208. data/sig/sentdm/models/brands/campaign_create_params.rbs +0 -47
  209. data/sig/sentdm/models/brands/campaign_delete_params.rbs +0 -46
  210. data/sig/sentdm/models/brands/campaign_list_params.rbs +0 -25
  211. data/sig/sentdm/models/brands/campaign_list_response.rbs +0 -41
  212. data/sig/sentdm/models/brands/campaign_update_params.rbs +0 -52
  213. data/sig/sentdm/models/lookup_retrieve_phone_info_params.rbs +0 -23
  214. data/sig/sentdm/models/lookup_retrieve_phone_info_response.rbs +0 -102
@@ -9,163 +9,47 @@ module Sentdm
9
9
  # @return [String, nil]
10
10
  optional :id, String
11
11
 
12
- # @!attribute brand_relationship
13
- # Brand relationship level with TCR
12
+ # @!attribute business
13
+ # Business details and address information
14
14
  #
15
- # @return [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
16
- optional :brand_relationship,
17
- enum: -> { Sentdm::TcrBrandRelationship },
18
- api_name: :brandRelationship,
19
- nil?: true
20
-
21
- # @!attribute business_legal_name
22
- # Legal business name
23
- #
24
- # @return [String, nil]
25
- optional :business_legal_name, String, api_name: :businessLegalName, nil?: true
26
-
27
- # @!attribute business_name
28
- # Business/brand name
29
- #
30
- # @return [String, nil]
31
- optional :business_name, String, api_name: :businessName, nil?: true
32
-
33
- # @!attribute business_role
34
- # Contact's role in the business
35
- #
36
- # @return [String, nil]
37
- optional :business_role, String, api_name: :businessRole, nil?: true
38
-
39
- # @!attribute business_url
40
- # Business website URL
41
- #
42
- # @return [String, nil]
43
- optional :business_url, String, api_name: :businessUrl, nil?: true
44
-
45
- # @!attribute city
46
- # City
47
- #
48
- # @return [String, nil]
49
- optional :city, String, nil?: true
50
-
51
- # @!attribute contact_email
52
- # Contact email address
53
- #
54
- # @return [String, nil]
55
- optional :contact_email, String, api_name: :contactEmail, nil?: true
56
-
57
- # @!attribute contact_name
58
- # Primary contact name
59
- #
60
- # @return [String, nil]
61
- optional :contact_name, String, api_name: :contactName
15
+ # @return [Sentdm::Models::BrandWithKYC::Business, nil]
16
+ optional :business, -> { Sentdm::BrandWithKYC::Business }, nil?: true
62
17
 
63
- # @!attribute contact_phone
64
- # Contact phone number
18
+ # @!attribute compliance
19
+ # Compliance and TCR-related information
65
20
  #
66
- # @return [String, nil]
67
- optional :contact_phone, String, api_name: :contactPhone, nil?: true
21
+ # @return [Sentdm::Models::BrandWithKYC::Compliance, nil]
22
+ optional :compliance, -> { Sentdm::BrandWithKYC::Compliance }, nil?: true
68
23
 
69
- # @!attribute contact_phone_country_code
70
- # Contact phone country code
24
+ # @!attribute contact
25
+ # Contact information for the brand
71
26
  #
72
- # @return [String, nil]
73
- optional :contact_phone_country_code, String, api_name: :contactPhoneCountryCode, nil?: true
74
-
75
- # @!attribute country
76
- # Country code
77
- #
78
- # @return [String, nil]
79
- optional :country, String, nil?: true
80
-
81
- # @!attribute country_of_registration
82
- # Country where the business is registered
83
- #
84
- # @return [String, nil]
85
- optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
27
+ # @return [Sentdm::Models::BrandWithKYC::Contact, nil]
28
+ optional :contact, -> { Sentdm::BrandWithKYC::Contact }, nil?: true
86
29
 
87
30
  # @!attribute created_at
88
31
  # When the brand was created
89
32
  #
90
33
  # @return [Time, nil]
91
- optional :created_at, Time, api_name: :createdAt
34
+ optional :created_at, Time
92
35
 
93
36
  # @!attribute csp_id
94
37
  # CSP (Campaign Service Provider) ID
95
38
  #
96
39
  # @return [String, nil]
97
- optional :csp_id, String, api_name: :cspId, nil?: true
98
-
99
- # @!attribute destination_countries
100
- # List of destination countries for messaging
101
- #
102
- # @return [Array<Sentdm::Models::DestinationCountry>, nil]
103
- optional :destination_countries,
104
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
105
- api_name: :destinationCountries
106
-
107
- # @!attribute entity_type
108
- # Business entity type
109
- #
110
- # @return [String, nil]
111
- optional :entity_type, String, api_name: :entityType, nil?: true
112
-
113
- # @!attribute expected_messaging_volume
114
- # Expected daily messaging volume
115
- #
116
- # @return [String, nil]
117
- optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
40
+ optional :csp_id, String, nil?: true
118
41
 
119
42
  # @!attribute identity_status
120
43
  # TCR brand identity verification status
121
44
  #
122
45
  # @return [Symbol, Sentdm::Models::BrandWithKYC::IdentityStatus, nil]
123
- optional :identity_status,
124
- enum: -> { Sentdm::BrandWithKYC::IdentityStatus },
125
- api_name: :identityStatus,
126
- nil?: true
46
+ optional :identity_status, enum: -> { Sentdm::BrandWithKYC::IdentityStatus }, nil?: true
127
47
 
128
48
  # @!attribute is_inherited
129
- # Whether this brand is inherited from parent organization
49
+ # Whether this brand is inherited from the parent organization
130
50
  #
131
51
  # @return [Boolean, nil]
132
- optional :is_inherited, Sentdm::Internal::Type::Boolean, api_name: :isInherited
133
-
134
- # @!attribute is_tcr_application
135
- # Whether this is a TCR application
136
- #
137
- # @return [Boolean, nil]
138
- optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication
139
-
140
- # @!attribute notes
141
- # Additional notes
142
- #
143
- # @return [String, nil]
144
- optional :notes, String, nil?: true
145
-
146
- # @!attribute phone_number_prefix
147
- # Phone number prefix for messaging
148
- #
149
- # @return [String, nil]
150
- optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
151
-
152
- # @!attribute postal_code
153
- # Postal/ZIP code
154
- #
155
- # @return [String, nil]
156
- optional :postal_code, String, api_name: :postalCode, nil?: true
157
-
158
- # @!attribute primary_use_case
159
- # Primary messaging use case description
160
- #
161
- # @return [String, nil]
162
- optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
163
-
164
- # @!attribute state
165
- # State/province code
166
- #
167
- # @return [String, nil]
168
- optional :state, String, nil?: true
52
+ optional :is_inherited, Sentdm::Internal::Type::Boolean
169
53
 
170
54
  # @!attribute status
171
55
  # TCR brand status
@@ -173,134 +57,285 @@ module Sentdm
173
57
  # @return [Symbol, Sentdm::Models::BrandWithKYC::Status, nil]
174
58
  optional :status, enum: -> { Sentdm::BrandWithKYC::Status }, nil?: true
175
59
 
176
- # @!attribute street
177
- # Street address
178
- #
179
- # @return [String, nil]
180
- optional :street, String, nil?: true
181
-
182
60
  # @!attribute submitted_at
183
61
  # When the brand was submitted to TCR
184
62
  #
185
63
  # @return [Time, nil]
186
- optional :submitted_at, Time, api_name: :submittedAt, nil?: true
64
+ optional :submitted_at, Time, nil?: true
187
65
 
188
66
  # @!attribute submitted_to_tcr
189
- # Whether this brand was submitted to TCR
67
+ # Whether this brand has been submitted to TCR
190
68
  #
191
69
  # @return [Boolean, nil]
192
- optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR
193
-
194
- # @!attribute tax_id
195
- # Tax ID/EIN number
196
- #
197
- # @return [String, nil]
198
- optional :tax_id, String, api_name: :taxId, nil?: true
199
-
200
- # @!attribute tax_id_type
201
- # Type of tax ID
202
- #
203
- # @return [String, nil]
204
- optional :tax_id_type, String, api_name: :taxIdType, nil?: true
70
+ optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean
205
71
 
206
72
  # @!attribute tcr_brand_id
207
73
  # TCR brand ID (populated after TCR submission)
208
74
  #
209
75
  # @return [String, nil]
210
- optional :tcr_brand_id, String, api_name: :tcrBrandId, nil?: true
76
+ optional :tcr_brand_id, String, nil?: true
211
77
 
212
78
  # @!attribute universal_ein
213
79
  # Universal EIN from TCR
214
80
  #
215
81
  # @return [String, nil]
216
- optional :universal_ein, String, api_name: :universalEin, nil?: true
82
+ optional :universal_ein, String, nil?: true
217
83
 
218
84
  # @!attribute updated_at
219
85
  # When the brand was last updated
220
86
  #
221
87
  # @return [Time, nil]
222
- optional :updated_at, Time, api_name: :updatedAt, nil?: true
223
-
224
- # @!attribute vertical
225
- # Business vertical/industry category
226
- #
227
- # @return [Symbol, Sentdm::Models::TcrVertical, nil]
228
- optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
88
+ optional :updated_at, Time, nil?: true
229
89
 
230
- # @!method initialize(id: nil, brand_relationship: nil, business_legal_name: nil, business_name: nil, business_role: nil, business_url: nil, city: nil, contact_email: nil, contact_name: nil, contact_phone: nil, contact_phone_country_code: nil, country: nil, country_of_registration: nil, created_at: nil, csp_id: nil, destination_countries: nil, entity_type: nil, expected_messaging_volume: nil, identity_status: nil, is_inherited: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, postal_code: nil, primary_use_case: nil, state: nil, status: nil, street: nil, submitted_at: nil, submitted_to_tcr: nil, tax_id: nil, tax_id_type: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil, vertical: nil)
231
- # Flattened brand response with embedded KYC information
90
+ # @!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)
91
+ # Brand response with nested contact, business, and compliance sections — mirrors
92
+ # the request structure.
232
93
  #
233
94
  # @param id [String] Unique identifier for the brand
234
95
  #
235
- # @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil] Brand relationship level with TCR
236
- #
237
- # @param business_legal_name [String, nil] Legal business name
238
- #
239
- # @param business_name [String, nil] Business/brand name
240
- #
241
- # @param business_role [String, nil] Contact's role in the business
242
- #
243
- # @param business_url [String, nil] Business website URL
244
- #
245
- # @param city [String, nil] City
96
+ # @param business [Sentdm::Models::BrandWithKYC::Business, nil] Business details and address information
246
97
  #
247
- # @param contact_email [String, nil] Contact email address
98
+ # @param compliance [Sentdm::Models::BrandWithKYC::Compliance, nil] Compliance and TCR-related information
248
99
  #
249
- # @param contact_name [String] Primary contact name
250
- #
251
- # @param contact_phone [String, nil] Contact phone number
252
- #
253
- # @param contact_phone_country_code [String, nil] Contact phone country code
254
- #
255
- # @param country [String, nil] Country code
256
- #
257
- # @param country_of_registration [String, nil] Country where the business is registered
100
+ # @param contact [Sentdm::Models::BrandWithKYC::Contact, nil] Contact information for the brand
258
101
  #
259
102
  # @param created_at [Time] When the brand was created
260
103
  #
261
104
  # @param csp_id [String, nil] CSP (Campaign Service Provider) ID
262
105
  #
263
- # @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
264
- #
265
- # @param entity_type [String, nil] Business entity type
266
- #
267
- # @param expected_messaging_volume [String, nil] Expected daily messaging volume
268
- #
269
106
  # @param identity_status [Symbol, Sentdm::Models::BrandWithKYC::IdentityStatus, nil] TCR brand identity verification status
270
107
  #
271
- # @param is_inherited [Boolean] Whether this brand is inherited from parent organization
272
- #
273
- # @param is_tcr_application [Boolean] Whether this is a TCR application
274
- #
275
- # @param notes [String, nil] Additional notes
276
- #
277
- # @param phone_number_prefix [String, nil] Phone number prefix for messaging
278
- #
279
- # @param postal_code [String, nil] Postal/ZIP code
280
- #
281
- # @param primary_use_case [String, nil] Primary messaging use case description
282
- #
283
- # @param state [String, nil] State/province code
108
+ # @param is_inherited [Boolean] Whether this brand is inherited from the parent organization
284
109
  #
285
110
  # @param status [Symbol, Sentdm::Models::BrandWithKYC::Status, nil] TCR brand status
286
111
  #
287
- # @param street [String, nil] Street address
288
- #
289
112
  # @param submitted_at [Time, nil] When the brand was submitted to TCR
290
113
  #
291
- # @param submitted_to_tcr [Boolean] Whether this brand was submitted to TCR
292
- #
293
- # @param tax_id [String, nil] Tax ID/EIN number
294
- #
295
- # @param tax_id_type [String, nil] Type of tax ID
114
+ # @param submitted_to_tcr [Boolean] Whether this brand has been submitted to TCR
296
115
  #
297
116
  # @param tcr_brand_id [String, nil] TCR brand ID (populated after TCR submission)
298
117
  #
299
118
  # @param universal_ein [String, nil] Universal EIN from TCR
300
119
  #
301
120
  # @param updated_at [Time, nil] When the brand was last updated
302
- #
303
- # @param vertical [Symbol, Sentdm::Models::TcrVertical, nil] Business vertical/industry category
121
+
122
+ # @see Sentdm::Models::BrandWithKYC#business
123
+ class Business < Sentdm::Internal::Type::BaseModel
124
+ # @!attribute city
125
+ # City
126
+ #
127
+ # @return [String, nil]
128
+ optional :city, String, nil?: true
129
+
130
+ # @!attribute country
131
+ # Country code (e.g., US, CA)
132
+ #
133
+ # @return [String, nil]
134
+ optional :country, String, nil?: true
135
+
136
+ # @!attribute country_of_registration
137
+ # Country where the business is registered
138
+ #
139
+ # @return [String, nil]
140
+ optional :country_of_registration, String, nil?: true
141
+
142
+ # @!attribute entity_type
143
+ # Business entity type
144
+ #
145
+ # @return [String, nil]
146
+ optional :entity_type, String, nil?: true
147
+
148
+ # @!attribute legal_name
149
+ # Legal business name
150
+ #
151
+ # @return [String, nil]
152
+ optional :legal_name, String, nil?: true
153
+
154
+ # @!attribute postal_code
155
+ # Postal/ZIP code
156
+ #
157
+ # @return [String, nil]
158
+ optional :postal_code, String, nil?: true
159
+
160
+ # @!attribute state
161
+ # State/province code
162
+ #
163
+ # @return [String, nil]
164
+ optional :state, String, nil?: true
165
+
166
+ # @!attribute street
167
+ # Street address
168
+ #
169
+ # @return [String, nil]
170
+ optional :street, String, nil?: true
171
+
172
+ # @!attribute tax_id
173
+ # Tax ID/EIN number
174
+ #
175
+ # @return [String, nil]
176
+ optional :tax_id, String, nil?: true
177
+
178
+ # @!attribute tax_id_type
179
+ # Type of tax ID (e.g., us_ein, ca_bn)
180
+ #
181
+ # @return [String, nil]
182
+ optional :tax_id_type, String, nil?: true
183
+
184
+ # @!attribute url
185
+ # Business website URL
186
+ #
187
+ # @return [String, nil]
188
+ optional :url, String, nil?: true
189
+
190
+ # @!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)
191
+ # Business details and address information
192
+ #
193
+ # @param city [String, nil] City
194
+ #
195
+ # @param country [String, nil] Country code (e.g., US, CA)
196
+ #
197
+ # @param country_of_registration [String, nil] Country where the business is registered
198
+ #
199
+ # @param entity_type [String, nil] Business entity type
200
+ #
201
+ # @param legal_name [String, nil] Legal business name
202
+ #
203
+ # @param postal_code [String, nil] Postal/ZIP code
204
+ #
205
+ # @param state [String, nil] State/province code
206
+ #
207
+ # @param street [String, nil] Street address
208
+ #
209
+ # @param tax_id [String, nil] Tax ID/EIN number
210
+ #
211
+ # @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
212
+ #
213
+ # @param url [String, nil] Business website URL
214
+ end
215
+
216
+ # @see Sentdm::Models::BrandWithKYC#compliance
217
+ class Compliance < Sentdm::Internal::Type::BaseModel
218
+ # @!attribute brand_relationship
219
+ # Brand relationship level with TCR
220
+ #
221
+ # @return [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
222
+ optional :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, nil?: true
223
+
224
+ # @!attribute destination_countries
225
+ # List of destination countries for messaging
226
+ #
227
+ # @return [Array<Sentdm::Models::DestinationCountry>, nil]
228
+ optional :destination_countries, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] }
229
+
230
+ # @!attribute expected_messaging_volume
231
+ # Expected daily messaging volume
232
+ #
233
+ # @return [String, nil]
234
+ optional :expected_messaging_volume, String, nil?: true
235
+
236
+ # @!attribute is_tcr_application
237
+ # Whether this is a TCR (Campaign Registry) application
238
+ #
239
+ # @return [Boolean, nil]
240
+ optional :is_tcr_application, Sentdm::Internal::Type::Boolean
241
+
242
+ # @!attribute notes
243
+ # Additional notes about the business or use case
244
+ #
245
+ # @return [String, nil]
246
+ optional :notes, String, nil?: true
247
+
248
+ # @!attribute phone_number_prefix
249
+ # Phone number prefix for messaging (e.g., "+1")
250
+ #
251
+ # @return [String, nil]
252
+ optional :phone_number_prefix, String, nil?: true
253
+
254
+ # @!attribute primary_use_case
255
+ # Primary messaging use case description
256
+ #
257
+ # @return [String, nil]
258
+ optional :primary_use_case, String, nil?: true
259
+
260
+ # @!attribute vertical
261
+ # Business vertical/industry category
262
+ #
263
+ # @return [Symbol, Sentdm::Models::TcrVertical, nil]
264
+ optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
265
+
266
+ # @!method initialize(brand_relationship: nil, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
267
+ # Compliance and TCR-related information
268
+ #
269
+ # @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil] Brand relationship level with TCR
270
+ #
271
+ # @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
272
+ #
273
+ # @param expected_messaging_volume [String, nil] Expected daily messaging volume
274
+ #
275
+ # @param is_tcr_application [Boolean] Whether this is a TCR (Campaign Registry) application
276
+ #
277
+ # @param notes [String, nil] Additional notes about the business or use case
278
+ #
279
+ # @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
280
+ #
281
+ # @param primary_use_case [String, nil] Primary messaging use case description
282
+ #
283
+ # @param vertical [Symbol, Sentdm::Models::TcrVertical, nil] Business vertical/industry category
284
+ end
285
+
286
+ # @see Sentdm::Models::BrandWithKYC#contact
287
+ class Contact < Sentdm::Internal::Type::BaseModel
288
+ # @!attribute business_name
289
+ # Business/brand name
290
+ #
291
+ # @return [String, nil]
292
+ optional :business_name, String, nil?: true
293
+
294
+ # @!attribute email
295
+ # Contact email address
296
+ #
297
+ # @return [String, nil]
298
+ optional :email, String, nil?: true
299
+
300
+ # @!attribute name
301
+ # Primary contact name
302
+ #
303
+ # @return [String, nil]
304
+ optional :name, String
305
+
306
+ # @!attribute phone
307
+ # Contact phone number in E.164 format
308
+ #
309
+ # @return [String, nil]
310
+ optional :phone, String, nil?: true
311
+
312
+ # @!attribute phone_country_code
313
+ # Contact phone country code (e.g., "1" for US)
314
+ #
315
+ # @return [String, nil]
316
+ optional :phone_country_code, String, nil?: true
317
+
318
+ # @!attribute role
319
+ # Contact's role in the business
320
+ #
321
+ # @return [String, nil]
322
+ optional :role, String, nil?: true
323
+
324
+ # @!method initialize(business_name: nil, email: nil, name: nil, phone: nil, phone_country_code: nil, role: nil)
325
+ # Contact information for the brand
326
+ #
327
+ # @param business_name [String, nil] Business/brand name
328
+ #
329
+ # @param email [String, nil] Contact email address
330
+ #
331
+ # @param name [String] Primary contact name
332
+ #
333
+ # @param phone [String, nil] Contact phone number in E.164 format
334
+ #
335
+ # @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
336
+ #
337
+ # @param role [String, nil] Contact's role in the business
338
+ end
304
339
 
305
340
  # TCR brand identity verification status
306
341
  #
@@ -3,7 +3,6 @@
3
3
  module Sentdm
4
4
  module Models
5
5
  module Brands
6
- # @see Sentdm::Resources::Brands::Campaigns#create
7
6
  class APIResponseTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
8
7
  # @!attribute data
9
8
  # The response data (null if error)
@@ -13,28 +13,35 @@ module Sentdm
13
13
  # @return [String, nil]
14
14
  optional :phone_number, String
15
15
 
16
- # @!attribute test_mode
17
- # Test mode flag - when true, the operation is simulated without side effects
18
- # Useful for testing integrations without actual execution
16
+ # @!attribute sandbox
17
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
18
+ # for testing integrations without actual execution
19
19
  #
20
20
  # @return [Boolean, nil]
21
- optional :test_mode, Sentdm::Internal::Type::Boolean
21
+ optional :sandbox, Sentdm::Internal::Type::Boolean
22
22
 
23
23
  # @!attribute idempotency_key
24
24
  #
25
25
  # @return [String, nil]
26
26
  optional :idempotency_key, String
27
27
 
28
- # @!method initialize(phone_number: nil, test_mode: nil, idempotency_key: nil, request_options: {})
28
+ # @!attribute x_profile_id
29
+ #
30
+ # @return [String, nil]
31
+ optional :x_profile_id, String
32
+
33
+ # @!method initialize(phone_number: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
29
34
  # Some parameter documentations has been truncated, see
30
35
  # {Sentdm::Models::ContactCreateParams} for more details.
31
36
  #
32
37
  # @param phone_number [String] Phone number of the contact to create
33
38
  #
34
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
39
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
35
40
  #
36
41
  # @param idempotency_key [String]
37
42
  #
43
+ # @param x_profile_id [String]
44
+ #
38
45
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
39
46
  end
40
47
  end
@@ -18,11 +18,18 @@ module Sentdm
18
18
  # @return [Sentdm::Models::ContactDeleteParams::Body]
19
19
  required :body, -> { Sentdm::ContactDeleteParams::Body }
20
20
 
21
- # @!method initialize(id:, body:, request_options: {})
21
+ # @!attribute x_profile_id
22
+ #
23
+ # @return [String, nil]
24
+ optional :x_profile_id, String
25
+
26
+ # @!method initialize(id:, body:, x_profile_id: nil, request_options: {})
22
27
  # @param id [String]
23
28
  #
24
29
  # @param body [Sentdm::Models::ContactDeleteParams::Body] Request to delete/dissociate a contact
25
30
  #
31
+ # @param x_profile_id [String]
32
+ #
26
33
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
27
34
 
28
35
  class Body < Sentdm::Models::MutationRequest
@@ -14,6 +14,7 @@ module Sentdm
14
14
  required :page, Integer
15
15
 
16
16
  # @!attribute page_size
17
+ # Number of items per page
17
18
  #
18
19
  # @return [Integer]
19
20
  required :page_size, Integer
@@ -36,10 +37,15 @@ module Sentdm
36
37
  # @return [String, nil]
37
38
  optional :search, String, nil?: true
38
39
 
39
- # @!method initialize(page:, page_size:, channel: nil, phone: nil, search: nil, request_options: {})
40
+ # @!attribute x_profile_id
41
+ #
42
+ # @return [String, nil]
43
+ optional :x_profile_id, String
44
+
45
+ # @!method initialize(page:, page_size:, channel: nil, phone: nil, search: nil, x_profile_id: nil, request_options: {})
40
46
  # @param page [Integer] Page number (1-indexed)
41
47
  #
42
- # @param page_size [Integer]
48
+ # @param page_size [Integer] Number of items per page
43
49
  #
44
50
  # @param channel [String, nil] Optional channel filter (sms, whatsapp)
45
51
  #
@@ -47,6 +53,8 @@ module Sentdm
47
53
  #
48
54
  # @param search [String, nil] Optional search term for filtering contacts
49
55
  #
56
+ # @param x_profile_id [String]
57
+ #
50
58
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
51
59
  end
52
60
  end
@@ -12,8 +12,14 @@ module Sentdm
12
12
  # @return [String]
13
13
  required :id, String
14
14
 
15
- # @!method initialize(id:, request_options: {})
15
+ # @!attribute x_profile_id
16
+ #
17
+ # @return [String, nil]
18
+ optional :x_profile_id, String
19
+
20
+ # @!method initialize(id:, x_profile_id: nil, request_options: {})
16
21
  # @param id [String]
22
+ # @param x_profile_id [String]
17
23
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
18
24
  end
19
25
  end