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
@@ -7,10 +7,10 @@ module Sentdm
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
10
- # @!attribute path_user_id
10
+ # @!attribute user_id
11
11
  #
12
12
  # @return [String]
13
- required :path_user_id, String
13
+ required :user_id, String
14
14
 
15
15
  # @!attribute role
16
16
  # User role: admin, billing, or developer (required)
@@ -18,38 +18,37 @@ module Sentdm
18
18
  # @return [String, nil]
19
19
  optional :role, String
20
20
 
21
- # @!attribute test_mode
22
- # Test mode flag - when true, the operation is simulated without side effects
23
- # Useful for testing integrations without actual execution
21
+ # @!attribute sandbox
22
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
23
+ # for testing integrations without actual execution
24
24
  #
25
25
  # @return [Boolean, nil]
26
- optional :test_mode, Sentdm::Internal::Type::Boolean
26
+ optional :sandbox, Sentdm::Internal::Type::Boolean
27
27
 
28
- # @!attribute body_user_id
29
- # User ID from route parameter
28
+ # @!attribute idempotency_key
30
29
  #
31
30
  # @return [String, nil]
32
- optional :body_user_id, String, api_name: :user_id
31
+ optional :idempotency_key, String
33
32
 
34
- # @!attribute idempotency_key
33
+ # @!attribute x_profile_id
35
34
  #
36
35
  # @return [String, nil]
37
- optional :idempotency_key, String
36
+ optional :x_profile_id, String
38
37
 
39
- # @!method initialize(path_user_id:, role: nil, test_mode: nil, body_user_id: nil, idempotency_key: nil, request_options: {})
38
+ # @!method initialize(user_id:, role: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
40
39
  # Some parameter documentations has been truncated, see
41
40
  # {Sentdm::Models::UserUpdateRoleParams} for more details.
42
41
  #
43
- # @param path_user_id [String]
42
+ # @param user_id [String]
44
43
  #
45
44
  # @param role [String] User role: admin, billing, or developer (required)
46
45
  #
47
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
48
- #
49
- # @param body_user_id [String] User ID from route parameter
46
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
50
47
  #
51
48
  # @param idempotency_key [String]
52
49
  #
50
+ # @param x_profile_id [String]
51
+ #
53
52
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
54
53
  end
55
54
  end
@@ -27,12 +27,12 @@ module Sentdm
27
27
  # @return [Integer, nil]
28
28
  optional :retry_count, Integer
29
29
 
30
- # @!attribute test_mode
31
- # Test mode flag - when true, the operation is simulated without side effects
32
- # Useful for testing integrations without actual execution
30
+ # @!attribute sandbox
31
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
32
+ # for testing integrations without actual execution
33
33
  #
34
34
  # @return [Boolean, nil]
35
- optional :test_mode, Sentdm::Internal::Type::Boolean
35
+ optional :sandbox, Sentdm::Internal::Type::Boolean
36
36
 
37
37
  # @!attribute timeout_seconds
38
38
  #
@@ -44,7 +44,12 @@ module Sentdm
44
44
  # @return [String, nil]
45
45
  optional :idempotency_key, String
46
46
 
47
- # @!method initialize(display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, test_mode: nil, timeout_seconds: nil, idempotency_key: nil, request_options: {})
47
+ # @!attribute x_profile_id
48
+ #
49
+ # @return [String, nil]
50
+ optional :x_profile_id, String
51
+
52
+ # @!method initialize(display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
48
53
  # Some parameter documentations has been truncated, see
49
54
  # {Sentdm::Models::WebhookCreateParams} for more details.
50
55
  #
@@ -56,12 +61,14 @@ module Sentdm
56
61
  #
57
62
  # @param retry_count [Integer]
58
63
  #
59
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
64
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
60
65
  #
61
66
  # @param timeout_seconds [Integer]
62
67
  #
63
68
  # @param idempotency_key [String]
64
69
  #
70
+ # @param x_profile_id [String]
71
+ #
65
72
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
66
73
  end
