clerk-http-client 1.0.0 → 2.0.0.beta2

data/docs/JWKSApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## get_jwks
 
-> <WellKnownJWKS> get_jwks
+> <JWKS> get_jwks
 
 Retrieve the JSON Web Key Set of the instance
 
@@ -19,39 +19,38 @@ Retrieve the JSON Web Key Set of the instance
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::JWKSApi.new
 
 begin
   # Retrieve the JSON Web Key Set of the instance
-  result = api_instance.get_jwks
+  result = Clerk::SDK.jwks.get_jwks
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWKSApi->get_jwks: #{e}"
+  puts "Error when calling Clerk::SDK.jwks->get_jwks: #{e}"
 end
 ```
 
-#### Using the get_jwks_with_http_info variant
+#### Using the `get_jwks_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<WellKnownJWKS>, Integer, Hash)> get_jwks_with_http_info
+> <Array(<JWKS>, Integer, Hash)> get_jwks_with_http_info
 
 ```ruby
 begin
   # Retrieve the JSON Web Key Set of the instance
-  data, status_code, headers = api_instance.get_jwks_with_http_info
+  data, status_code, headers = Clerk::SDK.jwks.get_jwks_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <WellKnownJWKS>
+  p data # => <JWKS>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWKSApi->get_jwks_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.jwks->get_jwks_with_http_info: #{e}"
 end
 ```
 
@@ -61,7 +60,7 @@ This endpoint does not need any parameter.
 
 ### Return type
 
-[**WellKnownJWKS**](WellKnownJWKS.md)
+[**JWKS**](JWKS.md)
 
 ### Authorization
 

data/docs/JWKSKeysInner.md

@@ -0,0 +1,32 @@
+# ClerkHttpClient::JWKSKeysInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **use** | **String** |  | [optional] |
+| **kty** | **String** |  | [optional] |
+| **kid** | **String** |  | [optional] |
+| **alg** | **String** |  | [optional] |
+| **n** | **String** |  | [optional] |
+| **e** | **String** |  | [optional] |
+| **x** | **String** |  | [optional] |
+| **crv** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::JWKSKeysInner.new(
+  use: null,
+  kty: null,
+  kid: null,
+  alg: null,
+  n: null,
+  e: null,
+  x: null,
+  crv: null
+)
+```
+

data/docs/JWTTemplatesApi.md

@@ -13,7 +13,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## create_jwt_template
 
-> <JWTTemplate> create_jwt_template(create_jwt_template_request)
+> <JWTTemplate> create_jwt_template(opts)
 
 Create a JWT template
 
@@ -23,40 +23,41 @@ Create a new JWT template
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::JWTTemplatesApi.new
-create_jwt_template_request = ClerkHttpClient::CreateJWTTemplateRequest.new # CreateJWTTemplateRequest | 
+opts = {
+  create_jwt_template_request: ClerkHttpClient::CreateJWTTemplateRequest.new # CreateJWTTemplateRequest | 
+}
 
 begin
   # Create a JWT template
-  result = api_instance.create_jwt_template(create_jwt_template_request)
+  result = Clerk::SDK.jwt_templates.create_jwt_template(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->create_jwt_template: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->create_jwt_template: #{e}"
 end
 ```
 
-#### Using the create_jwt_template_with_http_info variant
+#### Using the `create_jwt_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<JWTTemplate>, Integer, Hash)> create_jwt_template_with_http_info(create_jwt_template_request)
+> <Array(<JWTTemplate>, Integer, Hash)> create_jwt_template_with_http_info(opts)
 
 ```ruby
 begin
   # Create a JWT template
-  data, status_code, headers = api_instance.create_jwt_template_with_http_info(create_jwt_template_request)
+  data, status_code, headers = Clerk::SDK.jwt_templates.create_jwt_template_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <JWTTemplate>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->create_jwt_template_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->create_jwt_template_with_http_info: #{e}"
 end
 ```
 
