clerk-http-client 0.0.1

data/docs/JWTTemplatesApi.md

@@ -0,0 +1,354 @@
+# ClerkHttpClient::JWTTemplatesApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_jwt_template**](JWTTemplatesApi.md#create_jwt_template) | **POST** /jwt_templates | Create a JWT template |
+| [**delete_jwt_template**](JWTTemplatesApi.md#delete_jwt_template) | **DELETE** /jwt_templates/{template_id} | Delete a Template |
+| [**get_jwt_template**](JWTTemplatesApi.md#get_jwt_template) | **GET** /jwt_templates/{template_id} | Retrieve a template |
+| [**list_jwt_templates**](JWTTemplatesApi.md#list_jwt_templates) | **GET** /jwt_templates | List all templates |
+| [**update_jwt_template**](JWTTemplatesApi.md#update_jwt_template) | **PATCH** /jwt_templates/{template_id} | Update a JWT template |
+
+
+## create_jwt_template
+
+> <JWTTemplate> create_jwt_template(create_jwt_template_request)
+
+Create a JWT template
+
+Create a new JWT template
+
+### Examples
+
+```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'
+end
+
+api_instance = ClerkHttpClient::JWTTemplatesApi.new
+create_jwt_template_request = ClerkHttpClient::CreateJWTTemplateRequest.new # CreateJWTTemplateRequest | 
+
+begin
+  # Create a JWT template
+  result = api_instance.create_jwt_template(create_jwt_template_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling JWTTemplatesApi->create_jwt_template: #{e}"
+end
+```
+
+#### 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)
+
+```ruby
+begin
+  # Create a JWT template
+  data, status_code, headers = api_instance.create_jwt_template_with_http_info(create_jwt_template_request)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_jwt_template_request** | [**CreateJWTTemplateRequest**](CreateJWTTemplateRequest.md) |  |  |
+
+### Return type
+
+[**JWTTemplate**](JWTTemplate.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_jwt_template
+
+> <DeletedObject> delete_jwt_template(template_id)
+
+Delete a Template
+
+
+
+### Examples
+
+```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'
+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)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling JWTTemplatesApi->delete_jwt_template: #{e}"
+end
+```
+
+#### Using the delete_jwt_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_jwt_template_with_http_info(template_id)
+
+```ruby
+begin
+  # Delete a Template
+  data, status_code, headers = api_instance.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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | JWT Template ID |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_jwt_template
+
+> <JWTTemplate> get_jwt_template(template_id)
+
+Retrieve a template
+
+Retrieve the details of a given JWT template
+
+### Examples
+
+```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'
+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)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling JWTTemplatesApi->get_jwt_template: #{e}"
+end
+```
+
+#### Using the get_jwt_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<JWTTemplate>, Integer, Hash)> get_jwt_template_with_http_info(template_id)
+
+```ruby
+begin
+  # Retrieve a template
+  data, status_code, headers = api_instance.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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | JWT Template ID |  |
+
+### Return type
+
+[**JWTTemplate**](JWTTemplate.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_jwt_templates
+
+> <Array<JWTTemplate>> list_jwt_templates
+
+List all templates
+
+### Examples
+
+```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'
+end
+
+api_instance = ClerkHttpClient::JWTTemplatesApi.new
+
+begin
+  # List all templates
+  result = api_instance.list_jwt_templates
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling JWTTemplatesApi->list_jwt_templates: #{e}"
+end
+```
+
+#### Using the list_jwt_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<JWTTemplate>>, Integer, Hash)> list_jwt_templates_with_http_info
+
+```ruby
+begin
+  # List all templates
+  data, status_code, headers = api_instance.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}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;JWTTemplate&gt;**](JWTTemplate.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_jwt_template
+
+> <JWTTemplate> update_jwt_template(template_id, create_jwt_template_request)
+
+Update a JWT template
+
+Updates an existing JWT template
+
+### Examples
+
+```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'
+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 | 
+
+begin
+  # Update a JWT template
+  result = api_instance.update_jwt_template(template_id, create_jwt_template_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling JWTTemplatesApi->update_jwt_template: #{e}"
+end
+```
+
+#### 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)
+
+```ruby
+begin
+  # Update a JWT template
+  data, status_code, headers = api_instance.update_jwt_template_with_http_info(template_id, create_jwt_template_request)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_id** | **String** | The ID of the JWT template to update |  |
+| **create_jwt_template_request** | [**CreateJWTTemplateRequest**](CreateJWTTemplateRequest.md) |  |  |
+
+### Return type
+
+[**JWTTemplate**](JWTTemplate.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/MergeOrganizationMetadataRequest.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::MergeOrganizationMetadataRequest
+
+## Properties
+
+| 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] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::MergeOrganizationMetadataRequest.new(
+  public_metadata: null,
+  private_metadata: null
+)
+```
+

data/docs/MiscellaneousApi.md

@@ -0,0 +1,75 @@
+# ClerkHttpClient::MiscellaneousApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_public_interstitial**](MiscellaneousApi.md#get_public_interstitial) | **GET** /public/interstitial | Returns the markup for the interstitial page |
+
+
+## get_public_interstitial
+
+> get_public_interstitial(opts)
+
+Returns the markup for the interstitial page
+
+The Clerk interstitial endpoint serves an html page that loads clerk.js in order to check the user's authentication state. It is used by Clerk SDKs when the user's authentication state cannot be immediately determined.
+
+### Examples
+
+```ruby
+require 'time'
+require 'clerk-http-client'
+
+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
+}
+
+begin
+  # Returns the markup for the interstitial page
+  api_instance.get_public_interstitial(opts)
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling MiscellaneousApi->get_public_interstitial: #{e}"
+end
+```
+
+#### 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.
+
+> <Array(nil, Integer, Hash)> get_public_interstitial_with_http_info(opts)
+
+```ruby
+begin
+  # Returns the markup for the interstitial page
+  data, status_code, headers = api_instance.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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **frontend_api** | **String** | The Frontend API key of your instance | [optional] |
+| **publishable_key** | **String** | The publishable key of your instance | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/OAuthApplication.md

@@ -0,0 +1,42 @@
+# ClerkHttpClient::OAuthApplication
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **instance_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **client_id** | **String** |  |  |
+| **public** | **Boolean** |  |  |
+| **scopes** | **String** |  |  |
+| **callback_url** | **String** |  |  |
+| **authorize_url** | **String** |  |  |
+| **token_fetch_url** | **String** |  |  |
+| **user_info_url** | **String** |  |  |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::OAuthApplication.new(
+  object: null,
+  id: null,
+  instance_id: null,
+  name: null,
+  client_id: null,
+  public: null,
+  scopes: null,
+  callback_url: null,
+  authorize_url: null,
+  token_fetch_url: null,
+  user_info_url: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/OAuthApplicationWithSecret.md

@@ -0,0 +1,44 @@
+# ClerkHttpClient::OAuthApplicationWithSecret
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **instance_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **client_id** | **String** |  |  |
+| **public** | **Boolean** |  |  |
+| **scopes** | **String** |  |  |
+| **callback_url** | **String** |  |  |
+| **authorize_url** | **String** |  |  |
+| **token_fetch_url** | **String** |  |  |
+| **user_info_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] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::OAuthApplicationWithSecret.new(
+  object: null,
+  id: null,
+  instance_id: null,
+  name: null,
+  client_id: null,
+  public: null,
+  scopes: null,
+  callback_url: null,
+  authorize_url: null,
+  token_fetch_url: null,
+  user_info_url: null,
+  created_at: null,
+  updated_at: null,
+  client_secret: null
+)
+```
+

data/docs/OAuthApplications.md

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