sentdm 0.5.0 → 0.8.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 (152) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +41 -0
  3. data/README.md +31 -1
  4. data/lib/sentdm/internal/type/base_model.rb +5 -5
  5. data/lib/sentdm/models/api_response_of_contact.rb +9 -6
  6. data/lib/sentdm/models/api_response_of_profile_detail.rb +6 -6
  7. data/lib/sentdm/models/api_response_of_user.rb +6 -6
  8. data/lib/sentdm/models/api_response_template.rb +6 -6
  9. data/lib/sentdm/models/api_response_webhook.rb +4 -4
  10. data/lib/sentdm/models/brands_brand_data.rb +16 -252
  11. data/lib/sentdm/models/contact_delete_params.rb +1 -1
  12. data/lib/sentdm/models/contact_list_response.rb +9 -9
  13. data/lib/sentdm/models/me_retrieve_response.rb +35 -21
  14. data/lib/sentdm/models/message_retrieve_activities_response.rb +7 -7
  15. data/lib/sentdm/models/message_retrieve_status_response.rb +7 -7
  16. data/lib/sentdm/models/message_send_params.rb +5 -3
  17. data/lib/sentdm/models/message_send_response.rb +7 -7
  18. data/lib/sentdm/models/{mutation_request_base.rb → mutation_request.rb} +2 -2
  19. data/lib/sentdm/models/number_lookup_response.rb +4 -4
  20. data/lib/sentdm/models/pagination_meta.rb +3 -3
  21. data/lib/sentdm/models/{profile_complete_setup_params.rb → profile_complete_params.rb} +3 -3
  22. data/lib/sentdm/models/{profile_complete_setup_response.rb → profile_complete_response.rb} +1 -1
  23. data/lib/sentdm/models/profile_create_params.rb +20 -23
  24. data/lib/sentdm/models/profile_delete_params.rb +1 -1
  25. data/lib/sentdm/models/profile_detail.rb +12 -22
  26. data/lib/sentdm/models/profile_list_response.rb +7 -7
  27. data/lib/sentdm/models/profile_update_params.rb +9 -13
  28. data/lib/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rb +4 -4
  29. data/lib/sentdm/models/profiles/base_dto.rb +32 -0
  30. data/lib/sentdm/models/profiles/campaign_create_params.rb +2 -2
  31. data/lib/sentdm/models/profiles/campaign_data.rb +5 -26
  32. data/lib/sentdm/models/profiles/campaign_delete_params.rb +1 -1
  33. data/lib/sentdm/models/profiles/campaign_list_response.rb +4 -4
  34. data/lib/sentdm/models/profiles/campaign_update_params.rb +2 -2
  35. data/lib/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rb +29 -0
  36. data/lib/sentdm/models/profiles/tcr_campaign_with_use_cases.rb +2 -2
  37. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb +34 -0
  38. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb +40 -0
  39. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb +38 -0
  40. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb +81 -0
  41. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb +34 -0
  42. data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb +39 -0
  43. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb +116 -0
  44. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb +75 -0
  45. data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb +58 -0
  46. data/lib/sentdm/models/template_create_params.rb +3 -2
  47. data/lib/sentdm/models/template_definition.rb +19 -263
  48. data/lib/sentdm/models/template_list_response.rb +9 -9
  49. data/lib/sentdm/models/template_update_params.rb +3 -2
  50. data/lib/sentdm/models/user_list_response.rb +7 -7
  51. data/lib/sentdm/models/user_remove_params.rb +1 -1
  52. data/lib/sentdm/models/webhook_list_event_types_response.rb +4 -4
  53. data/lib/sentdm/models/webhook_list_events_response.rb +4 -4
  54. data/lib/sentdm/models/webhook_list_response.rb +4 -4
  55. data/lib/sentdm/models/webhook_rotate_secret_params.rb +1 -1
  56. data/lib/sentdm/models/webhook_rotate_secret_response.rb +4 -4
  57. data/lib/sentdm/models/webhook_test_response.rb +4 -4
  58. data/lib/sentdm/models.rb +29 -4
  59. data/lib/sentdm/resources/messages.rb +1 -1
  60. data/lib/sentdm/resources/profiles/campaigns.rb +2 -2
  61. data/lib/sentdm/resources/profiles.rb +12 -12
  62. data/lib/sentdm/resources/templates.rb +2 -2
  63. data/lib/sentdm/version.rb +1 -1
  64. data/lib/sentdm.rb +14 -4
  65. data/rbi/sentdm/models/api_response_of_contact.rbi +6 -6
  66. data/rbi/sentdm/models/api_response_of_profile_detail.rbi +6 -6
  67. data/rbi/sentdm/models/api_response_of_user.rbi +6 -6
  68. data/rbi/sentdm/models/api_response_template.rbi +6 -6
  69. data/rbi/sentdm/models/api_response_webhook.rbi +4 -4
  70. data/rbi/sentdm/models/brands_brand_data.rbi +53 -355
  71. data/rbi/sentdm/models/contact_delete_params.rbi +1 -1
  72. data/rbi/sentdm/models/contact_list_response.rbi +9 -9
  73. data/rbi/sentdm/models/me_retrieve_response.rbi +33 -21
  74. data/rbi/sentdm/models/message_retrieve_activities_response.rbi +7 -7
  75. data/rbi/sentdm/models/message_retrieve_status_response.rbi +7 -7
  76. data/rbi/sentdm/models/message_send_params.rbi +6 -3
  77. data/rbi/sentdm/models/message_send_response.rbi +7 -7
  78. data/rbi/sentdm/models/{mutation_request_base.rbi → mutation_request.rbi} +2 -2
  79. data/rbi/sentdm/models/number_lookup_response.rbi +4 -4
  80. data/rbi/sentdm/models/pagination_meta.rbi +3 -3
  81. data/rbi/sentdm/models/{profile_complete_setup_params.rbi → profile_complete_params.rbi} +2 -2
  82. data/rbi/sentdm/models/{profile_complete_setup_response.rbi → profile_complete_response.rbi} +1 -1
  83. data/rbi/sentdm/models/profile_create_params.rbi +27 -33
  84. data/rbi/sentdm/models/profile_delete_params.rbi +1 -1
  85. data/rbi/sentdm/models/profile_detail.rbi +9 -22
  86. data/rbi/sentdm/models/profile_list_response.rbi +7 -7
  87. data/rbi/sentdm/models/profile_update_params.rbi +12 -20
  88. data/rbi/sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases.rbi +4 -4
  89. data/rbi/sentdm/models/profiles/base_dto.rbi +53 -0
  90. data/rbi/sentdm/models/profiles/campaign_create_params.rbi +2 -2
  91. data/rbi/sentdm/models/profiles/campaign_data.rbi +14 -49
  92. data/rbi/sentdm/models/profiles/campaign_delete_params.rbi +1 -1
  93. data/rbi/sentdm/models/profiles/campaign_list_response.rbi +4 -4
  94. data/rbi/sentdm/models/profiles/campaign_update_params.rbi +2 -2
  95. data/rbi/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbi +51 -0
  96. data/rbi/sentdm/models/profiles/tcr_campaign_with_use_cases.rbi +2 -2
  97. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbi +56 -0
  98. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbi +76 -0
  99. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbi +79 -0
  100. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbi +104 -0
  101. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbi +60 -0
  102. data/rbi/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbi +62 -0
  103. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbi +180 -0
  104. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbi +95 -0
  105. data/rbi/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbi +81 -0
  106. data/rbi/sentdm/models/template_create_params.rbi +4 -2
  107. data/rbi/sentdm/models/template_definition.rbi +82 -415
  108. data/rbi/sentdm/models/template_list_response.rbi +9 -9
  109. data/rbi/sentdm/models/template_update_params.rbi +4 -2
  110. data/rbi/sentdm/models/user_list_response.rbi +7 -7
  111. data/rbi/sentdm/models/user_remove_params.rbi +1 -1
  112. data/rbi/sentdm/models/webhook_list_event_types_response.rbi +4 -4
  113. data/rbi/sentdm/models/webhook_list_events_response.rbi +4 -4
  114. data/rbi/sentdm/models/webhook_list_response.rbi +4 -4
  115. data/rbi/sentdm/models/webhook_rotate_secret_params.rbi +1 -1
  116. data/rbi/sentdm/models/webhook_rotate_secret_response.rbi +4 -4
  117. data/rbi/sentdm/models/webhook_test_response.rbi +4 -4
  118. data/rbi/sentdm/models.rbi +29 -4
  119. data/rbi/sentdm/resources/messages.rbi +2 -1
  120. data/rbi/sentdm/resources/profiles/campaigns.rbi +2 -2
  121. data/rbi/sentdm/resources/profiles.rbi +20 -26
  122. data/rbi/sentdm/resources/templates.rbi +4 -2
  123. data/sig/sentdm/models/brands_brand_data.rbs +12 -192
  124. data/sig/sentdm/models/contact_delete_params.rbs +1 -1
  125. data/sig/sentdm/models/{mutation_request_base.rbs → mutation_request.rbs} +2 -2
  126. data/sig/sentdm/models/{profile_complete_setup_params.rbs → profile_complete_params.rbs} +2 -2
  127. data/sig/sentdm/models/profile_complete_response.rbs +5 -0
  128. data/sig/sentdm/models/profile_delete_params.rbs +1 -1
  129. data/sig/sentdm/models/profiles/base_dto.rbs +27 -0
  130. data/sig/sentdm/models/profiles/campaign_data.rbs +4 -26
  131. data/sig/sentdm/models/profiles/campaign_delete_params.rbs +1 -1
  132. data/sig/sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data.rbs +27 -0
  133. data/sig/sentdm/models/profiles/tcr_campaign_with_use_cases.rbs +2 -2
  134. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rbs +24 -0
  135. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rbs +30 -0
  136. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rbs +38 -0
  137. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rbs +75 -0
  138. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rbs +32 -0
  139. data/sig/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rbs +32 -0
  140. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rbs +89 -0
  141. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rbs +55 -0
  142. data/sig/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rbs +45 -0
  143. data/sig/sentdm/models/template_definition.rbs +20 -233
  144. data/sig/sentdm/models/user_remove_params.rbs +1 -1
  145. data/sig/sentdm/models/webhook_rotate_secret_params.rbs +1 -1
  146. data/sig/sentdm/models.rbs +20 -4
  147. data/sig/sentdm/resources/profiles.rbs +1 -1
  148. metadata +44 -14
  149. data/lib/sentdm/models/base_dto.rb +0 -30
  150. data/rbi/sentdm/models/base_dto.rbi +0 -49
  151. data/sig/sentdm/models/base_dto.rbs +0 -25
  152. data/sig/sentdm/models/profile_complete_setup_response.rbs +0 -5
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b04e02de625816b5c8b0b5a02ecedc198dc33f346277ebaebca6e26e8df61844
4
- data.tar.gz: cb8626c2a126335a92cea456679fdb2d5865fbecbb391e6634d00b932cde65d4
3
+ metadata.gz: 447a045280efe7da83cf429cdcccd358d54cab7bde54b7e017e194b398ed6333
4
+ data.tar.gz: 6df56b895dfc8b2b118c8bccdabc9b87272a79c80f9f1749d27ff5537d97240a
5
5
  SHA512:
