Skip to content

Commit 631adad

Browse files
author
stlc-bot
committed
feat(api): repoint dangling model refs at current v3 schema names
Stainless-Generated-From: 884180689b53645798828942333abf0c06c0f073
1 parent 0cb3380 commit 631adad

271 files changed

Lines changed: 10893 additions & 41325 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎README.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -256,6 +256,32 @@ params = Sentdm::MessageSendParams.new(
256256
sent.messages.send_(**params)
257257
```
258258

259+
### Enums
260+
261+
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:
262+
263+
```ruby
264+
# :PRIVATE_PROFIT
265+
puts(Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT)
266+
267+
# Revealed type: `T.all(Sentdm::BrandBusinessInfo::EntityType, Symbol)`
268+
T.reveal_type(Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT)
269+
```
270+
271+
Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
272+
273+
```ruby
274+
Sentdm::BrandBusinessInfo.new(
275+
entity_type: Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT,
276+
# …
277+
)
278+
279+
Sentdm::BrandBusinessInfo.new(
280+
entity_type: :PRIVATE_PROFIT,
281+
# …
282+
)
283+
```
284+
259285
## Versioning
260286

261287
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.

‎lib/sentdm.rb‎

Lines changed: 32 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -52,23 +52,35 @@
5252
require_relative "sentdm/internal/transport/base_client"
5353
require_relative "sentdm/internal/transport/pooled_net_requester"
5454
require_relative "sentdm/client"
55+
require_relative "sentdm/models/mutation_request"
56+
require_relative "sentdm/models/api_meta"
57+
require_relative "sentdm/models/api_response_of_contact"
58+
require_relative "sentdm/models/api_response_of_contact_message_summary"
59+
require_relative "sentdm/models/api_response_of_conversation_messages_list"
60+
require_relative "sentdm/models/api_response_of_profile_detail"
61+
require_relative "sentdm/models/api_response_of_user"
62+
require_relative "sentdm/models/api_response_template"
63+
require_relative "sentdm/models/api_response_webhook"
5564
require_relative "sentdm/models/authentication_config"
65+
require_relative "sentdm/models/billing_contact_info"
66+
require_relative "sentdm/models/brand_business_info"
67+
require_relative "sentdm/models/brand_compliance_info"
68+
require_relative "sentdm/models/brand_contact_info"
69+
require_relative "sentdm/models/brands_brand_data"
5670
require_relative "sentdm/models/contact_create_params"
57-
require_relative "sentdm/models/contact_create_response"
5871
require_relative "sentdm/models/contact_delete_params"
5972
require_relative "sentdm/models/contact_list_params"
6073
require_relative "sentdm/models/contact_list_response"
74+
require_relative "sentdm/models/contact_message_summary"
75+
require_relative "sentdm/models/contact_response"
6176
require_relative "sentdm/models/contact_retrieve_message_summary_params"
62-
require_relative "sentdm/models/contact_retrieve_message_summary_response"
6377
require_relative "sentdm/models/contact_retrieve_params"
64-
require_relative "sentdm/models/contact_retrieve_response"
6578
require_relative "sentdm/models/contact_update_params"
66-
require_relative "sentdm/models/contact_update_response"
6779
require_relative "sentdm/models/conversation_list_messages_params"
68-
require_relative "sentdm/models/conversation_list_messages_response"
6980
require_relative "sentdm/models/conversation_list_params"
70-
require_relative "sentdm/models/conversation_list_response"
81+
require_relative "sentdm/models/conversation_messages_list"
7182
require_relative "sentdm/models/destination_country"
83+
require_relative "sentdm/models/error_detail"
7284
require_relative "sentdm/models/inbound_message_event"
7385
require_relative "sentdm/models/inbound_message_event_payload"
7486
require_relative "sentdm/models/me_retrieve_params"
@@ -83,33 +95,37 @@
8395
require_relative "sentdm/models/message_send_response"
8496
require_relative "sentdm/models/number_lookup_params"
8597
require_relative "sentdm/models/number_lookup_response"
98+
require_relative "sentdm/models/pagination_meta"
99+
require_relative "sentdm/models/payment_details"
86100
require_relative "sentdm/models/profile_complete_params"
87101
require_relative "sentdm/models/profile_complete_response"
88102
require_relative "sentdm/models/profile_create_params"
89-
require_relative "sentdm/models/profile_create_response"
90103
require_relative "sentdm/models/profile_delete_params"
104+
require_relative "sentdm/models/profile_detail"
91105
require_relative "sentdm/models/profile_list_params"
92106
require_relative "sentdm/models/profile_list_response"
93107
require_relative "sentdm/models/profile_retrieve_params"
94-
require_relative "sentdm/models/profile_retrieve_response"
108+
require_relative "sentdm/models/profiles/api_response_of_brand_campaign"
109+
require_relative "sentdm/models/profiles/api_response_of_list_of_brand_campaign"
110+
require_relative "sentdm/models/profiles/brand_campaign"
95111
require_relative "sentdm/models/profiles/campaign_create_params"
96-
require_relative "sentdm/models/profiles/campaign_create_response"
112+
require_relative "sentdm/models/profiles/campaign_data"
97113
require_relative "sentdm/models/profiles/campaign_delete_params"
98114
require_relative "sentdm/models/profiles/campaign_list_params"
99-
require_relative "sentdm/models/profiles/campaign_list_response"
100115
require_relative "sentdm/models/profiles/campaign_update_params"
101-
require_relative "sentdm/models/profiles/campaign_update_response"
116+
require_relative "sentdm/models/profiles/campaign_use_case"
117+
require_relative "sentdm/models/profiles/campaign_use_case_data"
102118
require_relative "sentdm/models/profiles/messaging_use_case_us"
119+
require_relative "sentdm/models/profile_settings"
103120
require_relative "sentdm/models/profile_update_params"
104-
require_relative "sentdm/models/profile_update_response"
105121
require_relative "sentdm/models/tcr_brand_relationship"
106122
require_relative "sentdm/models/tcr_vertical"
123+
require_relative "sentdm/models/template"
107124
require_relative "sentdm/models/template_body"
108125
require_relative "sentdm/models/template_body_content"
109126
require_relative "sentdm/models/template_button"
110127
require_relative "sentdm/models/template_button_props"
111128
require_relative "sentdm/models/template_create_params"
112-
require_relative "sentdm/models/template_create_response"
113129
require_relative "sentdm/models/template_definition"
114130
require_relative "sentdm/models/template_delete_params"
115131
require_relative "sentdm/models/template_event"
@@ -119,38 +135,32 @@
119135
require_relative "sentdm/models/template_list_params"
120136
require_relative "sentdm/models/template_list_response"
121137
require_relative "sentdm/models/template_retrieve_params"
122-
require_relative "sentdm/models/template_retrieve_response"
123138
require_relative "sentdm/models/template_update_params"
124-
require_relative "sentdm/models/template_update_response"
125139
require_relative "sentdm/models/template_variable"
126140
require_relative "sentdm/models/user_invite_params"
127-
require_relative "sentdm/models/user_invite_response"
128141
require_relative "sentdm/models/user_list_params"
129142
require_relative "sentdm/models/user_list_response"
130143
require_relative "sentdm/models/user_remove_params"
144+
require_relative "sentdm/models/user_response"
131145
require_relative "sentdm/models/user_retrieve_params"
132-
require_relative "sentdm/models/user_retrieve_response"
133146
require_relative "sentdm/models/user_update_role_params"
134-
require_relative "sentdm/models/user_update_role_response"
135147
require_relative "sentdm/models/webhook_create_params"
136-
require_relative "sentdm/models/webhook_create_response"
137148
require_relative "sentdm/models/webhook_delete_params"
149+
require_relative "sentdm/models/webhook_event_type"
138150
require_relative "sentdm/models/webhook_list_events_params"
139151
require_relative "sentdm/models/webhook_list_events_response"
140152
require_relative "sentdm/models/webhook_list_event_types_params"
141153
require_relative "sentdm/models/webhook_list_event_types_response"
142154
require_relative "sentdm/models/webhook_list_params"
143155
require_relative "sentdm/models/webhook_list_response"
156+
require_relative "sentdm/models/webhook_response"
144157
require_relative "sentdm/models/webhook_retrieve_params"
145-
require_relative "sentdm/models/webhook_retrieve_response"
146158
require_relative "sentdm/models/webhook_rotate_secret_params"
147159
require_relative "sentdm/models/webhook_rotate_secret_response"
148160
require_relative "sentdm/models/webhook_test_params"
149161
require_relative "sentdm/models/webhook_test_response"
150162
require_relative "sentdm/models/webhook_toggle_status_params"
151-
require_relative "sentdm/models/webhook_toggle_status_response"
152163
require_relative "sentdm/models/webhook_update_params"
153-
require_relative "sentdm/models/webhook_update_response"
154164
require_relative "sentdm/models"
155165
require_relative "sentdm/resources/contacts"
156166
require_relative "sentdm/resources/conversations"

‎lib/sentdm/internal/type/base_model.rb‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -438,11 +438,11 @@ def deep_to_h = self.class.recursively_to_h(@data, convert: false)
438438
# @return [Hash{Symbol=>Object}]
439439
#
440440
# @example
441-
# # `inbound_message_event` is a `Sentdm::InboundMessageEvent`
442-
# inbound_message_event => {
443-
# event: event,
444-
# field: field,
445-
# payload: payload
441+
# # `api_meta` is a `Sentdm::APIMeta`
442+
# api_meta => {
443+
# request_id: request_id,
444+
# timestamp: timestamp,
445+
# version: version
446446
# }
447447
def deconstruct_keys(keys)
448448
(keys || self.class.known_fields.keys)

‎lib/sentdm/models.rb‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,44 @@ module Sentdm
3939
mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
4040
end
4141

42+
APIMeta = Sentdm::Models::APIMeta
43+
44+
APIResponseOfContact = Sentdm::Models::APIResponseOfContact
45+
46+
APIResponseOfContactMessageSummary = Sentdm::Models::APIResponseOfContactMessageSummary
47+
48+
APIResponseOfConversationMessagesList = Sentdm::Models::APIResponseOfConversationMessagesList
49+
50+
APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
51+
52+
APIResponseOfUser = Sentdm::Models::APIResponseOfUser
53+
54+
APIResponseTemplate = Sentdm::Models::APIResponseTemplate
55+
56+
APIResponseWebhook = Sentdm::Models::APIResponseWebhook
57+
4258
AuthenticationConfig = Sentdm::Models::AuthenticationConfig
4359

60+
BillingContactInfo = Sentdm::Models::BillingContactInfo
61+
62+
BrandBusinessInfo = Sentdm::Models::BrandBusinessInfo
63+
64+
BrandComplianceInfo = Sentdm::Models::BrandComplianceInfo
65+
66+
BrandContactInfo = Sentdm::Models::BrandContactInfo
67+
68+
BrandsBrandData = Sentdm::Models::BrandsBrandData
69+
4470
ContactCreateParams = Sentdm::Models::ContactCreateParams
4571

4672
ContactDeleteParams = Sentdm::Models::ContactDeleteParams
4773

4874
ContactListParams = Sentdm::Models::ContactListParams
4975

76+
ContactMessageSummary = Sentdm::Models::ContactMessageSummary
77+
78+
ContactResponse = Sentdm::Models::ContactResponse
79+
5080
ContactRetrieveMessageSummaryParams = Sentdm::Models::ContactRetrieveMessageSummaryParams
5181

5282
ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
@@ -57,8 +87,12 @@ module Sentdm
5787

5888
ConversationListParams = Sentdm::Models::ConversationListParams
5989

90+
ConversationMessagesList = Sentdm::Models::ConversationMessagesList
91+
6092
DestinationCountry = Sentdm::Models::DestinationCountry
6193

94+
ErrorDetail = Sentdm::Models::ErrorDetail
95+
6296
InboundMessageEvent = Sentdm::Models::InboundMessageEvent
6397

6498
InboundMessageEventPayload = Sentdm::Models::InboundMessageEventPayload
@@ -75,26 +109,38 @@ module Sentdm
75109

76110
MessageSendParams = Sentdm::Models::MessageSendParams
77111

112+
MutationRequest = Sentdm::Models::MutationRequest
113+
78114
NumberLookupParams = Sentdm::Models::NumberLookupParams
79115

116+
PaginationMeta = Sentdm::Models::PaginationMeta
117+
118+
PaymentDetails = Sentdm::Models::PaymentDetails
119+
80120
ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
81121

82122
ProfileCreateParams = Sentdm::Models::ProfileCreateParams
83123

84124
ProfileDeleteParams = Sentdm::Models::ProfileDeleteParams
85125

126+
ProfileDetail = Sentdm::Models::ProfileDetail
127+
86128
ProfileListParams = Sentdm::Models::ProfileListParams
87129

88130
ProfileRetrieveParams = Sentdm::Models::ProfileRetrieveParams
89131

90132
Profiles = Sentdm::Models::Profiles
91133

134+
ProfileSettings = Sentdm::Models::ProfileSettings
135+
92136
ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
93137

94138
TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
95139

96140
TcrVertical = Sentdm::Models::TcrVertical
97141

142+
Template = Sentdm::Models::Template
143+
98144
TemplateBody = Sentdm::Models::TemplateBody
99145

100146
TemplateBodyContent = Sentdm::Models::TemplateBodyContent
@@ -131,6 +177,8 @@ module Sentdm
131177

132178
UserRemoveParams = Sentdm::Models::UserRemoveParams
133179

180+
UserResponse = Sentdm::Models::UserResponse
181+
134182
UserRetrieveParams = Sentdm::Models::UserRetrieveParams
135183

136184
UserUpdateRoleParams = Sentdm::Models::UserUpdateRoleParams
@@ -139,12 +187,16 @@ module Sentdm
139187

140188
WebhookDeleteParams = Sentdm::Models::WebhookDeleteParams
141189

190+
WebhookEventType = Sentdm::Models::WebhookEventType
191+
142192
WebhookListEventsParams = Sentdm::Models::WebhookListEventsParams
143193

144194
WebhookListEventTypesParams = Sentdm::Models::WebhookListEventTypesParams
145195

146196
WebhookListParams = Sentdm::Models::WebhookListParams
147197

198+
WebhookResponse = Sentdm::Models::WebhookResponse
199+
148200
WebhookRetrieveParams = Sentdm::Models::WebhookRetrieveParams
149201

150202
WebhookRotateSecretParams = Sentdm::Models::WebhookRotateSecretParams

‎lib/sentdm/models/api_meta.rb‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# frozen_string_literal: true
2+
3+
module Sentdm
4+
module Models
5+
class APIMeta < Sentdm::Internal::Type::BaseModel
6+
# @!attribute request_id
7+
# Unique identifier for this request (for tracing and support)
8+
#
9+
# @return [String, nil]
10+
optional :request_id, String
11+
12+
# @!attribute timestamp
13+
# Server timestamp when the response was generated
14+
#
15+
# @return [Time, nil]
16+
optional :timestamp, Time
17+
18+
# @!attribute version
19+
# API version used for this request
20+
#
21+
# @return [String, nil]
22+
optional :version, String
23+
24+
# @!method initialize(request_id: nil, timestamp: nil, version: nil)
25+
# Request and response metadata
26+
#
27+
# @param request_id [String] Unique identifier for this request (for tracing and support)
28+
#
29+
# @param timestamp [Time] Server timestamp when the response was generated
30+
#
31+
# @param version [String] API version used for this request
32+
end
33+
end
34+
end

‎lib/sentdm/models/api_response_of_contact.rb‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# frozen_string_literal: true
2+
3+
module Sentdm
4+
module Models
5+
# @see Sentdm::Resources::Contacts#create
6+
class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
7+
# @!attribute data
8+
# Contact response for v3 API Uses snake_case for JSON property names
9+
#
10+
# @return [Sentdm::Models::ContactResponse, nil]
11+
optional :data, -> { Sentdm::ContactResponse }, nil?: true
12+
13+
# @!attribute error
14+
# Error information
15+
#
16+
# @return [Sentdm::Models::ErrorDetail, nil]
17+
optional :error, -> { Sentdm::ErrorDetail }, nil?: true
18+
19+
# @!attribute meta
20+
# Request and response metadata
21+
#
22+
# @return [Sentdm::Models::APIMeta, nil]
23+
optional :meta, -> { Sentdm::APIMeta }
24+
25+
# @!attribute success
26+
# Indicates whether the request was successful
27+
#
28+
# @return [Boolean, nil]
29+
optional :success, Sentdm::Internal::Type::Boolean
30+
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+
#
35+
# Standard API response envelope for all v3 endpoints
36+
#
37+
# @param data [Sentdm::Models::ContactResponse, nil] Contact response for v3 API
38+
#
39+
# @param error [Sentdm::Models::ErrorDetail, nil] Error information
40+
#
41+
# @param meta [Sentdm::Models::APIMeta] Request and response metadata
42+
#
43+
# @param success [Boolean] Indicates whether the request was successful
44+
end
45+
end
46+
end

0 commit comments

Comments
 (0)