67
74
  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
@@ -7,7 +7,13 @@ module Sentdm
7
7
  extend Sentdm::Internal::Type::RequestParameters::Converter
8
8
  include Sentdm::Internal::Type::RequestParameters
9
9
 
10
- # @!method initialize(request_options: {})
10
+ # @!attribute x_profile_id
11
+ #
12
+ # @return [String, nil]
13
+ optional :x_profile_id, String
14
+
15
+ # @!method initialize(x_profile_id: nil, request_options: {})
16
+ # @param x_profile_id [String]
11
17
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
12
18
  end
13
19
  end
@@ -27,11 +27,17 @@ module Sentdm
27
27
  # @return [String, nil]
28
28
  optional :search, String, nil?: true
29
29
 
30
- # @!method initialize(id:, page:, page_size:, search: nil, request_options: {})
30
+ # @!attribute x_profile_id
31
+ #
32
+ # @return [String, nil]
33
+ optional :x_profile_id, String
34
+
35
+ # @!method initialize(id:, page:, page_size:, search: nil, x_profile_id: nil, request_options: {})
31
36
  # @param id [String]
32
37
  # @param page [Integer]
33
38
  # @param page_size [Integer]
34
39
  # @param search [String, nil]
40
+ # @param x_profile_id [String]
35
41
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
36
42
  end
37
43
  end
@@ -27,11 +27,17 @@ module Sentdm
27
27
  # @return [String, nil]
28
28
  optional :search, String, nil?: true
29
29
 
30
- # @!method initialize(page:, page_size:, is_active: nil, search: nil, request_options: {})
30
+ # @!attribute x_profile_id
31
+ #
32
+ # @return [String, nil]
33
+ optional :x_profile_id, String
34
+
35
+ # @!method initialize(page:, page_size:, is_active: nil, search: nil, x_profile_id: nil, request_options: {})
31
36
  # @param page [Integer]
32
37
  # @param page_size [Integer]
33
38
  # @param is_active [Boolean, nil]
34
39
  # @param search [String, nil]
40
+ # @param x_profile_id [String]
35
41
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
36
42
  end
37
43
  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
@@ -22,10 +22,16 @@ module Sentdm
22
22
  # @return [String, nil]
23
23
  optional :idempotency_key, String
24
24
 
25
- # @!method initialize(id:, body:, idempotency_key: nil, request_options: {})
25
+ # @!attribute x_profile_id
26
+ #
27
+ # @return [String, nil]
28
+ optional :x_profile_id, String
29
+
30
+ # @!method initialize(id:, body:, idempotency_key: nil, x_profile_id: nil, request_options: {})
26
31
  # @param id [String]
27
32
  # @param body [Sentdm::Models::WebhookRotateSecretParams::Body]
28
33
  # @param idempotency_key [String]
34
+ # @param x_profile_id [String]
29
35
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
30
36
 
31
37
  class Body < Sentdm::Models::MutationRequest
@@ -17,19 +17,24 @@ module Sentdm
17
17
  # @return [String, nil]
18
18
  optional :event_type, String
19
19
 
20
- # @!attribute test_mode
21
- # Test mode flag - when true, the operation is simulated without side effects
22
- # Useful for testing integrations without actual execution
20
+ # @!attribute sandbox
21
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
22
+ # for testing integrations without actual execution
23
23
  #
24
24
  # @return [Boolean, nil]
25
- optional :test_mode, Sentdm::Internal::Type::Boolean
25
+ optional :sandbox, Sentdm::Internal::Type::Boolean
26
26
 
27
27
  # @!attribute idempotency_key
28
28
  #
29
29
  # @return [String, nil]
30
30
  optional :idempotency_key, String
31
31
 
32
- # @!method initialize(id:, event_type: nil, test_mode: nil, idempotency_key: nil, request_options: {})
32
+ # @!attribute x_profile_id
33
+ #
34
+ # @return [String, nil]
35
+ optional :x_profile_id, String
36
+
37
+ # @!method initialize(id:, event_type: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
33
38
  # Some parameter documentations has been truncated, see
