Skip to content
This repository was archived by the owner on Jan 30, 2026. It is now read-only.

Commit de1580a

Browse files
Generate Ruby Backend SDK (#46)
1 parent 9e8783e commit de1580a

File tree

386 files changed

+23594
-1247
lines changed

Some content is hidden

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

386 files changed

+23594
-1247
lines changed

.generated/.openapi-generator/FILES

Lines changed: 152 additions & 10 deletions
Large diffs are not rendered by default.

.generated/README.md

Lines changed: 71 additions & 11 deletions
Large diffs are not rendered by default.

.generated/clerk-http-client.gemspec

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
=begin
44
#Clerk Backend API
55
6-
#The Clerk REST Backend API, meant to be accessed by backend servers. ### Versions When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. `2021-02-05`. For more information, please see [Clerk API Versions](https://clerk.com/docs/backend-requests/versioning/overview). Please see https://clerk.com/docs for more information.
6+
#The Clerk REST Backend API, meant to be accessed by backend servers. ### Versions When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. `2021-02-05`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions). Please see https://clerk.com/docs for more information.
77
8-
The version of the OpenAPI document: v1
8+
The version of the OpenAPI document: 2021-02-05
99
Contact: support@clerk.com
1010
Generated by: https://openapi-generator.tech
1111
Generator version: unset

.generated/docs/AWSCredential.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# ClerkHttpClient::AWSCredential
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **id** | **String** | | |
8+
| **object** | **String** | String representing the object's type. Objects of the same type share the same value. | |
9+
| **access_key_id** | **String** | | |
10+
| **user_pool_ids** | **Array<String>** | | |
11+
| **created_at** | **Integer** | Unix timestamp of creation | |
12+
| **updated_at** | **Integer** | Unix timestamp of creation | |
13+
14+
## Example
15+
16+
```ruby
17+
require 'clerk-http-client'
18+
19+
instance = ClerkHttpClient::AWSCredential.new(
20+
id: null,
21+
object: null,
22+
access_key_id: null,
23+
user_pool_ids: null,
24+
created_at: null,
25+
updated_at: null
26+
)
27+
```
28+
Lines changed: 355 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,355 @@
1+
# Clerk::SDK.aws_credentials
2+
3+
All URIs are relative to *https://api.clerk.com/v1*
4+
5+
| Method | HTTP request | Description |
6+
| ------ | ------------ | ----------- |
7+
| [**create_aws_credential**](AWSCredentialsApi.md#create_aws_credential) | **POST** /aws_credentials | Create an AWS Credential |
8+
| [**delete_aws_credential**](AWSCredentialsApi.md#delete_aws_credential) | **DELETE** /aws_credentials/{id} | Delete an AWS Credential |
9+
| [**get_aws_credential**](AWSCredentialsApi.md#get_aws_credential) | **GET** /aws_credentials/{id} | Retrieve an AWS Credential |
10+
| [**get_aws_credential_list**](AWSCredentialsApi.md#get_aws_credential_list) | **GET** /aws_credentials | List all AWS Credentials |
11+
| [**update_aws_credential**](AWSCredentialsApi.md#update_aws_credential) | **PATCH** /aws_credentials/{id} | Update an AWS Credential |
12+
13+
14+
## create_aws_credential
15+
16+
> <AWSCredential> create_aws_credential(opts)
17+
18+
Create an AWS Credential
19+
20+
Create a new AWS Credential
21+
22+
### Examples
23+
24+
```ruby
25+
require 'time'
26+
require 'clerk'
27+
28+
## Setup
29+
Clerk.configure do |config|
30+
config.secret_key = 'sk_test_xxxxxxxxx'
31+
end
32+
33+
opts = {
34+
create_aws_credential_request: ClerkHttpClient::CreateAWSCredentialRequest.new({access_key_id: 'access_key_id_example', secret_access_key: 'secret_access_key_example', user_pool_ids: ['user_pool_ids_example']}) # CreateAWSCredentialRequest |
35+
}
36+
37+
begin
38+
# Create an AWS Credential
39+
result = Clerk::SDK.aws_credentials.create_aws_credential(opts)
40+
p result
41+
rescue ClerkHttpClient::ApiError => e
42+
puts "Error when calling Clerk::SDK.aws_credentials->create_aws_credential: #{e}"
43+
end
44+
```
45+
46+
#### Using the `create_aws_credential_with_http_info variant
47+
48+
This returns an Array which contains the response data, status code and headers.
49+
50+
> <Array(<AWSCredential>, Integer, Hash)> create_aws_credential_with_http_info(opts)
51+
52+
```ruby
53+
begin
54+
# Create an AWS Credential
55+
data, status_code, headers = Clerk::SDK.aws_credentials.create_aws_credential_with_http_info(opts)
56+
p status_code # => 2xx
57+
p headers # => { ... }
58+
p data # => <AWSCredential>
59+
rescue ClerkHttpClient::ApiError => e
60+
puts "Error when calling Clerk::SDK.aws_credentials->create_aws_credential_with_http_info: #{e}"
61+
end
62+
```
63+
64+
### Parameters
65+
66+
| Name | Type | Description | Notes |
67+
| ---- | ---- | ----------- | ----- |
68+
| **create_aws_credential_request** | [**CreateAWSCredentialRequest**](CreateAWSCredentialRequest.md) | | [optional] |
69+
70+
### Return type
71+
72+
[**AWSCredential**](AWSCredential.md)
73+
74+
### Authorization
75+
76+
[bearerAuth](../README.md#bearerAuth)
77+
78+
### HTTP request headers
79+
80+
- **Content-Type**: application/json
81+
- **Accept**: application/json
82+
83+
84+
## delete_aws_credential
85+
86+
> <DeletedObject> delete_aws_credential(id)
87+
88+
Delete an AWS Credential
89+
90+
Delete the AWS Credential with the given ID
91+
92+
### Examples
93+
94+
```ruby
95+
require 'time'
96+
require 'clerk'
97+
98+
## Setup
99+
Clerk.configure do |config|
100+
config.secret_key = 'sk_test_xxxxxxxxx'
101+
end
102+
103+
id = 'id_example' # String | The ID of the AWS Credential to delete
104+
105+
begin
106+
# Delete an AWS Credential
107+
result = Clerk::SDK.aws_credentials.delete_aws_credential(id)
108+
p result
109+
rescue ClerkHttpClient::ApiError => e
110+
puts "Error when calling Clerk::SDK.aws_credentials->delete_aws_credential: #{e}"
111+
end
112+
```
113+
114+
#### Using the `delete_aws_credential_with_http_info variant
115+
116+
This returns an Array which contains the response data, status code and headers.
117+
118+
> <Array(<DeletedObject>, Integer, Hash)> delete_aws_credential_with_http_info(id)
119+
120+
```ruby
121+
begin
122+
# Delete an AWS Credential
123+
data, status_code, headers = Clerk::SDK.aws_credentials.delete_aws_credential_with_http_info(id)
124+
p status_code # => 2xx
125+
p headers # => { ... }
126+
p data # => <DeletedObject>
127+
rescue ClerkHttpClient::ApiError => e
128+
puts "Error when calling Clerk::SDK.aws_credentials->delete_aws_credential_with_http_info: #{e}"
129+
end
130+
```
131+
132+
### Parameters
133+
134+
| Name | Type | Description | Notes |
135+
| ---- | ---- | ----------- | ----- |
136+
| **id** | **String** | The ID of the AWS Credential to delete | |
137+
138+
### Return type
139+
140+
[**DeletedObject**](DeletedObject.md)
141+
142+
### Authorization
143+
144+
[bearerAuth](../README.md#bearerAuth)
145+
146+
### HTTP request headers
147+
148+
- **Content-Type**: Not defined
149+
- **Accept**: application/json
150+
151+
152+
## get_aws_credential
153+
154+
> <AWSCredential> get_aws_credential(id)
155+
156+
Retrieve an AWS Credential
157+
158+
Returns the details of an AWS Credential.
159+
160+
### Examples
161+
162+
```ruby
163+
require 'time'
164+
require 'clerk'
165+
166+
## Setup
167+
Clerk.configure do |config|
168+
config.secret_key = 'sk_test_xxxxxxxxx'
169+
end
170+
171+
id = 'id_example' # String | The ID of the AWS Credential to retrieve
172+
173+
begin
174+
# Retrieve an AWS Credential
175+
result = Clerk::SDK.aws_credentials.get_aws_credential(id)
176+
p result
177+
rescue ClerkHttpClient::ApiError => e
178+
puts "Error when calling Clerk::SDK.aws_credentials->get_aws_credential: #{e}"
179+
end
180+
```
181+
182+
#### Using the `get_aws_credential_with_http_info variant
183+
184+
This returns an Array which contains the response data, status code and headers.
185+
186+
> <Array(<AWSCredential>, Integer, Hash)> get_aws_credential_with_http_info(id)
187+
188+
```ruby
189+
begin
190+
# Retrieve an AWS Credential
191+
data, status_code, headers = Clerk::SDK.aws_credentials.get_aws_credential_with_http_info(id)
192+
p status_code # => 2xx
193+
p headers # => { ... }
194+
p data # => <AWSCredential>
195+
rescue ClerkHttpClient::ApiError => e
196+
puts "Error when calling Clerk::SDK.aws_credentials->get_aws_credential_with_http_info: #{e}"
197+
end
198+
```
199+
200+
### Parameters
201+
202+
| Name | Type | Description | Notes |
203+
| ---- | ---- | ----------- | ----- |
204+
| **id** | **String** | The ID of the AWS Credential to retrieve | |
205+
206+
### Return type
207+
208+
[**AWSCredential**](AWSCredential.md)
209+
210+
### Authorization
211+
212+
[bearerAuth](../README.md#bearerAuth)
213+
214+
### HTTP request headers
215+
216+
- **Content-Type**: Not defined
217+
- **Accept**: application/json
218+
219+
220+
## get_aws_credential_list
221+
222+
> <Array<AWSCredential>> get_aws_credential_list
223+
224+
List all AWS Credentials
225+
226+
Returns a list of all AWS Credentials.
227+
228+
### Examples
229+
230+
```ruby
231+
require 'time'
232+
require 'clerk'
233+
234+
## Setup
235+
Clerk.configure do |config|
236+
config.secret_key = 'sk_test_xxxxxxxxx'
237+
end
238+
239+
240+
begin
241+
# List all AWS Credentials
242+
result = Clerk::SDK.aws_credentials.get_aws_credential_list
243+
p result
244+
rescue ClerkHttpClient::ApiError => e
245+
puts "Error when calling Clerk::SDK.aws_credentials->get_aws_credential_list: #{e}"
246+
end
247+
```
248+
249+
#### Using the `get_aws_credential_list_with_http_info variant
250+
251+
This returns an Array which contains the response data, status code and headers.
252+
253+
> <Array(<Array<AWSCredential>>, Integer, Hash)> get_aws_credential_list_with_http_info
254+
255+
```ruby
256+
begin
257+
# List all AWS Credentials
258+
data, status_code, headers = Clerk::SDK.aws_credentials.get_aws_credential_list_with_http_info
259+
p status_code # => 2xx
260+
p headers # => { ... }
261+
p data # => <Array<AWSCredential>>
262+
rescue ClerkHttpClient::ApiError => e
263+
puts "Error when calling Clerk::SDK.aws_credentials->get_aws_credential_list_with_http_info: #{e}"
264+
end
265+
```
266+
267+
### Parameters
268+
269+
This endpoint does not need any parameter.
270+
271+
### Return type
272+
273+
[**Array&lt;AWSCredential&gt;**](AWSCredential.md)
274+
275+
### Authorization
276+
277+
[bearerAuth](../README.md#bearerAuth)
278+
279+
### HTTP request headers
280+
281+
- **Content-Type**: Not defined
282+
- **Accept**: application/json
283+
284+
285+
## update_aws_credential
286+
287+
> <AWSCredential> update_aws_credential(id, opts)
288+
289+
Update an AWS Credential
290+
291+
Updates an AWS credential.
292+
293+
### Examples
294+
295+
```ruby
296+
require 'time'
297+
require 'clerk'
298+
299+
## Setup
300+
Clerk.configure do |config|
301+
config.secret_key = 'sk_test_xxxxxxxxx'
302+
end
303+
304+
id = 'id_example' # String | The ID of the AWS Credential to update
305+
opts = {
306+
update_aws_credential_request: ClerkHttpClient::UpdateAWSCredentialRequest.new # UpdateAWSCredentialRequest |
307+
}
308+
309+
begin
310+
# Update an AWS Credential
311+
result = Clerk::SDK.aws_credentials.update_aws_credential(id, opts)
312+
p result
313+
rescue ClerkHttpClient::ApiError => e
314+
puts "Error when calling Clerk::SDK.aws_credentials->update_aws_credential: #{e}"
315+
end
316+
```
317+
318+
#### Using the `update_aws_credential_with_http_info variant
319+
320+
This returns an Array which contains the response data, status code and headers.
321+
322+
> <Array(<AWSCredential>, Integer, Hash)> update_aws_credential_with_http_info(id, opts)
323+
324+
```ruby
325+
begin
326+
# Update an AWS Credential
327+
data, status_code, headers = Clerk::SDK.aws_credentials.update_aws_credential_with_http_info(id, opts)
328+
p status_code # => 2xx
329+
p headers # => { ... }
330+
p data # => <AWSCredential>
331+
rescue ClerkHttpClient::ApiError => e
332+
puts "Error when calling Clerk::SDK.aws_credentials->update_aws_credential_with_http_info: #{e}"
333+
end
334+
```
335+
336+
### Parameters
337+
338+
| Name | Type | Description | Notes |
339+
| ---- | ---- | ----------- | ----- |
340+
| **id** | **String** | The ID of the AWS Credential to update | |
341+
| **update_aws_credential_request** | [**UpdateAWSCredentialRequest**](UpdateAWSCredentialRequest.md) | | [optional] |
342+
343+
### Return type
344+
345+
[**AWSCredential**](AWSCredential.md)
346+
347+
### Authorization
348+
349+
[bearerAuth](../README.md#bearerAuth)
350+
351+
### HTTP request headers
352+
353+
- **Content-Type**: application/json
354+
- **Accept**: application/json
355+

0 commit comments

Comments
 (0)