Skip to content

Commit 79656f0

Browse files
fern-api[bot]fern-api[bot]
authored
🌿 Fern Regeneration -- November 18, 2024 (#2)
This PR regenerates code to match the latest API Definition. Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
1 parent 12f4629 commit 79656f0

25 files changed

+506
-176
lines changed

‎lib/requests.rb‎

Lines changed: 28 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,27 @@
77

88
module SSOReady
99
class RequestClient
10-
# @return [Hash{String => String}]
11-
attr_reader :headers
1210
# @return [Faraday]
1311
attr_reader :conn
1412
# @return [String]
1513
attr_reader :base_url
1614
# @return [String]
15+
attr_reader :api_key
16+
# @return [String]
1717
attr_reader :default_environment
1818

19-
# @param environment [SSOReady::Environment]
2019
# @param base_url [String]
20+
# @param environment [SSOReady::Environment]
2121
# @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
2222
# @param timeout_in_seconds [Long]
2323
# @param api_key [String]
2424
# @return [SSOReady::RequestClient]
25-
def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_retries: nil,
26-
timeout_in_seconds: nil, api_key: nil)
25+
def initialize(base_url: nil, environment: SSOReady::Environment::DEFAULT, max_retries: nil,
26+
timeout_in_seconds: nil, api_key: ENV["SSOREADY_API_KEY"])
2727
@default_environment = environment
2828
@base_url = environment || base_url
29-
@headers = {
30-
"X-Fern-Language": "Ruby",
31-
"X-Fern-SDK-Name": "ssoready",
32-
"X-Fern-SDK-Version": "0.1.0",
33-
"Authorization": %(Bearer #{api_key || ENV["SSOREADY_API_KEY"]})
34-
}
35-
@conn = Faraday.new(headers: @headers) do |faraday|
29+
@api_key = "Bearer #{api_key}"
30+
@conn = Faraday.new do |faraday|
3631
faraday.request :json
3732
faraday.response :raise_error, include_request: true
3833
faraday.request :retry, { max: max_retries } unless max_retries.nil?
@@ -45,35 +40,37 @@ def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_r
4540
def get_url(request_options: nil)
4641
request_options&.base_url || @default_environment || @base_url
4742
end
43+
44+
# @return [Hash{String => String}]
45+
def get_headers
46+
headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "ssoready", "X-Fern-SDK-Version": "1.0.0" }
47+
headers["Authorization"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
48+
headers
49+
end
4850
end
4951

5052
class AsyncRequestClient
51-
# @return [Hash{String => String}]
52-
attr_reader :headers
5353
# @return [Faraday]
5454
attr_reader :conn
5555
# @return [String]
5656
attr_reader :base_url
5757
# @return [String]
58+
attr_reader :api_key
59+
# @return [String]
5860
attr_reader :default_environment
5961

60-
# @param environment [SSOReady::Environment]
6162
# @param base_url [String]
63+
# @param environment [SSOReady::Environment]
6264
# @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
6365
# @param timeout_in_seconds [Long]
6466
# @param api_key [String]
6567
# @return [SSOReady::AsyncRequestClient]
66-
def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_retries: nil,
67-
timeout_in_seconds: nil, api_key: nil)
68+
def initialize(base_url: nil, environment: SSOReady::Environment::DEFAULT, max_retries: nil,
69+
timeout_in_seconds: nil, api_key: ENV["SSOREADY_API_KEY"])
6870
@default_environment = environment
6971
@base_url = environment || base_url
70-
@headers = {
71-
"X-Fern-Language": "Ruby",
72-
"X-Fern-SDK-Name": "ssoready",
73-
"X-Fern-SDK-Version": "0.1.0",
74-
"Authorization": %(Bearer #{api_key || ENV["SSOREADY_API_KEY"]})
75-
}
76-
@conn = Faraday.new(headers: @headers) do |faraday|
72+
@api_key = "Bearer #{api_key}"
73+
@conn = Faraday.new do |faraday|
7774
faraday.request :json
7875
faraday.response :raise_error, include_request: true
7976
faraday.adapter :async_http
@@ -87,6 +84,13 @@ def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_r
8784
def get_url(request_options: nil)
8885
request_options&.base_url || @default_environment || @base_url
8986
end
87+
88+
# @return [Hash{String => String}]
89+
def get_headers
90+
headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "ssoready", "X-Fern-SDK-Version": "1.0.0" }
91+
headers["Authorization"] = ((@api_key.is_a? Method) ? @api_key.call : @api_key) unless @api_key.nil?
92+
headers
93+
end
9094
end
9195

9296
# Additional options for request-specific configuration when calling APIs via the

‎lib/ssoready.rb‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,17 +16,17 @@ class Client
1616
# @return [SSOReady::Management::Client]
1717
attr_reader :management
1818