@@ -64,7 +65,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_jwt_template_request** | [**CreateJWTTemplateRequest**](CreateJWTTemplateRequest.md) |  |  |
+| **create_jwt_template_request** | [**CreateJWTTemplateRequest**](CreateJWTTemplateRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -92,26 +93,25 @@ Delete a Template
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::JWTTemplatesApi.new
 template_id = 'template_id_example' # String | JWT Template ID
 
 begin
   # Delete a Template
-  result = api_instance.delete_jwt_template(template_id)
+  result = Clerk::SDK.jwt_templates.delete_jwt_template(template_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->delete_jwt_template: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->delete_jwt_template: #{e}"
 end
 ```
 
-#### Using the delete_jwt_template_with_http_info variant
+#### Using the `delete_jwt_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -120,12 +120,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Delete a Template
-  data, status_code, headers = api_instance.delete_jwt_template_with_http_info(template_id)
+  data, status_code, headers = Clerk::SDK.jwt_templates.delete_jwt_template_with_http_info(template_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <DeletedObject>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->delete_jwt_template_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->delete_jwt_template_with_http_info: #{e}"
 end
 ```
 
@@ -161,26 +161,25 @@ Retrieve the details of a given JWT template
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::JWTTemplatesApi.new
 template_id = 'template_id_example' # String | JWT Template ID
 
 begin
   # Retrieve a template
-  result = api_instance.get_jwt_template(template_id)
+  result = Clerk::SDK.jwt_templates.get_jwt_template(template_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->get_jwt_template: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->get_jwt_template: #{e}"
 end
 ```
 
-#### Using the get_jwt_template_with_http_info variant
+#### Using the `get_jwt_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -189,12 +188,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Retrieve a template
-  data, status_code, headers = api_instance.get_jwt_template_with_http_info(template_id)
+  data, status_code, headers = Clerk::SDK.jwt_templates.get_jwt_template_with_http_info(template_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <JWTTemplate>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->get_jwt_template_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->get_jwt_template_with_http_info: #{e}"
 end
 ```
 
@@ -228,25 +227,24 @@ List all templates
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::JWTTemplatesApi.new
 
 begin
   # List all templates
-  result = api_instance.list_jwt_templates
+  result = Clerk::SDK.jwt_templates.list_jwt_templates
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->list_jwt_templates: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->list_jwt_templates: #{e}"
 end
 ```
 
-#### Using the list_jwt_templates_with_http_info variant
+#### Using the `list_jwt_templates_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -255,12 +253,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # List all templates
-  data, status_code, headers = api_instance.list_jwt_templates_with_http_info
+  data, status_code, headers = Clerk::SDK.jwt_templates.list_jwt_templates_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<JWTTemplate>>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->list_jwt_templates_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->list_jwt_templates_with_http_info: #{e}"
 end
 ```
 
@@ -284,7 +282,7 @@ This endpoint does not need any parameter.
 
 ## update_jwt_template
 
-> <JWTTemplate> update_jwt_template(template_id, create_jwt_template_request)
+> <JWTTemplate> update_jwt_template(template_id, opts)
 
 Update a JWT template
 
@@ -294,41 +292,42 @@ Updates an existing JWT template
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
-# setup authorization
-ClerkHttpClient.configure do |config|
-  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
-  config.access_token = 'YOUR_BEARER_TOKEN'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::JWTTemplatesApi.new
 template_id = 'template_id_example' # String | The ID of the JWT template to update
-create_jwt_template_request = ClerkHttpClient::CreateJWTTemplateRequest.new # CreateJWTTemplateRequest | 
+opts = {
+  create_jwt_template_request: ClerkHttpClient::CreateJWTTemplateRequest.new # CreateJWTTemplateRequest | 
+}
 
 begin
   # Update a JWT template
-  result = api_instance.update_jwt_template(template_id, create_jwt_template_request)
+  result = Clerk::SDK.jwt_templates.update_jwt_template(template_id, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->update_jwt_template: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->update_jwt_template: #{e}"
 end
 ```
 
-#### Using the update_jwt_template_with_http_info variant
+#### Using the `update_jwt_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<JWTTemplate>, Integer, Hash)> update_jwt_template_with_http_info(template_id, create_jwt_template_request)
+> <Array(<JWTTemplate>, Integer, Hash)> update_jwt_template_with_http_info(template_id, opts)
 
 ```ruby
 begin
   # Update a JWT template
-  data, status_code, headers = api_instance.update_jwt_template_with_http_info(template_id, create_jwt_template_request)
+  data, status_code, headers = Clerk::SDK.jwt_templates.update_jwt_template_with_http_info(template_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <JWTTemplate>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling JWTTemplatesApi->update_jwt_template_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.jwt_templates->update_jwt_template_with_http_info: #{e}"
 end
 ```
 
@@ -337,7 +336,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **template_id** | **String** | The ID of the JWT template to update |  |
-| **create_jwt_template_request** | [**CreateJWTTemplateRequest**](CreateJWTTemplateRequest.md) |  |  |
+| **create_jwt_template_request** | [**CreateJWTTemplateRequest**](CreateJWTTemplateRequest.md) |  | [optional] |
 
 ### Return type
 

data/docs/ListWaitlistEntries200Response.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::ListWaitlistEntries200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<WaitlistEntry>**](WaitlistEntry.md) |  |  |
+| **total_count** | **Integer** | Total number of waitlist entries |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::ListWaitlistEntries200Response.new(
+  data: null,
+  total_count: null
+)
+```
+

data/docs/MergeOrganizationMetadataRequest.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **public_metadata** | **Object** | Metadata saved on the organization, that is visible to both your frontend and backend. The new object will be merged with the existing value. | [optional] |
-| **private_metadata** | **Object** | Metadata saved on the organization that is only visible to your backend. The new object will be merged with the existing value. | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the organization, that is visible to both your frontend and backend. The new object will be merged with the existing value. | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the organization that is only visible to your backend. The new object will be merged with the existing value. | [optional] |
 
 ## Example
 

data/docs/MiscellaneousApi.md

@@ -19,9 +19,13 @@ The Clerk interstitial endpoint serves an html page that loads clerk.js in order
 
 ```ruby
 require 'time'
-require 'clerk-http-client'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
+end
 
-api_instance = ClerkHttpClient::MiscellaneousApi.new
 opts = {
   frontend_api: 'frontend_api_example', # String | The Frontend API key of your instance
   publishable_key: 'publishable_key_example' # String | The publishable key of your instance
@@ -29,13 +33,13 @@ opts = {
 
 begin
   # Returns the markup for the interstitial page
-  api_instance.get_public_interstitial(opts)
+  Clerk::SDK.miscellaneous.get_public_interstitial(opts)
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling MiscellaneousApi->get_public_interstitial: #{e}"
+  puts "Error when calling Clerk::SDK.miscellaneous->get_public_interstitial: #{e}"
 end
 ```
 
-#### Using the get_public_interstitial_with_http_info variant
+#### Using the `get_public_interstitial_with_http_info variant
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
@@ -44,12 +48,12 @@ This returns an Array which contains the response data (`nil` in this case), sta
 ```ruby
 begin
   # Returns the markup for the interstitial page
-  data, status_code, headers = api_instance.get_public_interstitial_with_http_info(opts)
+  data, status_code, headers = Clerk::SDK.miscellaneous.get_public_interstitial_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling MiscellaneousApi->get_public_interstitial_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.miscellaneous->get_public_interstitial_with_http_info: #{e}"
 end
 ```
 

data/docs/{OAuthApplication.md → OauthApplication.md}

@@ -15,6 +15,8 @@
 | **authorize_url** | **String** |  |  |
 | **token_fetch_url** | **String** |  |  |
 | **user_info_url** | **String** |  |  |
+| **discovery_url** | **String** |  |  |
+| **token_introspection_url** | **String** |  |  |
 | **created_at** | **Integer** | Unix timestamp of creation.  |  |
 | **updated_at** | **Integer** | Unix timestamp of last update.  |  |
 
@@ -35,6 +37,8 @@ instance = ClerkHttpClient::OAuthApplication.new(
   authorize_url: null,
   token_fetch_url: null,
   user_info_url: null,
+  discovery_url: null,
+  token_introspection_url: null,
   created_at: null,
   updated_at: null
 )

data/docs/{OAuthApplicationWithSecret.md → OauthApplicationWithSecret.md}

@@ -15,6 +15,8 @@
 | **authorize_url** | **String** |  |  |
 | **token_fetch_url** | **String** |  |  |
 | **user_info_url** | **String** |  |  |
+| **discovery_url** | **String** |  |  |
+| **token_introspection_url** | **String** |  |  |
 | **created_at** | **Integer** | Unix timestamp of creation.  |  |
 | **updated_at** | **Integer** | Unix timestamp of last update.  |  |
 | **client_secret** | **String** | Empty if public client.  | [optional] |
@@ -36,6 +38,8 @@ instance = ClerkHttpClient::OAuthApplicationWithSecret.new(
   authorize_url: null,
   token_fetch_url: null,
   user_info_url: null,
+  discovery_url: null,
+  token_introspection_url: null,
   created_at: null,
   updated_at: null,
   client_secret: null