34
39
  # {Sentdm::Models::WebhookTestParams} for more details.
35
40
  #
@@ -37,10 +42,12 @@ module Sentdm
37
42
  #
38
43
  # @param event_type [String]
39
44
  #
40
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
45
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
41
46
  #
42
47
  # @param idempotency_key [String]
43
48
  #
49
+ # @param x_profile_id [String]
50
+ #
44
51
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
45
52
  end
46
53
  end
@@ -17,19 +17,24 @@ module Sentdm
17
17
  # @return [Boolean, nil]
18
18
  optional :is_active, Sentdm::Internal::Type::Boolean
19
19
 
20
- # @!attribute test_mode
21
- # Test mode flag - when true, the operation is simulated without side effects
22
- # Useful for testing integrations without actual execution
20
+ # @!attribute sandbox
21
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
22
+ # for testing integrations without actual execution
23
23
  #
24
24
  # @return [Boolean, nil]
25
- optional :test_mode, Sentdm::Internal::Type::Boolean
25
+ optional :sandbox, Sentdm::Internal::Type::Boolean
26
26
 
27
27
  # @!attribute idempotency_key
28
28
  #
29
29
  # @return [String, nil]
30
30
  optional :idempotency_key, String
31
31
 
32
- # @!method initialize(id:, is_active: nil, test_mode: nil, idempotency_key: nil, request_options: {})
32
+ # @!attribute x_profile_id
33
+ #
34
+ # @return [String, nil]
35
+ optional :x_profile_id, String
36
+
37
+ # @!method initialize(id:, is_active: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
33
38
  # Some parameter documentations has been truncated, see
34
39
  # {Sentdm::Models::WebhookToggleStatusParams} for more details.
35
40
  #
@@ -37,10 +42,12 @@ module Sentdm
37
42
  #
38
43
  # @param is_active [Boolean]
39
44
  #
40
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
45
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
41
46
  #
42
47
  # @param idempotency_key [String]
43
48
  #
49
+ # @param x_profile_id [String]
50
+ #
44
51
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
45
52
  end
46
53
  end
@@ -32,12 +32,12 @@ module Sentdm
32
32
  # @return [Integer, nil]
33
33
  optional :retry_count, Integer
34
34
 
35
- # @!attribute test_mode
36
- # Test mode flag - when true, the operation is simulated without side effects
37
- # Useful for testing integrations without actual execution
35
+ # @!attribute sandbox
36
+ # Sandbox flag - when true, the operation is simulated without side effects Useful
37
+ # for testing integrations without actual execution
38
38
  #
39
39
  # @return [Boolean, nil]
40
- optional :test_mode, Sentdm::Internal::Type::Boolean
40
+ optional :sandbox, Sentdm::Internal::Type::Boolean
41
41
 
42
42
  # @!attribute timeout_seconds
43
43
  #
@@ -49,7 +49,12 @@ module Sentdm
49
49
  # @return [String, nil]
50
50
  optional :idempotency_key, String
51
51
 
52
- # @!method initialize(id:, display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, test_mode: nil, timeout_seconds: nil, idempotency_key: nil, request_options: {})
52
+ # @!attribute x_profile_id
53
+ #
54
+ # @return [String, nil]
55
+ optional :x_profile_id, String
56
+
57
+ # @!method initialize(id:, display_name: nil, endpoint_url: nil, event_types: nil, retry_count: nil, sandbox: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
53
58
  # Some parameter documentations has been truncated, see
54
59
  # {Sentdm::Models::WebhookUpdateParams} for more details.
55
60
  #
@@ -63,12 +68,14 @@ module Sentdm
63
68
  #
64
69
  # @param retry_count [Integer]
65
70
  #
66
- # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
71
+ # @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
67
72
  #
68
73
  # @param timeout_seconds [Integer]
69
74
  #
