Skip to content

Commit cbc6906

Browse files
chore: modify sorbet initializers to better support auto-completion (#115)
1 parent 0c64668 commit cbc6906

File tree

196 files changed

+3836
-3487
lines changed

Some content is hidden

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

196 files changed

+3836
-3487
lines changed

rbi/lib/orb/base_client.rbi

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ module Orb
4545

4646
class << self
4747
sig { params(req: Orb::BaseClient::RequestComponentsShape).void }
48-
def self.validate!(req)
48+
def validate!(req)
4949
end
5050

5151
sig do
5252
params(status: Integer, headers: T.any(T::Hash[String, String], Net::HTTPHeader)).returns(T::Boolean)
5353
end
54-
def self.should_retry?(status, headers:)
54+
def should_retry?(status, headers:)
5555
end
5656

5757
sig do
@@ -62,7 +62,7 @@ module Orb
6262
)
6363
.returns(Orb::BaseClient::RequestInputShape)
6464
end
65-
def self.follow_redirect(request, status:, response_headers:)
65+
def follow_redirect(request, status:, response_headers:)
6666
end
6767
end
6868

@@ -85,9 +85,9 @@ module Orb
8585
T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))],
8686
idempotency_header: T.nilable(String)
8787
)
88-
.void
88+
.returns(T.attached_class)
8989
end
90-
def initialize(
90+
def self.new(
9191
base_url:,
9292
timeout: 0.0,
9393
max_retries: 0,

rbi/lib/orb/base_model.rbi

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -279,9 +279,9 @@ module Orb
279279
),
280280
spec: T::Hash[Symbol, T.anything]
281281
)
282-
.void
282+
.returns(T.attached_class)
283283
end
284-
def initialize(type_info, spec = {})
284+
def self.new(type_info, spec = {})
285285
end
286286
end
287287

@@ -335,9 +335,9 @@ module Orb
335335
),
336336
spec: T::Hash[Symbol, T.anything]
337337
)
338-
.void
338+
.returns(T.attached_class)
339339
end
340-
def initialize(type_info, spec = {})
340+
def self.new(type_info, spec = {})
341341
end
342342
end
343343

@@ -471,8 +471,8 @@ module Orb
471471
def deconstruct_keys(keys)
472472
end
473473

474-
sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).void }
475-
def initialize(data = {})
474+
sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(T.attached_class) }
475+
def self.new(data = {})
476476
end
477477

478478
sig { returns(String) }

rbi/lib/orb/client.rbi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,9 +84,9 @@ module Orb
8484
max_retry_delay: Float,
8585
idempotency_header: String
8686
)
87-
.void
87+
.returns(T.attached_class)
8888
end
89-
def initialize(
89+
def self.new(
9090
base_url: nil,
9191
api_key: ENV["ORB_API_KEY"],
9292
max_retries: DEFAULT_MAX_RETRIES,

rbi/lib/orb/errors.rbi

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,9 @@ module Orb
3232
response: NilClass,
3333
message: T.nilable(String)
3434
)
35-
.void
35+
.returns(T.attached_class)
3636
end
37-
def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
37+
def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
3838
end
3939
end
4040

@@ -56,9 +56,9 @@ module Orb
5656
response: NilClass,
5757
message: T.nilable(String)
5858
)
59-
.void
59+
.returns(T.attached_class)
6060
end
61-
def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
61+
def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
6262
end
6363
end
6464

@@ -72,9 +72,9 @@ module Orb
7272
response: NilClass,
7373
message: T.nilable(String)
7474
)
75-
.void
75+
.returns(T.attached_class)
7676
end
77-
def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
77+
def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
7878
end
7979
end
8080

@@ -106,9 +106,9 @@ module Orb
106106
response: NilClass,
107107
message: T.nilable(String)
108108
)
109-
.void
109+
.returns(T.attached_class)
110110
end
111-
def initialize(url:, status:, body:, request:, response:, message: nil)
111+
def self.new(url:, status:, body:, request:, response:, message: nil)
112112
end
113113
end
114114

rbi/lib/orb/models/alert.rbi

Lines changed: 13 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -101,20 +101,9 @@ module Orb
101101
thresholds: T.nilable(T::Array[Orb::Models::Alert::Threshold]),
102102
type: Symbol
103103
)
104-
.void
105-
end
106-
def initialize(
107-
id:,
108-
created_at:,
109-
currency:,
110-
customer:,
111-
enabled:,
112-
metric:,
113-
plan:,
114-
subscription:,
115-
thresholds:,
116-
type:
117-
)
104+
.returns(T.attached_class)
105+
end
106+
def self.new(id:, created_at:, currency:, customer:, enabled:, metric:, plan:, subscription:, thresholds:, type:)
118107
end
119108

120109
sig do
@@ -154,8 +143,8 @@ module Orb
154143
def external_customer_id=(_)
155144
end
156145

157-
sig { params(id: String, external_customer_id: T.nilable(String)).void }
158-
def initialize(id:, external_customer_id:)
146+
sig { params(id: String, external_customer_id: T.nilable(String)).returns(T.attached_class) }
147+
def self.new(id:, external_customer_id:)
159148
end
160149