19-
# @param environment [SSOReady::Environment]
2019
# @param base_url [String]
20+
# @param environment [SSOReady::Environment]
2121
# @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
2222
# @param timeout_in_seconds [Long]
2323
# @param api_key [String]
2424
# @return [SSOReady::Client]
25-
def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_retries: nil,
26-
timeout_in_seconds: nil, api_key: nil)
25+
def initialize(base_url: nil, environment: SSOReady::Environment::DEFAULT, max_retries: nil,
26+
timeout_in_seconds: nil, api_key: ENV["SSOREADY_API_KEY"])
2727
@request_client = SSOReady::RequestClient.new(
28-
environment: environment,
2928
base_url: base_url,
29+
environment: environment,
3030
max_retries: max_retries,
3131
timeout_in_seconds: timeout_in_seconds,
3232
api_key: api_key
@@ -45,17 +45,17 @@ class AsyncClient
4545
# @return [SSOReady::Management::AsyncClient]
4646
attr_reader :management
4747

48-
# @param environment [SSOReady::Environment]
4948
# @param base_url [String]
49+
# @param environment [SSOReady::Environment]
5050
# @param max_retries [Long] The number of times to retry a failed request, defaults to 2.
5151
# @param timeout_in_seconds [Long]
5252
# @param api_key [String]
5353
# @return [SSOReady::AsyncClient]
54-
def initialize(environment: SSOReady::Environment::DEFAULT, base_url: nil, max_retries: nil,
55-
timeout_in_seconds: nil, api_key: nil)
54+
def initialize(base_url: nil, environment: SSOReady::Environment::DEFAULT, max_retries: nil,
55+
timeout_in_seconds: nil, api_key: ENV["SSOREADY_API_KEY"])
5656
@async_request_client = SSOReady::AsyncRequestClient.new(
57-
environment: environment,
5857
base_url: base_url,
58+
environment: environment,
5959
max_retries: max_retries,
6060
timeout_in_seconds: timeout_in_seconds,
6161
api_key: api_key

‎lib/ssoready/management/organizations/client.rb‎

Lines changed: 78 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -27,17 +27,24 @@ def initialize(request_client:)
2727
# @return [SSOReady::ListOrganizationsResponse]
2828
# @example
2929
# api = SSOReady::Client.new(
30-
# environment: SSOReady::Environment::DEFAULT,
3130
# base_url: "https://api.example.com",
31+
# environment: SSOReady::Environment::DEFAULT,
3232
# api_key: "YOUR_AUTH_TOKEN"
3333
# )
3434
# api.management.organizations.list_organizations
3535
def list_organizations(page_token: nil, request_options: nil)
3636
response = @request_client.conn.get do |req|
3737
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
3838
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
39-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
39+
req.headers = {
40+
**(req.headers || {}),
41+
**@request_client.get_headers,
42+
**(request_options&.additional_headers || {})
43+
}.compact
4044
req.params = { **(request_options&.additional_query_parameters || {}), "pageToken": page_token }.compact
45+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
46+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
47+
end
4148
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
4249
end
4350
SSOReady::ListOrganizationsResponse.from_json(json_object: response.body)
@@ -55,16 +62,23 @@ def list_organizations(page_token: nil, request_options: nil)
5562
# @return [SSOReady::CreateOrganizationResponse]
5663
# @example
5764
# api = SSOReady::Client.new(
58-
# environment: SSOReady::Environment::DEFAULT,
5965
# base_url: "https://api.example.com",
66+
# environment: SSOReady::Environment::DEFAULT,
6067
# api_key: "YOUR_AUTH_TOKEN"
6168
# )
6269
# api.management.organizations.create_organization(request: { })
6370
def create_organization(request:, request_options: nil)
6471
response = @request_client.conn.post do |req|
6572
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
6673
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
67-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
74+
req.headers = {
75+
**(req.headers || {}),
76+
**@request_client.get_headers,
77+
**(request_options&.additional_headers || {})
78+
}.compact
79+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
80+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
81+
end
6882
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
6983
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
7084
end
@@ -78,16 +92,26 @@ def create_organization(request:, request_options: nil)
7892
# @return [SSOReady::GetOrganizationResponse]
7993
# @example
8094
# api = SSOReady::Client.new(
81-
# environment: SSOReady::Environment::DEFAULT,
8295
# base_url: "https://api.example.com",
96+
# environment: SSOReady::Environment::DEFAULT,
8397
# api_key: "YOUR_AUTH_TOKEN"
8498
# )
8599
# api.management.organizations.get_organization(id: "id")
86100
def get_organization(id:, request_options: nil)
87101
response = @request_client.conn.get do |req|
88102
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
89103
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
90-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
104+
req.headers = {
105+
**(req.headers || {}),
106+
**@request_client.get_headers,
107+
**(request_options&.additional_headers || {})
108+
}.compact
109+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
110+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
111+
end
112+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
113+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
114+
end
91115
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
92116
end
93117
SSOReady::GetOrganizationResponse.from_json(json_object: response.body)
@@ -106,16 +130,23 @@ def get_organization(id:, request_options: nil)
106130
# @return [SSOReady::UpdateOrganizationResponse]
107131
# @example
108132
# api = SSOReady::Client.new(
109-
# environment: SSOReady::Environment::DEFAULT,
110133
# base_url: "https://api.example.com",
134+
# environment: SSOReady::Environment::DEFAULT,
111135
# api_key: "YOUR_AUTH_TOKEN"
112136
# )
113137
# api.management.organizations.update_organization(id: "id", request: { })
114138
def update_organization(id:, request:, request_options: nil)
115139
response = @request_client.conn.patch do |req|
116140
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
117141
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
118-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
142+
req.headers = {
143+
**(req.headers || {}),
144+
**@request_client.get_headers,
145+
**(request_options&.additional_headers || {})
146+
}.compact
147+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
148+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
149+
end
119150
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
120151
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
121152
end
@@ -140,8 +171,8 @@ def initialize(request_client:)
140171
# @return [SSOReady::ListOrganizationsResponse]
141172
# @example
142173
# api = SSOReady::Client.new(
143-
# environment: SSOReady::Environment::DEFAULT,
144174
# base_url: "https://api.example.com",
175+
# environment: SSOReady::Environment::DEFAULT,
145176
# api_key: "YOUR_AUTH_TOKEN"
146177
# )
147178
# api.management.organizations.list_organizations
@@ -150,8 +181,15 @@ def list_organizations(page_token: nil, request_options: nil)
150181
response = @request_client.conn.get do |req|
151182
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
152183
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
153-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
184+
req.headers = {
185+
**(req.headers || {}),
186+
**@request_client.get_headers,
187+
**(request_options&.additional_headers || {})
188+
}.compact
154189
req.params = { **(request_options&.additional_query_parameters || {}), "pageToken": page_token }.compact
190+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
191+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
192+
end
155193
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
156194
end
157195
SSOReady::ListOrganizationsResponse.from_json(json_object: response.body)
@@ -170,8 +208,8 @@ def list_organizations(page_token: nil, request_options: nil)
170208
# @return [SSOReady::CreateOrganizationResponse]
171209
# @example
172210
# api = SSOReady::Client.new(
173-
# environment: SSOReady::Environment::DEFAULT,
174211
# base_url: "https://api.example.com",
212+
# environment: SSOReady::Environment::DEFAULT,
175213
# api_key: "YOUR_AUTH_TOKEN"
176214
# )
177215
# api.management.organizations.create_organization(request: { })
@@ -180,7 +218,14 @@ def create_organization(request:, request_options: nil)
180218
response = @request_client.conn.post do |req|
181219
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
182220
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
183-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
221+
req.headers = {
222+
**(req.headers || {}),
223+
**@request_client.get_headers,
224+
**(request_options&.additional_headers || {})
225+
}.compact
226+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
227+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
228+
end
184229
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
185230
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations"
186231
end
@@ -195,8 +240,8 @@ def create_organization(request:, request_options: nil)
195240
# @return [SSOReady::GetOrganizationResponse]
196241
# @example
197242
# api = SSOReady::Client.new(
198-
# environment: SSOReady::Environment::DEFAULT,
199243
# base_url: "https://api.example.com",
244+
# environment: SSOReady::Environment::DEFAULT,
200245
# api_key: "YOUR_AUTH_TOKEN"
201246
# )
202247
# api.management.organizations.get_organization(id: "id")
@@ -205,7 +250,17 @@ def get_organization(id:, request_options: nil)
205250
response = @request_client.conn.get do |req|
206251
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
207252
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
208-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
253+
req.headers = {
254+
**(req.headers || {}),
255+
**@request_client.get_headers,
256+
**(request_options&.additional_headers || {})
257+
}.compact
258+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
259+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
260+
end
261+
unless request_options.nil? || request_options&.additional_body_parameters.nil?
262+
req.body = { **(request_options&.additional_body_parameters || {}) }.compact
263+
end
209264
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
210265
end
211266
SSOReady::GetOrganizationResponse.from_json(json_object: response.body)
@@ -225,8 +280,8 @@ def get_organization(id:, request_options: nil)
225280
# @return [SSOReady::UpdateOrganizationResponse]
226281
# @example
227282
# api = SSOReady::Client.new(
228-
# environment: SSOReady::Environment::DEFAULT,
229283
# base_url: "https://api.example.com",
284+
# environment: SSOReady::Environment::DEFAULT,
230285
# api_key: "YOUR_AUTH_TOKEN"
231286
# )
232287
# api.management.organizations.update_organization(id: "id", request: { })
@@ -235,7 +290,14 @@ def update_organization(id:, request:, request_options: nil)
235290
response = @request_client.conn.patch do |req|
236291
req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
237292
req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
238-
req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
293+
req.headers = {
294+
**(req.headers || {}),
295+
**@request_client.get_headers,
296+
**(request_options&.additional_headers || {})
297+
}.compact
298+
unless request_options.nil? || request_options&.additional_query_parameters.nil?
299+
req.params = { **(request_options&.additional_query_parameters || {}) }.compact
300+
end
239301
req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
240302
req.url "#{@request_client.get_url(request_options: request_options)}/v1/organizations/#{id}"
241303
end

0 commit comments

Comments
 (0)