70
75
  # @param idempotency_key [String]
71
76
  #
77
+ # @param x_profile_id [String]
78
+ #
72
79
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
73
80
  end
74
81
  end
data/lib/sentdm/models.rb CHANGED
@@ -43,8 +43,6 @@ module Sentdm
43
43
 
44
44
  APIMeta = Sentdm::Models::APIMeta
45
45
 
46
- APIResponseBrandWithKYC = Sentdm::Models::APIResponseBrandWithKYC
47
-
48
46
  APIResponseContact = Sentdm::Models::APIResponseContact
49
47
 
50
48
  APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
@@ -55,18 +53,10 @@ module Sentdm
55
53
 
56
54
  APIResponseWebhook = Sentdm::Models::APIResponseWebhook
57
55
 
58
- BrandCreateParams = Sentdm::Models::BrandCreateParams
59
-
60
56
  BrandData = Sentdm::Models::BrandData
61
57
 
62
- BrandDeleteParams = Sentdm::Models::BrandDeleteParams
63
-
64
- BrandListParams = Sentdm::Models::BrandListParams
65
-
66
58
  Brands = Sentdm::Models::Brands
67
59
 
68
- BrandUpdateParams = Sentdm::Models::BrandUpdateParams
69
-
70
60
  BrandWithKYC = Sentdm::Models::BrandWithKYC
71
61
 
72
62
  Contact = Sentdm::Models::Contact
@@ -83,8 +73,6 @@ module Sentdm
83
73
 
84
74
  DestinationCountry = Sentdm::Models::DestinationCountry
85
75
 
86
- LookupRetrievePhoneInfoParams = Sentdm::Models::LookupRetrievePhoneInfoParams
87
-
88
76
  MeRetrieveParams = Sentdm::Models::MeRetrieveParams
89
77
 
90
78
  MessageRetrieveActivitiesParams = Sentdm::Models::MessageRetrieveActivitiesParams
@@ -3,136 +3,7 @@
3
3
  module Sentdm
4
4
  module Resources
5
5
  class Brands
6
- # Register and manage 10DLC brands for SMS compliance
7
6
  class Campaigns
