clerk-http-client 0.0.1

data/docs/SessionsApi.md

@@ -0,0 +1,373 @@
+# ClerkHttpClient::SessionsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_session_token_from_template**](SessionsApi.md#create_session_token_from_template) | **POST** /sessions/{session_id}/tokens/{template_name} | Create a session token from a jwt template |
+| [**get_session**](SessionsApi.md#get_session) | **GET** /sessions/{session_id} | Retrieve a session |
+| [**get_session_list**](SessionsApi.md#get_session_list) | **GET** /sessions | List all sessions |
+| [**revoke_session**](SessionsApi.md#revoke_session) | **POST** /sessions/{session_id}/revoke | Revoke a session |
+| [**verify_session**](SessionsApi.md#verify_session) | **POST** /sessions/{session_id}/verify | Verify a session |
+
+
+## create_session_token_from_template
+
+> <CreateSessionTokenFromTemplate200Response> create_session_token_from_template(session_id, template_name)
+
+Create a session token from a jwt template
+
+Creates a JSON Web Token(JWT) based on a session and a JWT Template name defined for your 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::SessionsApi.new
+session_id = 'session_id_example' # String | The ID of the session
+template_name = 'template_name_example' # String | The name of the JWT Template defined in your instance (e.g. `custom_hasura`).
+
+begin
+  # Create a session token from a jwt template
+  result = api_instance.create_session_token_from_template(session_id, template_name)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->create_session_token_from_template: #{e}"
+end
+```
+
+#### Using the create_session_token_from_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSessionTokenFromTemplate200Response>, Integer, Hash)> create_session_token_from_template_with_http_info(session_id, template_name)
+
+```ruby
+begin
+  # Create a session token from a jwt template
+  data, status_code, headers = api_instance.create_session_token_from_template_with_http_info(session_id, template_name)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSessionTokenFromTemplate200Response>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->create_session_token_from_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** | The ID of the session |  |
+| **template_name** | **String** | The name of the JWT Template defined in your instance (e.g. &#x60;custom_hasura&#x60;). |  |
+
+### Return type
+
+[**CreateSessionTokenFromTemplate200Response**](CreateSessionTokenFromTemplate200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_session
+
+> <Session> get_session(session_id)
+
+Retrieve a session
+
+Retrieve the details of a session
+
+### 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::SessionsApi.new
+session_id = 'session_id_example' # String | The ID of the session
+
+begin
+  # Retrieve a session
+  result = api_instance.get_session(session_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->get_session: #{e}"
+end
+```
+
+#### Using the get_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Session>, Integer, Hash)> get_session_with_http_info(session_id)
+
+```ruby
+begin
+  # Retrieve a session
+  data, status_code, headers = api_instance.get_session_with_http_info(session_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Session>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->get_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** | The ID of the session |  |
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_session_list
+
+> <Array<Session>> get_session_list(opts)
+
+List all sessions
+
+Returns a list of all sessions. The sessions are returned sorted by creation date, with the newest sessions appearing first. **Deprecation Notice (2024-01-01):** All parameters were initially considered optional, however moving forward at least one of `client_id` or `user_id` parameters should be provided.
+
+### 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::SessionsApi.new
+opts = {
+  client_id: 'client_id_example', # String | List sessions for the given client
+  user_id: 'user_id_example', # String | List sessions for the given user
+  status: 'abandoned', # String | Filter sessions by the provided status
+  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 sessions
+  result = api_instance.get_session_list(opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->get_session_list: #{e}"
+end
+```
+
+#### Using the get_session_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Session>>, Integer, Hash)> get_session_list_with_http_info(opts)
+
+```ruby
+begin
+  # List all sessions
+  data, status_code, headers = api_instance.get_session_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Session>>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->get_session_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **client_id** | **String** | List sessions for the given client | [optional] |
+| **user_id** | **String** | List sessions for the given user | [optional] |
+| **status** | **String** | Filter sessions by the provided status | [optional] |
+| **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;Session&gt;**](Session.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## revoke_session
+
+> <Session> revoke_session(session_id)
+
+Revoke a session
+
+Sets the status of a session as \"revoked\", which is an unauthenticated state. In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.
+
+### 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::SessionsApi.new
+session_id = 'session_id_example' # String | The ID of the session
+
+begin
+  # Revoke a session
+  result = api_instance.revoke_session(session_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->revoke_session: #{e}"
+end
+```
+
+#### Using the revoke_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Session>, Integer, Hash)> revoke_session_with_http_info(session_id)
+
+```ruby
+begin
+  # Revoke a session
+  data, status_code, headers = api_instance.revoke_session_with_http_info(session_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Session>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->revoke_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** | The ID of the session |  |
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## verify_session
+
+> <Session> verify_session(session_id, opts)
+
+Verify a session
+
+Returns the session if it is authenticated, otherwise returns an error. WARNING: This endpoint is deprecated and will be removed in future versions. We strongly recommend switching to networkless verification using short-lived session tokens,          which is implemented transparently in all recent SDK versions (e.g. [NodeJS SDK](https://clerk.com/docs/backend-requests/handling/nodejs#clerk-express-require-auth)).          For more details on how networkless verification works, refer to our [Session Tokens documentation](https://clerk.com/docs/backend-requests/resources/session-tokens).
+
+### 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::SessionsApi.new
+session_id = 'session_id_example' # String | The ID of the session
+opts = {
+  verify_session_request: ClerkHttpClient::VerifySessionRequest.new # VerifySessionRequest | Parameters.
+}
+
+begin
+  # Verify a session
+  result = api_instance.verify_session(session_id, opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->verify_session: #{e}"
+end
+```
+
+#### Using the verify_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Session>, Integer, Hash)> verify_session_with_http_info(session_id, opts)
+
+```ruby
+begin
+  # Verify a session
+  data, status_code, headers = api_instance.verify_session_with_http_info(session_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Session>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SessionsApi->verify_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** | The ID of the session |  |
+| **verify_session_request** | [**VerifySessionRequest**](VerifySessionRequest.md) | Parameters. | [optional] |
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SignInToken.md

@@ -0,0 +1,32 @@
+# ClerkHttpClient::SignInToken
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **token** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SignInToken.new(
+  object: null,
+  id: null,
+  status: null,
+  user_id: null,
+  token: null,
+  url: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/SignInTokensApi.md

@@ -0,0 +1,147 @@
+# ClerkHttpClient::SignInTokensApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_sign_in_token**](SignInTokensApi.md#create_sign_in_token) | **POST** /sign_in_tokens | Create sign-in token |
+| [**revoke_sign_in_token**](SignInTokensApi.md#revoke_sign_in_token) | **POST** /sign_in_tokens/{sign_in_token_id}/revoke | Revoke the given sign-in token |
+
+
+## create_sign_in_token
+
+> <SignInToken> create_sign_in_token(create_sign_in_token_request)
+
+Create sign-in token
+
+Creates a new sign-in token and associates it with the given user. By default, sign-in tokens expire in 30 days. You can optionally supply a different duration in seconds using the `expires_in_seconds` property.
+
+### 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::SignInTokensApi.new
+create_sign_in_token_request = ClerkHttpClient::CreateSignInTokenRequest.new # CreateSignInTokenRequest | 
+
+begin
+  # Create sign-in token
+  result = api_instance.create_sign_in_token(create_sign_in_token_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SignInTokensApi->create_sign_in_token: #{e}"
+end
+```
+
+#### Using the create_sign_in_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SignInToken>, Integer, Hash)> create_sign_in_token_with_http_info(create_sign_in_token_request)
+
+```ruby
+begin
+  # Create sign-in token
+  data, status_code, headers = api_instance.create_sign_in_token_with_http_info(create_sign_in_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SignInToken>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SignInTokensApi->create_sign_in_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_sign_in_token_request** | [**CreateSignInTokenRequest**](CreateSignInTokenRequest.md) |  |  |
+
+### Return type
+
+[**SignInToken**](SignInToken.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## revoke_sign_in_token
+
+> <SignInToken> revoke_sign_in_token(sign_in_token_id)
+
+Revoke the given sign-in token
+
+Revokes a pending sign-in 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::SignInTokensApi.new
+sign_in_token_id = 'sign_in_token_id_example' # String | The ID of the sign-in token to be revoked
+
+begin
+  # Revoke the given sign-in token
+  result = api_instance.revoke_sign_in_token(sign_in_token_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SignInTokensApi->revoke_sign_in_token: #{e}"
+end
+```
+
+#### Using the revoke_sign_in_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SignInToken>, Integer, Hash)> revoke_sign_in_token_with_http_info(sign_in_token_id)
+
+```ruby
+begin
+  # Revoke the given sign-in token
+  data, status_code, headers = api_instance.revoke_sign_in_token_with_http_info(sign_in_token_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SignInToken>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SignInTokensApi->revoke_sign_in_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **sign_in_token_id** | **String** | The ID of the sign-in token to be revoked |  |
+
+### Return type
+
+[**SignInToken**](SignInToken.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SignUp.md

@@ -0,0 +1,62 @@
+# ClerkHttpClient::SignUp
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **required_fields** | **Array<String>** |  | [optional] |
+| **optional_fields** | **Array<String>** |  | [optional] |
+| **missing_fields** | **Array<String>** |  | [optional] |
+| **unverified_fields** | **Array<String>** |  | [optional] |
+| **verifications** | **Object** |  | [optional] |
+| **username** | **String** |  | [optional] |
+| **email_address** | **String** |  | [optional] |
+| **phone_number** | **String** |  | [optional] |
+| **web3_wallet** | **String** |  | [optional] |
+| **password_enabled** | **Boolean** |  |  |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **unsafe_metadata** | **Object** |  | [optional] |
+| **public_metadata** | **Object** |  | [optional] |
+| **custom_action** | **Boolean** |  |  |
+| **external_id** | **String** |  | [optional] |
+| **created_session_id** | **String** |  | [optional] |
+| **created_user_id** | **String** |  | [optional] |
+| **abandon_at** | **Integer** |  |  |
+| **external_account** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SignUp.new(
+  object: null,
+  id: null,
+  status: null,
+  required_fields: null,
+  optional_fields: null,
+  missing_fields: null,
+  unverified_fields: null,
+  verifications: null,
+  username: null,
+  email_address: null,
+  phone_number: null,
+  web3_wallet: null,
+  password_enabled: null,
+  first_name: null,
+  last_name: null,
+  unsafe_metadata: null,
+  public_metadata: null,
+  custom_action: null,
+  external_id: null,
+  created_session_id: null,
+  created_user_id: null,
+  abandon_at: null,
+  external_account: null
+)
+```
+

data/docs/SignUpsApi.md

@@ -0,0 +1,79 @@
+# ClerkHttpClient::SignUpsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**update_sign_up**](SignUpsApi.md#update_sign_up) | **PATCH** /sign_ups/{id} | Update a sign-up |
+
+
+## update_sign_up
+
+> <SignUp> update_sign_up(id, update_sign_up_request)
+
+Update a sign-up
+
+Update the sign-up with the given ID
+
+### 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::SignUpsApi.new
+id = 'id_example' # String | The ID of the sign-up to update
+update_sign_up_request = ClerkHttpClient::UpdateSignUpRequest.new # UpdateSignUpRequest | 
+
+begin
+  # Update a sign-up
+  result = api_instance.update_sign_up(id, update_sign_up_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SignUpsApi->update_sign_up: #{e}"
+end
+```
+
+#### Using the update_sign_up_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SignUp>, Integer, Hash)> update_sign_up_with_http_info(id, update_sign_up_request)
+
+```ruby
+begin
+  # Update a sign-up
+  data, status_code, headers = api_instance.update_sign_up_with_http_info(id, update_sign_up_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SignUp>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SignUpsApi->update_sign_up_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the sign-up to update |  |
+| **update_sign_up_request** | [**UpdateSignUpRequest**](UpdateSignUpRequest.md) |  |  |
+
+### Return type
+
+[**SignUp**](SignUp.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SvixURL.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::SvixURL
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **svix_url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SvixURL.new(
+  svix_url: null
+)
+```
+