clerk-http-client 0.0.1

data/docs/BetaFeaturesApi.md

@@ -0,0 +1,217 @@
+# ClerkHttpClient::BetaFeaturesApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**change_production_instance_domain**](BetaFeaturesApi.md#change_production_instance_domain) | **POST** /instance/change_domain | Update production instance domain |
+| [**update_instance_auth_config**](BetaFeaturesApi.md#update_instance_auth_config) | **PATCH** /beta_features/instance_settings | Update instance settings |
+| [**update_production_instance_domain**](BetaFeaturesApi.md#update_production_instance_domain) | **PUT** /beta_features/domain | Update production instance domain |
+
+
+## change_production_instance_domain
+
+> change_production_instance_domain(change_production_instance_domain_request)
+
+Update production instance domain
+
+Change the domain of a production instance.  Changing the domain requires updating the [DNS records](https://clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](https://clerk.com/docs/deployments/overview#deploy), updating your Social Connection's redirect URLs and setting the new keys in your code.  WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.
+
+### 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::BetaFeaturesApi.new
+change_production_instance_domain_request = ClerkHttpClient::ChangeProductionInstanceDomainRequest.new # ChangeProductionInstanceDomainRequest | 
+
+begin
+  # Update production instance domain
+  api_instance.change_production_instance_domain(change_production_instance_domain_request)
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling BetaFeaturesApi->change_production_instance_domain: #{e}"
+end
+```
+
+#### Using the change_production_instance_domain_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)> change_production_instance_domain_with_http_info(change_production_instance_domain_request)
+
+```ruby
+begin
+  # Update production instance domain
+  data, status_code, headers = api_instance.change_production_instance_domain_with_http_info(change_production_instance_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling BetaFeaturesApi->change_production_instance_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **change_production_instance_domain_request** | [**ChangeProductionInstanceDomainRequest**](ChangeProductionInstanceDomainRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_instance_auth_config
+
+> <UpdateInstanceAuthConfig200Response> update_instance_auth_config(update_instance_auth_config_request)
+
+Update instance settings
+
+Updates the settings of an instance
+
+### 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::BetaFeaturesApi.new
+update_instance_auth_config_request = ClerkHttpClient::UpdateInstanceAuthConfigRequest.new # UpdateInstanceAuthConfigRequest | 
+
+begin
+  # Update instance settings
+  result = api_instance.update_instance_auth_config(update_instance_auth_config_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling BetaFeaturesApi->update_instance_auth_config: #{e}"
+end
+```
+
+#### Using the update_instance_auth_config_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UpdateInstanceAuthConfig200Response>, Integer, Hash)> update_instance_auth_config_with_http_info(update_instance_auth_config_request)
+
+```ruby
+begin
+  # Update instance settings
+  data, status_code, headers = api_instance.update_instance_auth_config_with_http_info(update_instance_auth_config_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UpdateInstanceAuthConfig200Response>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling BetaFeaturesApi->update_instance_auth_config_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_instance_auth_config_request** | [**UpdateInstanceAuthConfigRequest**](UpdateInstanceAuthConfigRequest.md) |  |  |
+
+### Return type
+
+[**UpdateInstanceAuthConfig200Response**](UpdateInstanceAuthConfig200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_production_instance_domain
+
+> update_production_instance_domain(opts)
+
+Update production instance domain
+
+Change the domain of a production instance.  Changing the domain requires updating the [DNS records](https://clerk.com/docs/deployments/overview#dns-records) accordingly, deploying new [SSL certificates](https://clerk.com/docs/deployments/overview#deploy), updating your Social Connection's redirect URLs and setting the new keys in your code.  WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.
+
+### 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::BetaFeaturesApi.new
+opts = {
+  update_production_instance_domain_request: ClerkHttpClient::UpdateProductionInstanceDomainRequest.new # UpdateProductionInstanceDomainRequest | 
+}
+
+begin
+  # Update production instance domain
+  api_instance.update_production_instance_domain(opts)
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling BetaFeaturesApi->update_production_instance_domain: #{e}"
+end
+```
+
+#### Using the update_production_instance_domain_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)> update_production_instance_domain_with_http_info(opts)
+
+```ruby
+begin
+  # Update production instance domain
+  data, status_code, headers = api_instance.update_production_instance_domain_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling BetaFeaturesApi->update_production_instance_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_production_instance_domain_request** | [**UpdateProductionInstanceDomainRequest**](UpdateProductionInstanceDomainRequest.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/BlocklistIdentifier.md

@@ -0,0 +1,30 @@
+# ClerkHttpClient::BlocklistIdentifier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | String representing the object's type. Objects of the same type share the same value.  | [optional] |
+| **id** | **String** |  | [optional] |
+| **identifier** | **String** | An email address, email domain, phone number or web3 wallet.  | [optional] |
+| **identifier_type** | **String** |  | [optional] |
+| **instance_id** | **String** |  | [optional] |
+| **created_at** | **Integer** | Unix timestamp of creation  | [optional] |
+| **updated_at** | **Integer** | Unix timestamp of last update.  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::BlocklistIdentifier.new(
+  object: null,
+  id: null,
+  identifier: null,
+  identifier_type: null,
+  instance_id: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/BlocklistIdentifiers.md

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

data/docs/CNameTarget.md

@@ -0,0 +1,22 @@
+# ClerkHttpClient::CNameTarget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** |  |  |
+| **value** | **String** |  |  |
+| **required** | **Boolean** | Denotes whether this CNAME target is required to be set in order for the domain to be considered deployed.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CNameTarget.new(
+  host: null,
+  value: null,
+  required: null
+)
+```
+

data/docs/ChangeProductionInstanceDomainRequest.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::ChangeProductionInstanceDomainRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **home_url** | **String** | The new home URL of the production instance e.g. https://www.example.com | [optional] |
+| **is_secondary** | **Boolean** | Whether this is a domain for a secondary app, meaning that any subdomain provided is significant and will be stored as part of the domain. This is useful for supporting multiple apps (one primary and multiple secondaries) on the same root domain (eTLD+1). | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::ChangeProductionInstanceDomainRequest.new(
+  home_url: null,
+  is_secondary: null
+)
+```
+

data/docs/ClerkError.md

@@ -0,0 +1,26 @@
+# ClerkHttpClient::ClerkError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  |  |
+| **long_message** | **String** |  |  |
+| **code** | **String** |  |  |
+| **meta** | **Object** |  | [optional] |
+| **clerk_trace_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::ClerkError.new(
+  message: null,
+  long_message: null,
+  code: null,
+  meta: null,
+  clerk_trace_id: null
+)
+```
+

data/docs/ClerkErrors.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::ClerkErrors
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<ClerkError>**](ClerkError.md) |  |  |
+| **meta** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::ClerkErrors.new(
+  errors: null,
+  meta: null
+)
+```
+

data/docs/Client.md

@@ -0,0 +1,34 @@
+# ClerkHttpClient::Client
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | String representing the object's type. Objects of the same type share the same value.  |  |
+| **id** | **String** | String representing the identifier of the session.  |  |
+| **session_ids** | **Array<String>** |  |  |
+| **sessions** | [**Array<Session>**](Session.md) |  |  |
+| **sign_in_id** | **String** |  |  |
+| **sign_up_id** | **String** |  |  |
+| **last_active_session_id** | **String** | Last active session_id.  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::Client.new(
+  object: null,
+  id: null,
+  session_ids: null,
+  sessions: null,
+  sign_in_id: null,
+  sign_up_id: null,
+  last_active_session_id: null,
+  updated_at: null,
+  created_at: null
+)
+```
+

data/docs/ClientsApi.md

@@ -0,0 +1,221 @@
+# ClerkHttpClient::ClientsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_client**](ClientsApi.md#get_client) | **GET** /clients/{client_id} | Get a client |
+| [**get_client_list**](ClientsApi.md#get_client_list) | **GET** /clients | List all clients |
+| [**verify_client**](ClientsApi.md#verify_client) | **POST** /clients/verify | Verify a client |
+
+
+## get_client
+
+> <Client> get_client(client_id)
+
+Get a client
+
+Returns the details of a client.
+
+### 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::ClientsApi.new
+client_id = 'client_id_example' # String | Client ID.
+
+begin
+  # Get a client
+  result = api_instance.get_client(client_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ClientsApi->get_client: #{e}"
+end
+```
+
+#### Using the get_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Client>, Integer, Hash)> get_client_with_http_info(client_id)
+
+```ruby
+begin
+  # Get a client
+  data, status_code, headers = api_instance.get_client_with_http_info(client_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Client>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ClientsApi->get_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | Client ID. |  |
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_client_list
+
+> <Array<Client>> get_client_list(opts)
+
+List all clients
+
+Returns a list of all clients. The clients are returned sorted by creation date, with the newest clients appearing first. Warning: the endpoint is being deprecated and will be removed in future versions.
+
+### 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::ClientsApi.new
+opts = {
+  limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
+  offset: 8.14 # Float | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
+}
+
+begin
+  # List all clients
+  result = api_instance.get_client_list(opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ClientsApi->get_client_list: #{e}"
+end
+```
+
+#### Using the get_client_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Client>>, Integer, Hash)> get_client_list_with_http_info(opts)
+
+```ruby
+begin
+  # List all clients
+  data, status_code, headers = api_instance.get_client_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Client>>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ClientsApi->get_client_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** | Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. | [optional][default to 10] |
+| **offset** | **Float** | Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. | [optional][default to 0] |
+
+### Return type
+
+[**Array&lt;Client&gt;**](Client.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## verify_client
+
+> <Client> verify_client(verify_client_request)
+
+Verify a client
+
+Verifies the client in the provided token
+
+### 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::ClientsApi.new
+verify_client_request = ClerkHttpClient::VerifyClientRequest.new # VerifyClientRequest | 
+
+begin
+  # Verify a client
+  result = api_instance.verify_client(verify_client_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ClientsApi->verify_client: #{e}"
+end
+```
+
+#### Using the verify_client_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Client>, Integer, Hash)> verify_client_with_http_info(verify_client_request)
+
+```ruby
+begin
+  # Verify a client
+  data, status_code, headers = api_instance.verify_client_with_http_info(verify_client_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Client>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ClientsApi->verify_client_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verify_client_request** | [**VerifyClientRequest**](VerifyClientRequest.md) |  |  |
+
+### Return type
+
+[**Client**](Client.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CreateActorTokenRequest.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::CreateActorTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The ID of the user being impersonated. |  |
+| **actor** | **Object** | The actor payload. It needs to include a sub property which should contain the ID of the actor. This whole payload will be also included in the JWT session token. |  |
+| **expires_in_seconds** | **Integer** | Optional parameter to specify the life duration of the actor token in seconds. By default, the duration is 1 hour. | [optional][default to 3600] |
+| **session_max_duration_in_seconds** | **Integer** | The maximum duration that the session which will be created by the generated actor token should last. By default, the duration of a session created via an actor token, lasts 30 minutes. | [optional][default to 1800] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateActorTokenRequest.new(
+  user_id: null,
+  actor: {"sub":"user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"},
+  expires_in_seconds: null,
+  session_max_duration_in_seconds: null
+)
+```
+

data/docs/CreateAllowlistIdentifierRequest.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::CreateAllowlistIdentifierRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** | The identifier to be added in the allow-list. This can be an email address, a phone number or a web3 wallet. |  |
+| **notify** | **Boolean** | This flag denotes whether the given identifier will receive an invitation to join the application. Note that this only works for email address and phone number identifiers. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateAllowlistIdentifierRequest.new(
+  identifier: null,
+  notify: null
+)
+```
+

data/docs/CreateBlocklistIdentifierRequest.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::CreateBlocklistIdentifierRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier** | **String** | The identifier to be added in the block-list. This can be an email address, a phone number or a web3 wallet. |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateBlocklistIdentifierRequest.new(
+  identifier: null
+)
+```
+