8
- # Some parameter documentations has been truncated, see
9
- # {Sentdm::Models::Brands::CampaignCreateParams} for more details.
10
- #
11
- # Creates a new campaign scoped under a specific brand. The campaign is linked to
12
- # the specified brand. Each campaign must include at least one use case with
13
- # sample messages.
14
- #
15
- # @overload create(brand_id, campaign:, test_mode: nil, idempotency_key: nil, request_options: {})
16
- #
17
- # @param brand_id [String] Path param: Brand ID from route
18
- #
19
- # @param campaign [Sentdm::Models::Brands::CampaignData] Body param: Campaign data
20
- #
21
- # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
22
- #
23
- # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
24
- #
25
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
26
- #
27
- # @return [Sentdm::Models::Brands::APIResponseTcrCampaignWithUseCases]
28
- #
29
- # @see Sentdm::Models::Brands::CampaignCreateParams
30
- def create(brand_id, params)
31
- parsed, options = Sentdm::Brands::CampaignCreateParams.dump_request(params)
32
- header_params = {idempotency_key: "idempotency-key"}
33
- @client.request(
34
- method: :post,
35
- path: ["v3/brands/%1$s/campaigns", brand_id],
36
- headers: parsed.slice(*header_params.keys).transform_keys(header_params),
37
- body: parsed.except(*header_params.keys),
38
- model: Sentdm::Brands::APIResponseTcrCampaignWithUseCases,
39
- options: options
40
- )
41
- end
42
-
43
- # Some parameter documentations has been truncated, see
44
- # {Sentdm::Models::Brands::CampaignUpdateParams} for more details.
45
- #
46
- # Updates an existing campaign scoped under a specific brand. Cannot update
47
- # campaigns that have already been submitted to TCR.
48
- #
49
- # @overload update(campaign_id, brand_id:, campaign:, test_mode: nil, idempotency_key: nil, request_options: {})
50
- #
51
- # @param campaign_id [String] Path param: Campaign ID from route
52
- #
53
- # @param brand_id [String] Path param: Brand ID from route
54
- #
55
- # @param campaign [Sentdm::Models::Brands::CampaignData] Body param: Campaign data
56
- #
57
- # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
58
- #
59
- # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
60
- #
61
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
62
- #
63
- # @return [Sentdm::Models::Brands::APIResponseTcrCampaignWithUseCases]
64
- #
65
- # @see Sentdm::Models::Brands::CampaignUpdateParams
66
- def update(campaign_id, params)
67
- parsed, options = Sentdm::Brands::CampaignUpdateParams.dump_request(params)
68
- brand_id =
69
- parsed.delete(:brand_id) do
70
- raise ArgumentError.new("missing required path argument #{_1}")
71
- end
72
- header_params = {idempotency_key: "idempotency-key"}
73
- @client.request(
74
- method: :put,
75
- path: ["v3/brands/%1$s/campaigns/%2$s", brand_id, campaign_id],
76
- headers: parsed.slice(*header_params.keys).transform_keys(header_params),
77
- body: parsed.except(*header_params.keys),
78
- model: Sentdm::Brands::APIResponseTcrCampaignWithUseCases,
79
- options: options
80
- )
81
- end
82
-
83
- # Retrieves all campaigns linked to a specific brand, including their use cases
84
- # and sample messages.
85
- #
86
- # @overload list(brand_id, request_options: {})
87
- #
88
- # @param brand_id [String] Brand ID from route
89
- #
90
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
91
- #
92
- # @return [Sentdm::Models::Brands::CampaignListResponse]
93
- #
94
- # @see Sentdm::Models::Brands::CampaignListParams
95
- def list(brand_id, params = {})
96
- @client.request(
97
- method: :get,
98
- path: ["v3/brands/%1$s/campaigns", brand_id],
99
- model: Sentdm::Models::Brands::CampaignListResponse,
100
- options: params[:request_options]
101
- )
102
- end
103
-
104
- # Deletes a campaign by ID within a specific brand. The brand must belong to the
105
- # authenticated customer.
106
- #
107
- # @overload delete(campaign_id, brand_id:, body:, request_options: {})
108
- #
109
- # @param campaign_id [String] Path param: Campaign ID from route parameter
110
- #
111
- # @param brand_id [String] Path param: Brand ID from route parameter
112
- #
113
- # @param body [Sentdm::Models::Brands::CampaignDeleteParams::Body] Body param: Request to delete a campaign from a brand
114
- #
115
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
116
- #
117
- # @return [nil]
118
- #
119
- # @see Sentdm::Models::Brands::CampaignDeleteParams
120
- def delete(campaign_id, params)
121
- parsed, options = Sentdm::Brands::CampaignDeleteParams.dump_request(params)
122
- brand_id =
123
- parsed.delete(:brand_id) do
124
- raise ArgumentError.new("missing required path argument #{_1}")
125
- end
126
- @client.request(
127
- method: :delete,
128
- path: ["v3/brands/%1$s/campaigns/%2$s", brand_id, campaign_id],
129
- headers: {"content-type" => "*/*"},
130
- body: parsed[:body],
131
- model: NilClass,
132
- options: options
133
- )
134
- end
135
-
136
7
  # @api private
137
8
  #
138
9
  # @param client [Sentdm::Client]
@@ -2,122 +2,10 @@
2
2
 
3
3
  module Sentdm
4
4
  module Resources
5
- # Register and manage 10DLC brands for SMS compliance
6
5
  class Brands
7
- # Register and manage 10DLC brands for SMS compliance
8
6
  # @return [Sentdm::Resources::Brands::Campaigns]
9
7
  attr_reader :campaigns
10
8
 
