clerk-http-client 0.0.1

data/docs/ActorTokensApi.md

@@ -0,0 +1,147 @@
+# ClerkHttpClient::ActorTokensApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_actor_token**](ActorTokensApi.md#create_actor_token) | **POST** /actor_tokens | Create actor token |
+| [**revoke_actor_token**](ActorTokensApi.md#revoke_actor_token) | **POST** /actor_tokens/{actor_token_id}/revoke | Revoke actor token |
+
+
+## create_actor_token
+
+> <ActorToken> create_actor_token(create_actor_token_request)
+
+Create actor token
+
+Create an actor token that can be used to impersonate the given user. The `actor` parameter needs to include at least a \"sub\" key whose value is the ID of the actor (impersonating) user.
+
+### 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::ActorTokensApi.new
+create_actor_token_request = ClerkHttpClient::CreateActorTokenRequest.new({user_id: 'user_id_example', actor: {"sub":"user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"}}) # CreateActorTokenRequest | 
+
+begin
+  # Create actor token
+  result = api_instance.create_actor_token(create_actor_token_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ActorTokensApi->create_actor_token: #{e}"
+end
+```
+
+#### Using the create_actor_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ActorToken>, Integer, Hash)> create_actor_token_with_http_info(create_actor_token_request)
+
+```ruby
+begin
+  # Create actor token
+  data, status_code, headers = api_instance.create_actor_token_with_http_info(create_actor_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ActorToken>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ActorTokensApi->create_actor_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_actor_token_request** | [**CreateActorTokenRequest**](CreateActorTokenRequest.md) |  |  |
+
+### Return type
+
+[**ActorToken**](ActorToken.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## revoke_actor_token
+
+> <ActorToken> revoke_actor_token(actor_token_id)
+
+Revoke actor token
+
+Revokes a pending actor 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::ActorTokensApi.new
+actor_token_id = 'actor_token_id_example' # String | The ID of the actor token to be revoked.
+
+begin
+  # Revoke actor token
+  result = api_instance.revoke_actor_token(actor_token_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ActorTokensApi->revoke_actor_token: #{e}"
+end
+```
+
+#### Using the revoke_actor_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ActorToken>, Integer, Hash)> revoke_actor_token_with_http_info(actor_token_id)
+
+```ruby
+begin
+  # Revoke actor token
+  data, status_code, headers = api_instance.revoke_actor_token_with_http_info(actor_token_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ActorToken>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ActorTokensApi->revoke_actor_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **actor_token_id** | **String** | The ID of the actor token to be revoked. |  |
+
+### Return type
+
+[**ActorToken**](ActorToken.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AddDomainRequest.md

@@ -0,0 +1,22 @@
+# ClerkHttpClient::AddDomainRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The new domain name. Can contain the port for development instances. |  |
+| **is_satellite** | **Boolean** | Marks the new domain as satellite. Only `true` is accepted at the moment. |  |
+| **proxy_url** | **String** | The full URL of the proxy which will forward requests to the Clerk Frontend API for this domain. Applicable only to production instances. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::AddDomainRequest.new(
+  name: null,
+  is_satellite: null,
+  proxy_url: null
+)
+```
+

data/docs/Admin.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::Admin
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **strategy** | **String** |  |  |
+| **attempts** | **Integer** |  | [optional] |
+| **expire_at** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::Admin.new(
+  status: null,
+  strategy: null,
+  attempts: null,
+  expire_at: null
+)
+```
+

data/docs/AllowListBlockListApi.md

@@ -0,0 +1,421 @@
+# ClerkHttpClient::AllowListBlockListApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_allowlist_identifier**](AllowListBlockListApi.md#create_allowlist_identifier) | **POST** /allowlist_identifiers | Add identifier to the allow-list |
+| [**create_blocklist_identifier**](AllowListBlockListApi.md#create_blocklist_identifier) | **POST** /blocklist_identifiers | Add identifier to the block-list |
+| [**delete_allowlist_identifier**](AllowListBlockListApi.md#delete_allowlist_identifier) | **DELETE** /allowlist_identifiers/{identifier_id} | Delete identifier from allow-list |
+| [**delete_blocklist_identifier**](AllowListBlockListApi.md#delete_blocklist_identifier) | **DELETE** /blocklist_identifiers/{identifier_id} | Delete identifier from block-list |
+| [**list_allowlist_identifiers**](AllowListBlockListApi.md#list_allowlist_identifiers) | **GET** /allowlist_identifiers | List all identifiers on the allow-list |
+| [**list_blocklist_identifiers**](AllowListBlockListApi.md#list_blocklist_identifiers) | **GET** /blocklist_identifiers | List all identifiers on the block-list |
+
+
+## create_allowlist_identifier
+
+> <AllowlistIdentifier> create_allowlist_identifier(create_allowlist_identifier_request)
+
+Add identifier to the allow-list
+
+Create an identifier allowed to sign up to 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::AllowListBlockListApi.new
+create_allowlist_identifier_request = ClerkHttpClient::CreateAllowlistIdentifierRequest.new({identifier: 'identifier_example'}) # CreateAllowlistIdentifierRequest | 
+
+begin
+  # Add identifier to the allow-list
+  result = api_instance.create_allowlist_identifier(create_allowlist_identifier_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->create_allowlist_identifier: #{e}"
+end
+```
+
+#### Using the create_allowlist_identifier_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AllowlistIdentifier>, Integer, Hash)> create_allowlist_identifier_with_http_info(create_allowlist_identifier_request)
+
+```ruby
+begin
+  # Add identifier to the allow-list
+  data, status_code, headers = api_instance.create_allowlist_identifier_with_http_info(create_allowlist_identifier_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AllowlistIdentifier>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->create_allowlist_identifier_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_allowlist_identifier_request** | [**CreateAllowlistIdentifierRequest**](CreateAllowlistIdentifierRequest.md) |  |  |
+
+### Return type
+
+[**AllowlistIdentifier**](AllowlistIdentifier.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_blocklist_identifier
+
+> <BlocklistIdentifier> create_blocklist_identifier(create_blocklist_identifier_request)
+
+Add identifier to the block-list
+
+Create an identifier that is blocked from accessing 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::AllowListBlockListApi.new
+create_blocklist_identifier_request = ClerkHttpClient::CreateBlocklistIdentifierRequest.new({identifier: 'identifier_example'}) # CreateBlocklistIdentifierRequest | 
+
+begin
+  # Add identifier to the block-list
+  result = api_instance.create_blocklist_identifier(create_blocklist_identifier_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->create_blocklist_identifier: #{e}"
+end
+```
+
+#### Using the create_blocklist_identifier_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BlocklistIdentifier>, Integer, Hash)> create_blocklist_identifier_with_http_info(create_blocklist_identifier_request)
+
+```ruby
+begin
+  # Add identifier to the block-list
+  data, status_code, headers = api_instance.create_blocklist_identifier_with_http_info(create_blocklist_identifier_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BlocklistIdentifier>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->create_blocklist_identifier_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_blocklist_identifier_request** | [**CreateBlocklistIdentifierRequest**](CreateBlocklistIdentifierRequest.md) |  |  |
+
+### Return type
+
+[**BlocklistIdentifier**](BlocklistIdentifier.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_allowlist_identifier
+
+> <DeletedObject> delete_allowlist_identifier(identifier_id)
+
+Delete identifier from allow-list
+
+Delete an identifier from the instance allow-list
+
+### 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::AllowListBlockListApi.new
+identifier_id = 'identifier_id_example' # String | The ID of the identifier to delete from the allow-list
+
+begin
+  # Delete identifier from allow-list
+  result = api_instance.delete_allowlist_identifier(identifier_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->delete_allowlist_identifier: #{e}"
+end
+```
+
+#### Using the delete_allowlist_identifier_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_allowlist_identifier_with_http_info(identifier_id)
+
+```ruby
+begin
+  # Delete identifier from allow-list
+  data, status_code, headers = api_instance.delete_allowlist_identifier_with_http_info(identifier_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedObject>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->delete_allowlist_identifier_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier_id** | **String** | The ID of the identifier to delete from the allow-list |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## delete_blocklist_identifier
+
+> <DeletedObject> delete_blocklist_identifier(identifier_id)
+
+Delete identifier from block-list
+
+Delete an identifier from the instance block-list
+
+### 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::AllowListBlockListApi.new
+identifier_id = 'identifier_id_example' # String | The ID of the identifier to delete from the block-list
+
+begin
+  # Delete identifier from block-list
+  result = api_instance.delete_blocklist_identifier(identifier_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->delete_blocklist_identifier: #{e}"
+end
+```
+
+#### Using the delete_blocklist_identifier_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_blocklist_identifier_with_http_info(identifier_id)
+
+```ruby
+begin
+  # Delete identifier from block-list
+  data, status_code, headers = api_instance.delete_blocklist_identifier_with_http_info(identifier_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedObject>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->delete_blocklist_identifier_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identifier_id** | **String** | The ID of the identifier to delete from the block-list |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_allowlist_identifiers
+
+> <Array<AllowlistIdentifier>> list_allowlist_identifiers
+
+List all identifiers on the allow-list
+
+Get a list of all identifiers allowed to sign up to 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::AllowListBlockListApi.new
+
+begin
+  # List all identifiers on the allow-list
+  result = api_instance.list_allowlist_identifiers
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->list_allowlist_identifiers: #{e}"
+end
+```
+
+#### Using the list_allowlist_identifiers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<AllowlistIdentifier>>, Integer, Hash)> list_allowlist_identifiers_with_http_info
+
+```ruby
+begin
+  # List all identifiers on the allow-list
+  data, status_code, headers = api_instance.list_allowlist_identifiers_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<AllowlistIdentifier>>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->list_allowlist_identifiers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;AllowlistIdentifier&gt;**](AllowlistIdentifier.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_blocklist_identifiers
+
+> <BlocklistIdentifiers> list_blocklist_identifiers
+
+List all identifiers on the block-list
+
+Get a list of all identifiers which are not allowed to access 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::AllowListBlockListApi.new
+
+begin
+  # List all identifiers on the block-list
+  result = api_instance.list_blocklist_identifiers
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->list_blocklist_identifiers: #{e}"
+end
+```
+
+#### Using the list_blocklist_identifiers_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BlocklistIdentifiers>, Integer, Hash)> list_blocklist_identifiers_with_http_info
+
+```ruby
+begin
+  # List all identifiers on the block-list
+  data, status_code, headers = api_instance.list_blocklist_identifiers_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BlocklistIdentifiers>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling AllowListBlockListApi->list_blocklist_identifiers_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**BlocklistIdentifiers**](BlocklistIdentifiers.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AllowlistIdentifier.md

@@ -0,0 +1,32 @@
+# ClerkHttpClient::AllowlistIdentifier
+
+## 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] |
+| **invitation_id** | **String** |  | [optional] |
+| **identifier** | **String** | An email address or a phone number.  | [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::AllowlistIdentifier.new(
+  object: null,
+  id: null,
+  invitation_id: null,
+  identifier: null,
+  identifier_type: null,
+  instance_id: null,
+  created_at: null,
+  updated_at: null
+)
+```
+