Skip to content

Commit cfc7c06

Browse files
Generate Ruby Backend SDK (#50)
1 parent 63c49c0 commit cfc7c06

File tree

46 files changed

+4382
-59
lines changed

Some content is hidden

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

46 files changed

+4382
-59
lines changed

.generated/.openapi-generator/FILES

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,8 @@ docs/CreateBulkInvitationsRequestInner.md
3535
docs/CreateEmailAddressRequest.md
3636
docs/CreateInvitationRequest.md
3737
docs/CreateJWTTemplateRequest.md
38+
docs/CreateM2MToken201Response.md
39+
docs/CreateM2MTokenRequest.md
3840
docs/CreateMachine200Response.md
3941
docs/CreateMachineRequest.md
4042
docs/CreateMachineScopeRequest.md
@@ -68,6 +70,12 @@ docs/EmailSMSTemplatesApi.md
6870
docs/ExternalAccountWithVerification.md
6971
docs/ExternalAccountWithVerificationVerification.md
7072
docs/FeatureResponse.md
73+
docs/GetM2MTokens200Response.md
74+
docs/GetM2MTokens200ResponseM2mTokensInner.md
75+
docs/GetM2MTokens400Response.md
76+
docs/GetM2MTokens400ResponseErrorsInner.md
77+
docs/GetM2MTokens403Response.md
78+
docs/GetM2MTokens403ResponseErrorsInner.md
7179
docs/GetMachineSecretKey200Response.md
7280
docs/IdentificationLink.md
7381
docs/Instance.md
@@ -89,6 +97,7 @@ docs/JWTTemplate.md
8997
docs/JWTTemplatesApi.md
9098
docs/ListMachines200Response.md
9199
docs/ListWaitlistEntries200Response.md
100+
docs/M2MTokensApi.md
92101
docs/Machine.md
93102
docs/MachineScope.md
94103
docs/MachineWithoutScopedMachines.md
@@ -134,6 +143,7 @@ docs/RedirectUrl.md
134143
docs/RedirectUrlsApi.md
135144
docs/RefreshSessionRequest.md
136145
docs/RevokeInvitation200Response.md
146+
docs/RevokeM2MTokenRequest.md
137147
docs/RevokeOrganizationInvitationRequest.md
138148
docs/SAMLAccount.md
139149
docs/SAMLAccountSamlConnection.md
@@ -198,11 +208,8 @@ docs/VerificationTicket.md
198208
docs/VerificationWeb3.md
199209
docs/VerifyClientRequest.md
200210
docs/VerifyDomainProxyRequest.md
211+
docs/VerifyM2MTokenRequest.md
201212
docs/VerifyOauthAccessToken200Response.md
202-
docs/VerifyOauthAccessToken400Response.md
203-
docs/VerifyOauthAccessToken400ResponseErrorsInner.md
204-
docs/VerifyOauthAccessToken404Response.md
205-
docs/VerifyOauthAccessToken404ResponseErrorsInner.md
206213
docs/VerifyOauthAccessTokenRequest.md
207214
docs/VerifyPassword200Response.md
208215
docs/VerifyPasswordRequest.md
@@ -230,6 +237,7 @@ lib/clerk-http-client/api/instance_settings_api.rb
230237
lib/clerk-http-client/api/invitations_api.rb
231238
lib/clerk-http-client/api/jwks_api.rb
232239
lib/clerk-http-client/api/jwt_templates_api.rb
240+
lib/clerk-http-client/api/m2_m_tokens_api.rb
233241
lib/clerk-http-client/api/machines_api.rb
234242
lib/clerk-http-client/api/miscellaneous_api.rb
235243
lib/clerk-http-client/api/oauth_access_tokens_api.rb
@@ -275,6 +283,8 @@ lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb
275283
lib/clerk-http-client/models/create_email_address_request.rb
276284
lib/clerk-http-client/models/create_invitation_request.rb
277285
lib/clerk-http-client/models/create_jwt_template_request.rb
286+
lib/clerk-http-client/models/create_m2_m_token201_response.rb
287+
lib/clerk-http-client/models/create_m2_m_token_request.rb
278288
lib/clerk-http-client/models/create_machine200_response.rb
279289
lib/clerk-http-client/models/create_machine_request.rb
280290
lib/clerk-http-client/models/create_machine_scope_request.rb
@@ -305,6 +315,12 @@ lib/clerk-http-client/models/email_address_verification.rb
305315
lib/clerk-http-client/models/external_account_with_verification.rb
306316
lib/clerk-http-client/models/external_account_with_verification_verification.rb
307317
lib/clerk-http-client/models/feature_response.rb
318+
lib/clerk-http-client/models/get_m2_m_tokens200_response.rb
319+
lib/clerk-http-client/models/get_m2_m_tokens200_response_m2m_tokens_inner.rb
320+
lib/clerk-http-client/models/get_m2_m_tokens400_response.rb
321+
lib/clerk-http-client/models/get_m2_m_tokens400_response_errors_inner.rb
322+
lib/clerk-http-client/models/get_m2_m_tokens403_response.rb
323+
lib/clerk-http-client/models/get_m2_m_tokens403_response_errors_inner.rb
308324
lib/clerk-http-client/models/get_machine_secret_key200_response.rb
309325
lib/clerk-http-client/models/identification_link.rb
310326
lib/clerk-http-client/models/instance.rb
@@ -356,6 +372,7 @@ lib/clerk-http-client/models/proxy_check.rb
356372
lib/clerk-http-client/models/redirect_url.rb
357373
lib/clerk-http-client/models/refresh_session_request.rb
358374
lib/clerk-http-client/models/revoke_invitation200_response.rb
375+
lib/clerk-http-client/models/revoke_m2_m_token_request.rb
359376
lib/clerk-http-client/models/revoke_organization_invitation_request.rb
360377
lib/clerk-http-client/models/saml_account.rb
361378
lib/clerk-http-client/models/saml_account_saml_connection.rb
@@ -414,11 +431,8 @@ lib/clerk-http-client/models/verification_ticket.rb
414431
lib/clerk-http-client/models/verification_web3.rb
415432
lib/clerk-http-client/models/verify_client_request.rb
416433
lib/clerk-http-client/models/verify_domain_proxy_request.rb
434+
lib/clerk-http-client/models/verify_m2_m_token_request.rb
417435
lib/clerk-http-client/models/verify_oauth_access_token200_response.rb
418-
lib/clerk-http-client/models/verify_oauth_access_token400_response.rb
419-
lib/clerk-http-client/models/verify_oauth_access_token400_response_errors_inner.rb
420-
lib/clerk-http-client/models/verify_oauth_access_token404_response.rb
421-
lib/clerk-http-client/models/verify_oauth_access_token404_response_errors_inner.rb
422436
lib/clerk-http-client/models/verify_oauth_access_token_request.rb
423437
lib/clerk-http-client/models/verify_password200_response.rb
424438
lib/clerk-http-client/models/verify_password_request.rb
@@ -428,20 +442,15 @@ lib/clerk-http-client/models/verify_totp_request.rb
428442
lib/clerk-http-client/models/waitlist_entry.rb
429443
lib/clerk-http-client/models/web3_wallet.rb
430444
lib/clerk-http-client/models/web3_wallet_verification.rb
431-
spec/api/commerce_api_spec.rb
432-
spec/models/commerce_money_response_spec.rb
433-
spec/models/commerce_plan_spec.rb
434-
spec/models/feature_response_spec.rb
435-
spec/models/paginated_commerce_plan_response_spec.rb
436-
spec/models/passkey_verification_spec.rb
437-
spec/models/verification_admin_spec.rb
438-
spec/models/verification_from_oauth_error_spec.rb
439-
spec/models/verification_from_oauth_spec.rb
440-
spec/models/verification_google_one_tap_spec.rb
441-
spec/models/verification_oauth_spec.rb
442-
spec/models/verification_otp_spec.rb
443-
spec/models/verification_passkey_spec.rb
444-
spec/models/verification_saml_spec.rb
445-
spec/models/verification_ticket_spec.rb
446-
spec/models/verification_web3_spec.rb
445+
spec/api/m2_m_tokens_api_spec.rb
446+
spec/models/create_m2_m_token201_response_spec.rb
447+
spec/models/create_m2_m_token_request_spec.rb
448+
spec/models/get_m2_m_tokens200_response_m2m_tokens_inner_spec.rb
449+
spec/models/get_m2_m_tokens200_response_spec.rb
450+
spec/models/get_m2_m_tokens400_response_errors_inner_spec.rb
451+
spec/models/get_m2_m_tokens400_response_spec.rb
452+
spec/models/get_m2_m_tokens403_response_errors_inner_spec.rb
453+
spec/models/get_m2_m_tokens403_response_spec.rb
454+
spec/models/revoke_m2_m_token_request_spec.rb
455+
spec/models/verify_m2_m_token_request_spec.rb
447456
spec/spec_helper.rb

.generated/README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -91,6 +91,10 @@ Class | Method | HTTP request | Description
9191
*Clerk::SDK.jwt_templates* | [**get_jwt_template**](docs/JWTTemplatesApi.md#get_jwt_template) | **GET** /jwt_templates/{template_id} | Retrieve a template
9292
*Clerk::SDK.jwt_templates* | [**list_jwt_templates**](docs/JWTTemplatesApi.md#list_jwt_templates) | **GET** /jwt_templates | List all templates
9393
*Clerk::SDK.jwt_templates* | [**update_jwt_template**](docs/JWTTemplatesApi.md#update_jwt_template) | **PATCH** /jwt_templates/{template_id} | Update a JWT template
94+
*Clerk::SDK.m2m_tokens* | [**create_m2_m_token**](docs/M2MTokensApi.md#create_m2_m_token) | **POST** /m2m_tokens | Create a M2M Token
95+
*Clerk::SDK.m2m_tokens* | [**get_m2_m_tokens**](docs/M2MTokensApi.md#get_m2_m_tokens) | **GET** /m2m_tokens | Get M2M Tokens
96+
*Clerk::SDK.m2m_tokens* | [**revoke_m2_m_token**](docs/M2MTokensApi.md#revoke_m2_m_token) | **POST** /m2m_tokens/{m2m_token_id}/revoke | Revoke a M2M Token
97+
*Clerk::SDK.m2m_tokens* | [**verify_m2_m_token**](docs/M2MTokensApi.md#verify_m2_m_token) | **POST** /m2m_tokens/verify | Verify a M2M Token
9498
*Clerk::SDK.machines* | [**create_machine**](docs/MachinesApi.md#create_machine) | **POST** /machines | Create a machine
9599
*Clerk::SDK.machines* | [**create_machine_scope**](docs/MachinesApi.md#create_machine_scope) | **POST** /machines/{machine_id}/scopes | Create a machine scope
96100
*Clerk::SDK.machines* | [**delete_machine**](docs/MachinesApi.md#delete_machine) | **DELETE** /machines/{machine_id} | Delete a machine
@@ -218,6 +222,8 @@ Class | Method | HTTP request | Description
218222
- [ClerkHttpClient::CreateEmailAddressRequest](docs/CreateEmailAddressRequest.md)
219223
- [ClerkHttpClient::CreateInvitationRequest](docs/CreateInvitationRequest.md)
220224
- [ClerkHttpClient::CreateJWTTemplateRequest](docs/CreateJWTTemplateRequest.md)
225+
- [ClerkHttpClient::CreateM2MToken201Response](docs/CreateM2MToken201Response.md)
226+
- [ClerkHttpClient::CreateM2MTokenRequest](docs/CreateM2MTokenRequest.md)
221227
- [ClerkHttpClient::CreateMachine200Response](docs/CreateMachine200Response.md)
222228
- [ClerkHttpClient::CreateMachineRequest](docs/CreateMachineRequest.md)
223229
- [ClerkHttpClient::CreateMachineScopeRequest](docs/CreateMachineScopeRequest.md)
@@ -248,6 +254,12 @@ Class | Method | HTTP request | Description
248254
- [ClerkHttpClient::ExternalAccountWithVerification](docs/ExternalAccountWithVerification.md)
249255
- [ClerkHttpClient::ExternalAccountWithVerificationVerification](docs/ExternalAccountWithVerificationVerification.md)
250256
- [ClerkHttpClient::FeatureResponse](docs/FeatureResponse.md)
257+
- [ClerkHttpClient::GetM2MTokens200Response](docs/GetM2MTokens200Response.md)
258+
- [ClerkHttpClient::GetM2MTokens200ResponseM2mTokensInner](docs/GetM2MTokens200ResponseM2mTokensInner.md)
259+
- [ClerkHttpClient::GetM2MTokens400Response](docs/GetM2MTokens400Response.md)
260+
- [ClerkHttpClient::GetM2MTokens400ResponseErrorsInner](docs/GetM2MTokens400ResponseErrorsInner.md)
261+
- [ClerkHttpClient::GetM2MTokens403Response](docs/GetM2MTokens403Response.md)
262+
- [ClerkHttpClient::GetM2MTokens403ResponseErrorsInner](docs/GetM2MTokens403ResponseErrorsInner.md)
251263
- [ClerkHttpClient::GetMachineSecretKey200Response](docs/GetMachineSecretKey200Response.md)
252264
- [ClerkHttpClient::IdentificationLink](docs/IdentificationLink.md)
253265
- [ClerkHttpClient::Instance](docs/Instance.md)
@@ -299,6 +311,7 @@ Class | Method | HTTP request | Description
299311
- [ClerkHttpClient::RedirectURL](docs/RedirectURL.md)
300312
- [ClerkHttpClient::RefreshSessionRequest](docs/RefreshSessionRequest.md)
301313
- [ClerkHttpClient::RevokeInvitation200Response](docs/RevokeInvitation200Response.md)
314+
- [ClerkHttpClient::RevokeM2MTokenRequest](docs/RevokeM2MTokenRequest.md)
302315
- [ClerkHttpClient::RevokeOrganizationInvitationRequest](docs/RevokeOrganizationInvitationRequest.md)
303316
- [ClerkHttpClient::SAMLAccount](docs/SAMLAccount.md)
304317
- [ClerkHttpClient::SAMLAccountSamlConnection](docs/SAMLAccountSamlConnection.md)
@@ -357,11 +370,8 @@ Class | Method | HTTP request | Description
357370
- [ClerkHttpClient::VerificationWeb3](docs/VerificationWeb3.md)
358371
- [ClerkHttpClient::VerifyClientRequest](docs/VerifyClientRequest.md)
359372
- [ClerkHttpClient::VerifyDomainProxyRequest](docs/VerifyDomainProxyRequest.md)
373+
- [ClerkHttpClient::VerifyM2MTokenRequest](docs/VerifyM2MTokenRequest.md)
360374
- [ClerkHttpClient::VerifyOAuthAccessToken200Response](docs/VerifyOAuthAccessToken200Response.md)
361-
- [ClerkHttpClient::VerifyOAuthAccessToken400Response](docs/VerifyOAuthAccessToken400Response.md)
362-
- [ClerkHttpClient::VerifyOAuthAccessToken400ResponseErrorsInner](docs/VerifyOAuthAccessToken400ResponseErrorsInner.md)
363-
- [ClerkHttpClient::VerifyOAuthAccessToken404Response](docs/VerifyOAuthAccessToken404Response.md)
364-
- [ClerkHttpClient::VerifyOAuthAccessToken404ResponseErrorsInner](docs/VerifyOAuthAccessToken404ResponseErrorsInner.md)
365375
- [ClerkHttpClient::VerifyOAuthAccessTokenRequest](docs/VerifyOAuthAccessTokenRequest.md)
366376
- [ClerkHttpClient::VerifyPassword200Response](docs/VerifyPassword200Response.md)
367377
- [ClerkHttpClient::VerifyPasswordRequest](docs/VerifyPasswordRequest.md)

.generated/docs/CommerceApi.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,8 @@ end
2929
opts = {
3030
paginated: true, # Boolean | Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.
3131
limit: 56, # Integer | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
32-
offset: 56 # Integer | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
32+
offset: 56, # Integer | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
33+
payer_type: 'user' # String | Filter plans by payer type
3334
}
3435

3536
begin
@@ -66,6 +67,7 @@ end
6667
| **paginated** | **Boolean** | Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated. | [optional] |
6768
| **limit** | **Integer** | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`. | [optional][default to 10] |
6869
| **offset** | **Integer** | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. | [optional][default to 0] |
70+
| **payer_type** | **String** | Filter plans by payer type | [optional] |
6971

7072
### Return type
7173

.generated/docs/CommercePlan.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@
2828
| **for_payer_type** | **String** | The payer type this plan is designed for. | |
2929
| **slug** | **String** | The URL-friendly slug for the plan. | |
3030
| **avatar_url** | **String** | The URL of the plan's avatar image. | |
31-
| **period** | **String** | The billing period for the plan. | |
32-
| **interval** | **Integer** | The billing interval. | |
31+
| **period** | **String** | The billing period for the plan. | [optional] |
32+
| **interval** | **Integer** | The billing interval. | [optional] |
3333
| **features** | [**Array<FeatureResponse>**](FeatureResponse.md) | The features included in this plan. | |
3434

3535
## Example
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# ClerkHttpClient::CreateM2MToken201Response
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **object** | **String** | | |
8+
| **id** | **String** | | |
9+
| **subject** | **String** | | |
10+
| **claims** | **Object** | | [optional] |
11+
| **scopes** | **Array<String>** | | [optional] |
12+
| **token** | **String** | | |
13+
| **revoked** | **Boolean** | | |
14+
| **revocation_reason** | **String** | | |
15+
| **expired** | **Boolean** | | |
16+
| **expiration** | **Float** | | |
17+
| **last_used_at** | **Float** | | |
18+
| **created_at** | **Float** | | |
19+
| **updated_at** | **Float** | | |
20+
21+
## Example
22+
23+
```ruby
24+
require 'clerk-http-client'
25+
26+
instance = ClerkHttpClient::CreateM2MToken201Response.new(
27+
object: null,
28+
id: mt_f7f0ba8c3b4843ce7d85fcdd5e71853e,
29+
subject: mch_2xhFjEI5X2qWRvtV13BzSj8H6Dk,
30+
claims: {"important_metadata":"Some useful data"},
31+
scopes: ["mch_2xhFjEI5X2qWRvtV13BzSj8H6Dk","mch_2yGkLpQ7Y3rXSwtU24CzTk9I7Em"],
32+
token: mt_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX,
33+
revoked: false,
34+
revocation_reason: Revoked by user,
35+
expired: false,
36+
expiration: 1716883200,
37+
last_used_at: 1716883200,
38+
created_at: 1716883200,
39+
updated_at: 1716883200
40+
)
41+
```
42+
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ClerkHttpClient::CreateM2MTokenRequest
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **seconds_until_expiration** | **Float** | | [optional] |
8+
| **claims** | **Object** | | [optional] |
9+
10+
## Example
11+
12+
```ruby
13+
require 'clerk-http-client'
14+
15+
instance = ClerkHttpClient::CreateM2MTokenRequest.new(
16+
seconds_until_expiration: null,
17+
claims: null
18+
)
19+
```
20+
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# ClerkHttpClient::GetM2MTokens200Response
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **m2m_tokens** | [**Array<GetM2MTokens200ResponseM2mTokensInner>**](GetM2MTokens200ResponseM2mTokensInner.md) | | |
8+
| **total_count** | **Float** | | |
9+
10+
## Example
11+
12+
```ruby
13+
require 'clerk-http-client'
14+
15+
instance = ClerkHttpClient::GetM2MTokens200Response.new(
16+
m2m_tokens: null,
17+
total_count: null
18+
)
19+
```
20+
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# ClerkHttpClient::GetM2MTokens200ResponseM2mTokensInner
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **object** | **String** | | |
8+
| **id** | **String** | | |
9+
| **subject** | **String** | | |
10+
| **claims** | **Object** | | [optional] |
11+
| **scopes** | **Array<String>** | | [optional] |
12+
| **revoked** | **Boolean** | | |
13+
| **revocation_reason** | **String** | | |
14+
| **expired** | **Boolean** | | |
15+
| **expiration** | **Float** | | |
16+
| **last_used_at** | **Float** | | |
17+
| **created_at** | **Float** | | |
18+
| **updated_at** | **Float** | | |
19+
20+
## Example
21+
22+
```ruby
23+
require 'clerk-http-client'
24+
25+
instance = ClerkHttpClient::GetM2MTokens200ResponseM2mTokensInner.new(
26+
object: null,
27+
id: mt_f7f0ba8c3b4843ce7d85fcdd5e71853e,
28+
subject: mch_2xhFjEI5X2qWRvtV13BzSj8H6Dk,
29+
claims: {"important_metadata":"Some useful data"},
30+
scopes: ["mch_2xhFjEI5X2qWRvtV13BzSj8H6Dk","mch_2yGkLpQ7Y3rXSwtU24CzTk9I7Em"],
31+
revoked: false,
32+
revocation_reason: Revoked by user,
33+
expired: false,
34+
expiration: 1716883200,
35+
last_used_at: 1716883200,
36+
created_at: 1716883200,
37+
updated_at: 1716883200
38+
)
39+
```
40+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# ClerkHttpClient::GetM2MTokens400Response
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **errors** | [**Array<GetM2MTokens400ResponseErrorsInner>**](GetM2MTokens400ResponseErrorsInner.md) | | |
8+
9+
## Example
10+
11+
```ruby
12+
require 'clerk-http-client'
13+
14+
instance = ClerkHttpClient::GetM2MTokens400Response.new(
15+
errors: null
16+
)
17+
```
18+
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# ClerkHttpClient::GetM2MTokens400ResponseErrorsInner
2+
3+
## Properties
4+
5+
| Name | Type | Description | Notes |
6+
| ---- | ---- | ----------- | ----- |
7+
| **message** | **String** | | |
8+
| **long_message** | **String** | | |
9+
| **code** | **String** | | |
10+
11+
## Example
12+
13+
```ruby
14+
require 'clerk-http-client'
15+
16+
instance = ClerkHttpClient::GetM2MTokens400ResponseErrorsInner.new(
17+
message: Bad Request,
18+
long_message: Invalid 'url_parameter.example': Failed regex check,
19+
code: bad_request
20+
)
21+
```
22+

0 commit comments

Comments
 (0)