11
- # Some parameter documentations has been truncated, see
12
- # {Sentdm::Models::BrandCreateParams} for more details.
13
- #
14
- # Creates a new brand and associated information. This endpoint automatically sets
15
- # inheritTcrBrand=false when a brand is created.
16
- #
17
- # @overload create(brand:, test_mode: nil, idempotency_key: nil, request_options: {})
18
- #
19
- # @param brand [Sentdm::Models::BrandData] Body param: Brand and KYC information
20
- #
21
- # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
22
- #
23
- # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
24
- #
25
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
26
- #
27
- # @return [Sentdm::Models::APIResponseBrandWithKYC]
28
- #
29
- # @see Sentdm::Models::BrandCreateParams
30
- def create(params)
31
- parsed, options = Sentdm::BrandCreateParams.dump_request(params)
32
- header_params = {idempotency_key: "idempotency-key"}
33
- @client.request(
34
- method: :post,
35
- path: "v3/brands",
36
- headers: parsed.slice(*header_params.keys).transform_keys(header_params),
37
- body: parsed.except(*header_params.keys),
38
- model: Sentdm::APIResponseBrandWithKYC,
39
- options: options
40
- )
41
- end
42
-
43
- # Some parameter documentations has been truncated, see
44
- # {Sentdm::Models::BrandUpdateParams} for more details.
45
- #
46
- # Updates an existing brand and its associated information. Cannot update brands
47
- # that have already been submitted to TCR or inherited brands.
48
- #
49
- # @overload update(brand_id, brand:, test_mode: nil, idempotency_key: nil, request_options: {})
50
- #
51
- # @param brand_id [String] Path param: Brand ID from route
52
- #
53
- # @param brand [Sentdm::Models::BrandData] Body param: Brand and KYC information
54
- #
55
- # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
56
- #
57
- # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
58
- #
59
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
60
- #
61
- # @return [Sentdm::Models::APIResponseBrandWithKYC]
62
- #
63
- # @see Sentdm::Models::BrandUpdateParams
64
- def update(brand_id, params)
65
- parsed, options = Sentdm::BrandUpdateParams.dump_request(params)
66
- header_params = {idempotency_key: "idempotency-key"}
67
- @client.request(
68
- method: :put,
69
- path: ["v3/brands/%1$s", brand_id],
70
- headers: parsed.slice(*header_params.keys).transform_keys(header_params),
71
- body: parsed.except(*header_params.keys),
72
- model: Sentdm::APIResponseBrandWithKYC,
73
- options: options
74
- )
75
- end
76
-
77
- # Retrieves all brands for the authenticated customer with information in a
78
- # flattened structure. Includes inherited brands if inheritTcrBrand=true.
79
- #
80
- # @overload list(request_options: {})
81
- #
82
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
83
- #
84
- # @return [Sentdm::Models::BrandListResponse]
85
- #
86
- # @see Sentdm::Models::BrandListParams
87
- def list(params = {})
88
- @client.request(
89
- method: :get,
90
- path: "v3/brands",
91
- model: Sentdm::Models::BrandListResponse,
92
- options: params[:request_options]
93
- )
94
- end
95
-
96
- # Delete a brand by ID. The brand must belong to the authenticated customer.
97
- #
98
- # @overload delete(brand_id, body:, request_options: {})
99
- #
100
- # @param brand_id [String] Brand ID from route parameter
101
- #
102
- # @param body [Sentdm::Models::BrandDeleteParams::Body] Request to delete a brand
103
- #
104
- # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
105
- #
106
- # @return [nil]
107
- #
108
- # @see Sentdm::Models::BrandDeleteParams
109
- def delete(brand_id, params)
110
- parsed, options = Sentdm::BrandDeleteParams.dump_request(params)
111
- @client.request(
112
- method: :delete,
113
- path: ["v3/brands/%1$s", brand_id],
114
- headers: {"content-type" => "*/*"},
115
- body: parsed[:body],
116
- model: NilClass,
117
- options: options
118
- )
119
- end
120
-
121
9
  # @api private
122
10
  #
123
11
  # @param client [Sentdm::Client]