clerk-http-client 0.0.1

data/docs/InstanceSettingsApi.md

@@ -0,0 +1,216 @@
+# ClerkHttpClient::InstanceSettingsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**update_instance**](InstanceSettingsApi.md#update_instance) | **PATCH** /instance | Update instance settings |
+| [**update_instance_organization_settings**](InstanceSettingsApi.md#update_instance_organization_settings) | **PATCH** /instance/organization_settings | Update instance organization settings |
+| [**update_instance_restrictions**](InstanceSettingsApi.md#update_instance_restrictions) | **PATCH** /instance/restrictions | Update instance restrictions |
+
+
+## update_instance
+
+> update_instance(update_instance_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::InstanceSettingsApi.new
+update_instance_request = ClerkHttpClient::UpdateInstanceRequest.new # UpdateInstanceRequest | 
+
+begin
+  # Update instance settings
+  api_instance.update_instance(update_instance_request)
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InstanceSettingsApi->update_instance: #{e}"
+end
+```
+
+#### Using the update_instance_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_instance_with_http_info(update_instance_request)
+
+```ruby
+begin
+  # Update instance settings
+  data, status_code, headers = api_instance.update_instance_with_http_info(update_instance_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InstanceSettingsApi->update_instance_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_instance_request** | [**UpdateInstanceRequest**](UpdateInstanceRequest.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_instance_organization_settings
+
+> <OrganizationSettings> update_instance_organization_settings(update_instance_organization_settings_request)
+
+Update instance organization settings
+
+Updates the organization settings of the 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::InstanceSettingsApi.new
+update_instance_organization_settings_request = ClerkHttpClient::UpdateInstanceOrganizationSettingsRequest.new # UpdateInstanceOrganizationSettingsRequest | 
+
+begin
+  # Update instance organization settings
+  result = api_instance.update_instance_organization_settings(update_instance_organization_settings_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InstanceSettingsApi->update_instance_organization_settings: #{e}"
+end
+```
+
+#### Using the update_instance_organization_settings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrganizationSettings>, Integer, Hash)> update_instance_organization_settings_with_http_info(update_instance_organization_settings_request)
+
+```ruby
+begin
+  # Update instance organization settings
+  data, status_code, headers = api_instance.update_instance_organization_settings_with_http_info(update_instance_organization_settings_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrganizationSettings>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InstanceSettingsApi->update_instance_organization_settings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_instance_organization_settings_request** | [**UpdateInstanceOrganizationSettingsRequest**](UpdateInstanceOrganizationSettingsRequest.md) |  |  |
+
+### Return type
+
+[**OrganizationSettings**](OrganizationSettings.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## update_instance_restrictions
+
+> <InstanceRestrictions> update_instance_restrictions(update_instance_restrictions_request)
+
+Update instance restrictions
+
+Updates the restriction 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::InstanceSettingsApi.new
+update_instance_restrictions_request = ClerkHttpClient::UpdateInstanceRestrictionsRequest.new # UpdateInstanceRestrictionsRequest | 
+
+begin
+  # Update instance restrictions
+  result = api_instance.update_instance_restrictions(update_instance_restrictions_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InstanceSettingsApi->update_instance_restrictions: #{e}"
+end
+```
+
+#### Using the update_instance_restrictions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<InstanceRestrictions>, Integer, Hash)> update_instance_restrictions_with_http_info(update_instance_restrictions_request)
+
+```ruby
+begin
+  # Update instance restrictions
+  data, status_code, headers = api_instance.update_instance_restrictions_with_http_info(update_instance_restrictions_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <InstanceRestrictions>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InstanceSettingsApi->update_instance_restrictions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_instance_restrictions_request** | [**UpdateInstanceRestrictionsRequest**](UpdateInstanceRestrictionsRequest.md) |  |  |
+
+### Return type
+
+[**InstanceRestrictions**](InstanceRestrictions.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Invitation.md

@@ -0,0 +1,36 @@
+# ClerkHttpClient::Invitation
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **email_address** | **String** |  |  |
+| **public_metadata** | **Object** |  | [optional] |
+| **revoked** | **Boolean** |  | [optional] |
+| **status** | **String** |  |  |
+| **url** | **String** |  | [optional] |
+| **expires_at** | **Integer** | Unix timestamp of expiration.  | [optional] |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::Invitation.new(
+  object: null,
+  id: null,
+  email_address: null,
+  public_metadata: null,
+  revoked: false,
+  status: pending,
+  url: null,
+  expires_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/InvitationsApi.md

@@ -0,0 +1,223 @@
+# ClerkHttpClient::InvitationsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_invitation**](InvitationsApi.md#create_invitation) | **POST** /invitations | Create an invitation |
+| [**list_invitations**](InvitationsApi.md#list_invitations) | **GET** /invitations | List all invitations |
+| [**revoke_invitation**](InvitationsApi.md#revoke_invitation) | **POST** /invitations/{invitation_id}/revoke | Revokes an invitation |
+
+
+## create_invitation
+
+> <Invitation> create_invitation(create_invitation_request)
+
+Create an invitation
+
+Creates a new invitation for the given email address and sends the invitation email. Keep in mind that you cannot create an invitation if there is already one for the given email address. Also, trying to create an invitation for an email address that already exists in your application will result to an error.
+
+### 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::InvitationsApi.new
+create_invitation_request = ClerkHttpClient::CreateInvitationRequest.new({email_address: 'email_address_example'}) # CreateInvitationRequest | Required parameters
+
+begin
+  # Create an invitation
+  result = api_instance.create_invitation(create_invitation_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InvitationsApi->create_invitation: #{e}"
+end
+```
+
+#### Using the create_invitation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Invitation>, Integer, Hash)> create_invitation_with_http_info(create_invitation_request)
+
+```ruby
+begin
+  # Create an invitation
+  data, status_code, headers = api_instance.create_invitation_with_http_info(create_invitation_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Invitation>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InvitationsApi->create_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_invitation_request** | [**CreateInvitationRequest**](CreateInvitationRequest.md) | Required parameters |  |
+
+### Return type
+
+[**Invitation**](Invitation.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## list_invitations
+
+> <Array<Invitation>> list_invitations(opts)
+
+List all invitations
+
+Returns all non-revoked invitations for your application, sorted by creation date
+
+### 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::InvitationsApi.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`.
+  status: 'pending' # String | Filter invitations based on their status
+}
+
+begin
+  # List all invitations
+  result = api_instance.list_invitations(opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InvitationsApi->list_invitations: #{e}"
+end
+```
+
+#### Using the list_invitations_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Invitation>>, Integer, Hash)> list_invitations_with_http_info(opts)
+
+```ruby
+begin
+  # List all invitations
+  data, status_code, headers = api_instance.list_invitations_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Invitation>>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InvitationsApi->list_invitations_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] |
+| **status** | **String** | Filter invitations based on their status | [optional] |
+
+### Return type
+
+[**Array&lt;Invitation&gt;**](Invitation.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## revoke_invitation
+
+> <RevokeInvitation200Response> revoke_invitation(invitation_id)
+
+Revokes an invitation
+
+Revokes the given invitation. Revoking an invitation will prevent the user from using the invitation link that was sent to them. However, it doesn't prevent the user from signing up if they follow the sign up flow. Only active (i.e. non-revoked) invitations can be revoked.
+
+### 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::InvitationsApi.new
+invitation_id = 'invitation_id_example' # String | The ID of the invitation to be revoked
+
+begin
+  # Revokes an invitation
+  result = api_instance.revoke_invitation(invitation_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InvitationsApi->revoke_invitation: #{e}"
+end
+```
+
+#### Using the revoke_invitation_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RevokeInvitation200Response>, Integer, Hash)> revoke_invitation_with_http_info(invitation_id)
+
+```ruby
+begin
+  # Revokes an invitation
+  data, status_code, headers = api_instance.revoke_invitation_with_http_info(invitation_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RevokeInvitation200Response>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling InvitationsApi->revoke_invitation_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invitation_id** | **String** | The ID of the invitation to be revoked |  |
+
+### Return type
+
+[**RevokeInvitation200Response**](RevokeInvitation200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/JWKSApi.md

@@ -0,0 +1,74 @@
+# ClerkHttpClient::JWKSApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_jwks**](JWKSApi.md#get_jwks) | **GET** /jwks | Retrieve the JSON Web Key Set of the instance |
+
+
+## get_jwks
+
+> <WellKnownJWKS> get_jwks
+
+Retrieve the JSON Web Key Set of the instance
+
+Retrieve the JSON Web Key Set of the 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::JWKSApi.new
+
+begin
+  # Retrieve the JSON Web Key Set of the instance
+  result = api_instance.get_jwks
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling JWKSApi->get_jwks: #{e}"
+end
+```
+
+#### 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
+
+```ruby
+begin
+  # Retrieve the JSON Web Key Set of the instance
+  data, status_code, headers = api_instance.get_jwks_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WellKnownJWKS>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling JWKSApi->get_jwks_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WellKnownJWKS**](WellKnownJWKS.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/JWTTemplate.md

@@ -0,0 +1,36 @@
+# ClerkHttpClient::JWTTemplate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **claims** | **Object** |  |  |
+| **lifetime** | **Integer** |  |  |
+| **allowed_clock_skew** | **Integer** |  |  |
+| **custom_signing_key** | **Boolean** |  | [optional] |
+| **signing_algorithm** | **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::JWTTemplate.new(
+  object: null,
+  id: null,
+  name: null,
+  claims: null,
+  lifetime: null,
+  allowed_clock_skew: null,
+  custom_signing_key: null,
+  signing_algorithm: null,
+  created_at: null,
+  updated_at: null
+)
+```
+