161150
sig { override.returns({id: String, external_customer_id: T.nilable(String)}) }
@@ -172,8 +161,8 @@ module Orb
172161
def id=(_)
173162
end
174163

175-
sig { params(id: String).void }
176-
def initialize(id:)
164+
sig { params(id: String).returns(T.attached_class) }
165+
def self.new(id:)
177166
end
178167

179168
sig { override.returns({id: String}) }
@@ -221,9 +210,9 @@ module Orb
221210
name: T.nilable(String),
222211
plan_version: String
223212
)
224-
.void
213+
.returns(T.attached_class)
225214
end
226-
def initialize(id:, external_plan_id:, name:, plan_version:)
215+
def self.new(id:, external_plan_id:, name:, plan_version:)
227216
end
228217

229218
sig do
@@ -250,8 +239,8 @@ module Orb
250239
def id=(_)
251240
end
252241

253-
sig { params(id: String).void }
254-
def initialize(id:)
242+
sig { params(id: String).returns(T.attached_class) }
243+
def self.new(id:)
255244
end
256245

257246
sig { override.returns({id: String}) }
@@ -268,8 +257,8 @@ module Orb
268257
def value=(_)
269258
end
270259

271-
sig { params(value: Float).void }
272-
def initialize(value:)
260+
sig { params(value: Float).returns(T.attached_class) }
261+
def self.new(value:)
273262
end
274263

275264
sig { override.returns({value: Float}) }

rbi/lib/orb/models/alert_create_for_customer_params.rbi

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ module Orb
4040
thresholds: T.nilable(T::Array[Orb::Models::AlertCreateForCustomerParams::Threshold]),
4141
request_options: T.any(Orb::RequestOptions, T::Hash[Symbol, T.anything])
4242
)
43-
.void
43+
.returns(T.attached_class)
4444
end
45-
def initialize(currency:, type:, thresholds: nil, request_options: {})
45+
def self.new(currency:, type:, thresholds: nil, request_options: {})
4646
end
4747

4848
sig do
@@ -82,8 +82,8 @@ module Orb
8282
def value=(_)
8383
end
8484

85-
sig { params(value: Float).void }
86-
def initialize(value:)
85+
sig { params(value: Float).returns(T.attached_class) }
86+
def self.new(value:)
8787
end
8888

8989
sig { override.returns({value: Float}) }

rbi/lib/orb/models/alert_create_for_external_customer_params.rbi

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ module Orb
4040
thresholds: T.nilable(T::Array[Orb::Models::AlertCreateForExternalCustomerParams::Threshold]),
4141
request_options: T.any(Orb::RequestOptions, T::Hash[Symbol, T.anything])
4242
)
43-
.void
43+
.returns(T.attached_class)
4444
end
45-
def initialize(currency:, type:, thresholds: nil, request_options: {})
45+
def self.new(currency:, type:, thresholds: nil, request_options: {})
4646
end
4747

4848
sig do
@@ -82,8 +82,8 @@ module Orb
8282
def value=(_)
8383
end
8484

85-
sig { params(value: Float).void }
86-
def initialize(value:)
85+
sig { params(value: Float).returns(T.attached_class) }
86+
def self.new(value:)
8787
end
8888

8989
sig { override.returns({value: Float}) }

rbi/lib/orb/models/alert_create_for_subscription_params.rbi

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,9 @@ module Orb
4040
metric_id: T.nilable(String),
4141
request_options: T.any(Orb::RequestOptions, T::Hash[Symbol, T.anything])
4242
)
43-
.void
43+
.returns(T.attached_class)
4444
end
45-
def initialize(thresholds:, type:, metric_id: nil, request_options: {})
45+
def self.new(thresholds:, type:, metric_id: nil, request_options: {})
4646
end
4747

4848
sig do
@@ -68,8 +68,8 @@ module Orb
6868
def value=(_)
6969
end
7070

71-
sig { params(value: Float).void }
72-
def initialize(value:)
71+
sig { params(value: Float).returns(T.attached_class) }
72+
def self.new(value:)
7373
end
7474

7575
sig { override.returns({value: Float}) }

rbi/lib/orb/models/alert_disable_params.rbi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ module Orb
1919
subscription_id: T.nilable(String),
2020
request_options: T.any(Orb::RequestOptions, T::Hash[Symbol, T.anything])
2121
)
22-
.void
22+
.returns(T.attached_class)
2323
end
24-
def initialize(subscription_id: nil, request_options: {})
24+
def self.new(subscription_id: nil, request_options: {})
2525
end
2626

2727
sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }

rbi/lib/orb/models/alert_enable_params.rbi

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@ module Orb
1919
subscription_id: T.nilable(String),
2020
request_options: T.any(Orb::RequestOptions, T::Hash[Symbol, T.anything])
2121
)
22-
.void
22+
.returns(T.attached_class)
2323
end
24-
def initialize(subscription_id: nil, request_options: {})
24+
def self.new(subscription_id: nil, request_options: {})
2525
end
2626

2727
sig { override.returns({subscription_id: T.nilable(String), request_options: Orb::RequestOptions}) }

0 commit comments

Comments
 (0)