6
- metadata.gz: 7a1eec1d9dfd462eefddb941989e06e7af9ed1e2a3fd9a84fca256af193711b0443c7dbbca66db20963722c630e34854207489842f21d8ab4fd4f174118a6178
7
- data.tar.gz: d291e1ace6701e0ef970dc044aa629847472273a9ec1b422456eba805db7f4b45358ea0b71fba71f166392f20c0e4b37a20d4c23b5339ed9d55c29980defd60a
6
+ metadata.gz: '064029446763608a46bdb7e1be08b8075645ea22b42a954a259d9ba0ebdf5aecd39bc8a783d38e745ad41c8e18c018c90439b62ab2d9b750938def30983a6fed'
7
+ data.tar.gz: 941fd2702a359e4d7ce7eee6b8e868980275fa7270457e3534fd1dfbb385d1b052c235aae138d9e93dcfc428c133960a9b29b47ad45bd257bc5649a6d0d2c94a
data/CHANGELOG.md CHANGED
@@ -1,5 +1,46 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.8.0 (2026-03-12)
4
+
5
+ Full Changelog: [v0.7.0...v0.8.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.7.0...v0.8.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([f25ebae](https://github.com/sentdm/sent-dm-ruby/commit/f25ebae4c9713c74d6958d1bc3bc83bec52db1a9))
10
+ * **api:** manual updates ([7700a0e](https://github.com/sentdm/sent-dm-ruby/commit/7700a0e6b7a4a8e68a4d4bc7fdad40bc51302fcc))
11
+ * **api:** manual updates ([3101223](https://github.com/sentdm/sent-dm-ruby/commit/3101223023d236a6b3006f4c9847badc5a98dbab))
12
+
13
+ ## 0.7.0 (2026-03-11)
14
+
15
+ Full Changelog: [v0.6.0...v0.7.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.6.0...v0.7.0)
16
+
17
+ ### Features
18
+
19
+ * **api:** api update ([ca96b29](https://github.com/sentdm/sent-dm-ruby/commit/ca96b2943f08c60dcbe3c7d9b2f4afe8af9b14d6))
20
+ * **api:** manual updates ([df62aff](https://github.com/sentdm/sent-dm-ruby/commit/df62affd4c31572d0fb8a4bc6b2787cfaabea4f2))
21
+ * **api:** manual updates ([843dfa8](https://github.com/sentdm/sent-dm-ruby/commit/843dfa8613623db67382955ee3ba5f116f945f21))
22
+
23
+
24
+ ### Bug Fixes
25
+
26
+ * properly mock time in ruby ci tests ([4c4ebe0](https://github.com/sentdm/sent-dm-ruby/commit/4c4ebe03e980346d3ecc508e2740ad2ded666a8e))
27
+
28
+
29
+ ### Chores
30
+
31
+ * **ci:** add build step ([e67706a](https://github.com/sentdm/sent-dm-ruby/commit/e67706ab8895b76ca683a3e2e47244650be6aca0))
32
+ * **ci:** skip uploading artifacts on stainless-internal branches ([1d6bb94](https://github.com/sentdm/sent-dm-ruby/commit/1d6bb94d3b4eb5b4383827200ead9f557c39c72f))
33
+ * **internal:** codegen related update ([0dd8713](https://github.com/sentdm/sent-dm-ruby/commit/0dd871352c089d8e40788912ba5c1eec907f4640))
34
+ * **internal:** codegen related update ([7b3ead8](https://github.com/sentdm/sent-dm-ruby/commit/7b3ead8de1ffc36ea448af5eed97ac1fc4f462bb))
35
+
36
+ ## 0.6.0 (2026-03-11)
37
+
38
+ Full Changelog: [v0.5.0...v0.6.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.5.0...v0.6.0)
39
+
40
+ ### Features
41
+
42
+ * **api:** manual updates ([df62aff](https://github.com/sentdm/sent-dm-ruby/commit/df62affd4c31572d0fb8a4bc6b2787cfaabea4f2))
43
+
3
44
  ## 0.5.0 (2026-03-11)
4
45
 
5
46
  Full Changelog: [v0.4.0...v0.5.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.4.0...v0.5.0)
data/README.md CHANGED
@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
26
26
  <!-- x-release-please-start-version -->
27
27
 
28
28
  ```ruby
29
- gem "sentdm", "~> 0.5.0"
29
+ gem "sentdm", "~> 0.8.0"
30
30
  ```
31
31
 
32
32
  <!-- x-release-please-end -->
@@ -265,6 +265,36 @@ params = Sentdm::MessageSendParams.new(
265
265
  sent_dm.messages.send_(**params)
266
266
  ```
267
267
 
268
+ ### Enums
269
+
270
+ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
271
+
272
+ ```ruby
273
+ # :PRIVATE_PROFIT
274
+ puts(
275
+ Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT
276
+ )
277
+
278
+ # Revealed type: `T.all(Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, Symbol)`
279
+ T.reveal_type(
280
+ Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT
281
+ )
282
+ ```
283
+
284
+ Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
285
+
286
+ ```ruby
287
+ Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo.new(
288
+ entity_type: Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT,
289
+ # …
290
+ )
291
+
292
+ Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo.new(
293
+ entity_type: :PRIVATE_PROFIT,
294
+ # …
295
+ )
296
+ ```
297
+
268
298
  ## Versioning
269
299
 
270
300
  This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the library is in initial development and has a major version of `0`, APIs may change at any time.
@@ -438,11 +438,11 @@ module Sentdm
438
438
  # @return [Hash{Symbol=>Object}]
439
439
  #
440
440
  # @example
441
- # # `base_dto` is a `Sentdm::BaseDto`
442
- # base_dto => {
443
- # id: id,
444
- # created_at: created_at,
445
- # updated_at: updated_at
441
+ # # `api_error` is a `Sentdm::APIError`
442
+ # api_error => {
443
+ # code: code,
444
+ # details: details,
445
+ # doc_url: doc_url
446
446
  # }
447
447
  def deconstruct_keys(keys)
448
448
  (keys || self.class.known_fields.keys)
@@ -5,19 +5,19 @@ module Sentdm
5
5
  # @see Sentdm::Resources::Contacts#create
6
6
  class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # The response data (null if error)
8
+ # Contact response for v3 API Uses snake_case for JSON property names
9
9
  #
10
10
  # @return [Sentdm::Models::ContactResponse, nil]
11
11
  optional :data, -> { Sentdm::ContactResponse }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
14
+ # Error information
15
15
  #
16
16
  # @return [Sentdm::Models::APIError, nil]
17
17
  optional :error, -> { Sentdm::APIError }, nil?: true
18
18
 
19
19
  # @!attribute meta
20
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -29,13 +29,16 @@ module Sentdm
29
29
  optional :success, Sentdm::Internal::Type::Boolean
30
30
 
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
+ # Some parameter documentations has been truncated, see
33
+ # {Sentdm::Models::APIResponseOfContact} for more details.
34
+ #
32
35
  # Standard API response envelope for all v3 endpoints
33
36
  #
34
- # @param data [Sentdm::Models::ContactResponse, nil] The response data (null if error)
37
+ # @param data [Sentdm::Models::ContactResponse, nil] Contact response for v3 API
35
38
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
39
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
40
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
41
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
42
  #
40
43
  # @param success [Boolean] Indicates whether the request was successful
41
44
  end
@@ -5,19 +5,19 @@ module Sentdm
5
5
  # @see Sentdm::Resources::Profiles#create
6
6
  class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # The response data (null if error)
8
+ # Detailed profile response for v3 API
9
9
  #
10
10
  # @return [Sentdm::Models::ProfileDetail, nil]
11
11
  optional :data, -> { Sentdm::ProfileDetail }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
14
+ # Error information
15
15
  #
16
16
  # @return [Sentdm::Models::APIError, nil]
17
17
  optional :error, -> { Sentdm::APIError }, nil?: true
18
18
 
19
19
  # @!attribute meta
20
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
32
  # Standard API response envelope for all v3 endpoints
33
33
  #
34
- # @param data [Sentdm::Models::ProfileDetail, nil] The response data (null if error)
34
+ # @param data [Sentdm::Models::ProfileDetail, nil] Detailed profile response for v3 API
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
  end
@@ -5,19 +5,19 @@ module Sentdm
5
5
  # @see Sentdm::Resources::Users#retrieve
6
6
  class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # The response data (null if error)
8
+ # User response for v3 API
9
9
  #
10
10
  # @return [Sentdm::Models::UserResponse, nil]
11
11
  optional :data, -> { Sentdm::UserResponse }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
14
+ # Error information
15
15
  #
16
16
  # @return [Sentdm::Models::APIError, nil]
17
17
  optional :error, -> { Sentdm::APIError }, nil?: true
18
18
 
19
19
  # @!attribute meta
20
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
32
  # Standard API response envelope for all v3 endpoints
33
33
  #
34
- # @param data [Sentdm::Models::UserResponse, nil] The response data (null if error)
34
+ # @param data [Sentdm::Models::UserResponse, nil] User response for v3 API
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
  end
@@ -5,19 +5,19 @@ module Sentdm
5
5
  # @see Sentdm::Resources::Templates#create
6
6
  class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # The response data (null if error)
8
+ # Template response for v3 API
9
9
  #
10
10
  # @return [Sentdm::Models::Template, nil]
11
11
  optional :data, -> { Sentdm::Template }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
14
+ # Error information
15
15
  #
16
16
  # @return [Sentdm::Models::APIError, nil]
17
17
  optional :error, -> { Sentdm::APIError }, nil?: true
18
18
 
19
19
  # @!attribute meta
20
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
32
  # Standard API response envelope for all v3 endpoints
33
33
  #
34
- # @param data [Sentdm::Models::Template, nil] The response data (null if error)
34
+ # @param data [Sentdm::Models::Template, nil] Template response for v3 API
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
  end
@@ -11,13 +11,13 @@ module Sentdm
11
11
  optional :data, -> { Sentdm::WebhookResponse }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
14
+ # Error information
15
15
  #
16
16
  # @return [Sentdm::Models::APIError, nil]
17
17
  optional :error, -> { Sentdm::APIError }, nil?: true
18
18
 
19
19
  # @!attribute meta
20
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ module Sentdm
33
33
  #
34
34
  # @param data [Sentdm::Models::WebhookResponse, nil] The response data (null if error)
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
  end
@@ -4,271 +4,35 @@ module Sentdm
4
4
  module Models
5
5
  class BrandsBrandData < Sentdm::Internal::Type::BaseModel
6
6
  # @!attribute compliance
7
- # Compliance and TCR-related information
7
+ # Compliance and TCR information for brand registration
8
8
  #
9
- # @return [Sentdm::Models::BrandsBrandData::Compliance]
10
- required :compliance, -> { Sentdm::BrandsBrandData::Compliance }
9
+ # @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo]
10
+ required :compliance,
11
+ -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo }
11
12
 
12
13
  # @!attribute contact
13
- # Contact information for the brand
14
+ # Contact information for brand KYC
14
15
  #
15
- # @return [Sentdm::Models::BrandsBrandData::Contact]
16
- required :contact, -> { Sentdm::BrandsBrandData::Contact }
16
+ # @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo]
17
+ required :contact,
18
+ -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo }
17
19
 
18
20
  # @!attribute business
19
- # Business details and address information
21
+ # Business details and address for brand KYC
20
22
  #
21
- # @return [Sentdm::Models::BrandsBrandData::Business, nil]
22
- optional :business, -> { Sentdm::BrandsBrandData::Business }, nil?: true
23
+ # @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil]
24
+ optional :business,
25
+ -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo },
26
+ nil?: true
23
27
 
24
28
  # @!method initialize(compliance:, contact:, business: nil)
25
29
  # Brand and KYC data grouped into contact, business, and compliance sections
26
30
  #
27
- # @param compliance [Sentdm::Models::BrandsBrandData::Compliance] Compliance and TCR-related information
31
+ # @param compliance [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo] Compliance and TCR information for brand registration
28
32
  #
29
- # @param contact [Sentdm::Models::BrandsBrandData::Contact] Contact information for the brand
33
+ # @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for brand KYC
30
34
  #
31
- # @param business [Sentdm::Models::BrandsBrandData::Business, nil] Business details and address information
32
-
33
- # @see Sentdm::Models::BrandsBrandData#compliance
34
- class Compliance < Sentdm::Internal::Type::BaseModel
35
- # @!attribute brand_relationship
36
- # Brand relationship level with TCR (required for TCR)
37
- #
38
- # @return [Symbol, Sentdm::Models::TcrBrandRelationship]
39
- required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
40
-
41
- # @!attribute vertical
42
- # Business vertical/industry category (required for TCR)
43
- #
44
- # @return [Symbol, Sentdm::Models::TcrVertical]
45
- required :vertical, enum: -> { Sentdm::TcrVertical }
46
-
47
- # @!attribute destination_countries
48
- # List of destination countries for messaging
49
- #
50
- # @return [Array<Sentdm::Models::DestinationCountry>, nil]
51
- optional :destination_countries,
52
- -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
53
- api_name: :destinationCountries,
54
- nil?: true
55
-
56
- # @!attribute expected_messaging_volume
57
- # Expected daily messaging volume
58
- #
59
- # @return [String, nil]
60
- optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
61
-
62
- # @!attribute is_tcr_application
63
- # Whether this is a TCR (Campaign Registry) application
64
- #
65
- # @return [Boolean, nil]
66
- optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true
67
-
68
- # @!attribute notes
69
- # Additional notes about the business or use case
70
- #
71
- # @return [String, nil]
72
- optional :notes, String, nil?: true
73
-
74
- # @!attribute phone_number_prefix
75
- # Phone number prefix for messaging (e.g., "+1")
76
- #
77
- # @return [String, nil]
78
- optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
79
-
80
- # @!attribute primary_use_case
81
- # Primary messaging use case description
82
- #
83
- # @return [String, nil]
84
- optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
85
-
86
- # @!method initialize(brand_relationship:, vertical:, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil)
87
- # Compliance and TCR-related information
88
- #
89
- # @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship] Brand relationship level with TCR (required for TCR)
90
- #
91
- # @param vertical [Symbol, Sentdm::Models::TcrVertical] Business vertical/industry category (required for TCR)
92
- #
93
- # @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
94
- #
95
- # @param expected_messaging_volume [String, nil] Expected daily messaging volume
96
- #
97
- # @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
98
- #
99
- # @param notes [String, nil] Additional notes about the business or use case
100
- #
101
- # @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
102
- #
103
- # @param primary_use_case [String, nil] Primary messaging use case description
104
- end
105
-
106
- # @see Sentdm::Models::BrandsBrandData#contact
107
- class Contact < Sentdm::Internal::Type::BaseModel
108
- # @!attribute name
109
- # Primary contact name (required)
110
- #
111
- # @return [String]
112
- required :name, String
113
-
114
- # @!attribute business_name
115
- # Business/brand name
116
- #
117
- # @return [String, nil]
118
- optional :business_name, String, api_name: :businessName, nil?: true
119
-
120
- # @!attribute email
121
- # Contact email address
122
- #
123
- # @return [String, nil]
124
- optional :email, String, nil?: true
125
-
126
- # @!attribute phone
127
- # Contact phone number in E.164 format
128
- #
129
- # @return [String, nil]
130
- optional :phone, String, nil?: true
131
-
132
- # @!attribute phone_country_code
133
- # Contact phone country code (e.g., "1" for US)
134
- #
135
- # @return [String, nil]
136
- optional :phone_country_code, String, api_name: :phoneCountryCode, nil?: true
137
-
138
- # @!attribute role
139
- # Contact's role in the business
140
- #
141
- # @return [String, nil]
142
- optional :role, String, nil?: true
143
-
144
- # @!method initialize(name:, business_name: nil, email: nil, phone: nil, phone_country_code: nil, role: nil)
145
- # Contact information for the brand
146
- #
147
- # @param name [String] Primary contact name (required)
148
- #
149
- # @param business_name [String, nil] Business/brand name
150
- #
151
- # @param email [String, nil] Contact email address
152
- #
153
- # @param phone [String, nil] Contact phone number in E.164 format
154
- #
155
- # @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
156
- #
157
- # @param role [String, nil] Contact's role in the business
158
- end
159
-
160
- # @see Sentdm::Models::BrandsBrandData#business
161
- class Business < Sentdm::Internal::Type::BaseModel
162
- # @!attribute city
163
- # City
164
- #
165
- # @return [String, nil]
166
- optional :city, String, nil?: true
167
-
168
- # @!attribute country
169
- # Country code (e.g., US, CA)
170
- #
171
- # @return [String, nil]
172
- optional :country, String, nil?: true
173
-
174
- # @!attribute country_of_registration
175
- # Country where the business is registered
176
- #
177
- # @return [String, nil]
178
- optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
179
-
180
- # @!attribute entity_type
181
- # Business entity type
182
- #
183
- # @return [Symbol, Sentdm::Models::BrandsBrandData::Business::EntityType, nil]
184
- optional :entity_type,
185
- enum: -> { Sentdm::BrandsBrandData::Business::EntityType },
186
- api_name: :entityType,
187
- nil?: true
188
-
189
- # @!attribute legal_name
190
- # Legal business name
191
- #
192
- # @return [String, nil]
193
- optional :legal_name, String, api_name: :legalName, nil?: true
194
-
195
- # @!attribute postal_code
196
- # Postal/ZIP code
197
- #
198
- # @return [String, nil]
199
- optional :postal_code, String, api_name: :postalCode, nil?: true
200
-
201
- # @!attribute state
202
- # State/province code
203
- #
204
- # @return [String, nil]
205
- optional :state, String, nil?: true
206
-
207
- # @!attribute street
208
- # Street address
209
- #
210
- # @return [String, nil]
211
- optional :street, String, nil?: true
212
-
213
- # @!attribute tax_id
214
- # Tax ID/EIN number
215
- #
216
- # @return [String, nil]
217
- optional :tax_id, String, api_name: :taxId, nil?: true
218
-
219
- # @!attribute tax_id_type
220
- # Type of tax ID (e.g., us_ein, ca_bn)
221
- #
222
- # @return [String, nil]
223
- optional :tax_id_type, String, api_name: :taxIdType, nil?: true
224
-
225
- # @!attribute url
226
- # Business website URL
227
- #
228
- # @return [String, nil]
229
- optional :url, String, nil?: true
230
-
231
- # @!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)
232
- # Business details and address information
233
- #
234
- # @param city [String, nil] City
235
- #
236
- # @param country [String, nil] Country code (e.g., US, CA)
237
- #
238
- # @param country_of_registration [String, nil] Country where the business is registered
239
- #
240
- # @param entity_type [Symbol, Sentdm::Models::BrandsBrandData::Business::EntityType, nil] Business entity type
241
- #
242
- # @param legal_name [String, nil] Legal business name
243
- #
244
- # @param postal_code [String, nil] Postal/ZIP code
245
- #
246
- # @param state [String, nil] State/province code
247
- #
248
- # @param street [String, nil] Street address
249
- #
250
- # @param tax_id [String, nil] Tax ID/EIN number
251
- #
252
- # @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
253
- #
254
- # @param url [String, nil] Business website URL
255
-
256
- # Business entity type
257
- #
258
- # @see Sentdm::Models::BrandsBrandData::Business#entity_type
259
- module EntityType
260
- extend Sentdm::Internal::Type::Enum
261
-
262
- PRIVATE_PROFIT = :PRIVATE_PROFIT
263
- PUBLIC_PROFIT = :PUBLIC_PROFIT
264
- NON_PROFIT = :NON_PROFIT
265
- SOLE_PROPRIETOR = :SOLE_PROPRIETOR
266
- GOVERNMENT = :GOVERNMENT
267
-
268
- # @!method self.values
269
- # @return [Array<Symbol>]
270
- end
271
- end
35
+ # @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address for brand KYC
272
36
  end
273
37
  end
274
38
  end
@@ -32,7 +32,7 @@ module Sentdm
32
32
  #
33
33
  # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
34
34
 
35
- class Body < Sentdm::Models::MutationRequestBase
35
+ class Body < Sentdm::Models::MutationRequest
36
36
  # @!method initialize
37
37
  # Request to delete/dissociate a contact
38
38
  end
@@ -5,19 +5,19 @@ module Sentdm
5
5
  # @see Sentdm::Resources::Contacts#list
6
6
  class ContactListResponse < Sentdm::Internal::Type::BaseModel
7
7
  # @!attribute data
8
- # The response data (null if error)
8
+ # Paginated list of contacts response
9
9
  #
10
10
  # @return [Sentdm::Models::ContactListResponse::Data, nil]
11
11
  optional :data, -> { Sentdm::Models::ContactListResponse::Data }, nil?: true
12
12
 
13
13
  # @!attribute error
14
- # Error details (null if successful)
14
+ # Error information
15
15
  #
16
16
  # @return [Sentdm::Models::APIError, nil]
17
17
  optional :error, -> { Sentdm::APIError }, nil?: true
18
18
 
19
19
  # @!attribute meta
20
- # Metadata about the request and response
20
+ # Request and response metadata
21
21
  #
22
22
  # @return [Sentdm::Models::APIMeta, nil]
23
23
  optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
31
31
  # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
32
32
  # Standard API response envelope for all v3 endpoints
33
33
  #
34
- # @param data [Sentdm::Models::ContactListResponse::Data, nil] The response data (null if error)
34
+ # @param data [Sentdm::Models::ContactListResponse::Data, nil] Paginated list of contacts response
35
35
  #
36
- # @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
36
+ # @param error [Sentdm::Models::APIError, nil] Error information
37
37
  #
38
- # @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
38
+ # @param meta [Sentdm::Models::APIMeta] Request and response metadata
39
39
  #
40
40
  # @param success [Boolean] Indicates whether the request was successful
41
41
 
@@ -48,17 +48,17 @@ module Sentdm
48
48
  optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactResponse] }
49
49
 
50
50
  # @!attribute pagination
51
- # Pagination metadata
51
+ # Pagination metadata for list responses
52
52
  #
53
53
  # @return [Sentdm::Models::PaginationMeta, nil]
54
54
  optional :pagination, -> { Sentdm::PaginationMeta }
55
55
 
56
56
  # @!method initialize(contacts: nil, pagination: nil)
57
- # The response data (null if error)
57
+ # Paginated list of contacts response
58
58
  #
59
59
  # @param contacts [Array<Sentdm::Models::ContactResponse>] List of contacts
60
60
  #
61
- # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
61
+ # @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
62
62
  end
63
63
  end
64
64
  end