clerk-http-client 0.0.1

data/docs/RedirectURLsApi.md

@@ -0,0 +1,284 @@
+# ClerkHttpClient::RedirectURLsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_redirect_url**](RedirectURLsApi.md#create_redirect_url) | **POST** /redirect_urls | Create a redirect URL |
+| [**delete_redirect_url**](RedirectURLsApi.md#delete_redirect_url) | **DELETE** /redirect_urls/{id} | Delete a redirect URL |
+| [**get_redirect_url**](RedirectURLsApi.md#get_redirect_url) | **GET** /redirect_urls/{id} | Retrieve a redirect URL |
+| [**list_redirect_urls**](RedirectURLsApi.md#list_redirect_urls) | **GET** /redirect_urls | List all redirect URLs |
+
+
+## create_redirect_url
+
+> <RedirectURL> create_redirect_url(create_redirect_url_request)
+
+Create a redirect URL
+
+Create a redirect URL
+
+### 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::RedirectURLsApi.new
+create_redirect_url_request = ClerkHttpClient::CreateRedirectURLRequest.new # CreateRedirectURLRequest | 
+
+begin
+  # Create a redirect URL
+  result = api_instance.create_redirect_url(create_redirect_url_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->create_redirect_url: #{e}"
+end
+```
+
+#### Using the create_redirect_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RedirectURL>, Integer, Hash)> create_redirect_url_with_http_info(create_redirect_url_request)
+
+```ruby
+begin
+  # Create a redirect URL
+  data, status_code, headers = api_instance.create_redirect_url_with_http_info(create_redirect_url_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RedirectURL>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->create_redirect_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_redirect_url_request** | [**CreateRedirectURLRequest**](CreateRedirectURLRequest.md) |  |  |
+
+### Return type
+
+[**RedirectURL**](RedirectURL.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_redirect_url
+
+> <DeletedObject> delete_redirect_url(id)
+
+Delete a redirect URL
+
+Remove the selected redirect URL from the whitelist 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::RedirectURLsApi.new
+id = 'id_example' # String | The ID of the redirect URL
+
+begin
+  # Delete a redirect URL
+  result = api_instance.delete_redirect_url(id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->delete_redirect_url: #{e}"
+end
+```
+
+#### Using the delete_redirect_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_redirect_url_with_http_info(id)
+
+```ruby
+begin
+  # Delete a redirect URL
+  data, status_code, headers = api_instance.delete_redirect_url_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedObject>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->delete_redirect_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the redirect URL |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_redirect_url
+
+> <RedirectURL> get_redirect_url(id)
+
+Retrieve a redirect URL
+
+Retrieve the details of the redirect URL 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::RedirectURLsApi.new
+id = 'id_example' # String | The ID of the redirect URL
+
+begin
+  # Retrieve a redirect URL
+  result = api_instance.get_redirect_url(id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->get_redirect_url: #{e}"
+end
+```
+
+#### Using the get_redirect_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<RedirectURL>, Integer, Hash)> get_redirect_url_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve a redirect URL
+  data, status_code, headers = api_instance.get_redirect_url_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <RedirectURL>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->get_redirect_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The ID of the redirect URL |  |
+
+### Return type
+
+[**RedirectURL**](RedirectURL.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_redirect_urls
+
+> <Array<RedirectURL>> list_redirect_urls
+
+List all redirect URLs
+
+Lists all whitelisted redirect_urls for 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::RedirectURLsApi.new
+
+begin
+  # List all redirect URLs
+  result = api_instance.list_redirect_urls
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->list_redirect_urls: #{e}"
+end
+```
+
+#### Using the list_redirect_urls_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<RedirectURL>>, Integer, Hash)> list_redirect_urls_with_http_info
+
+```ruby
+begin
+  # List all redirect URLs
+  data, status_code, headers = api_instance.list_redirect_urls_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<RedirectURL>>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling RedirectURLsApi->list_redirect_urls_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;RedirectURL&gt;**](RedirectURL.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/RevokeInvitation200Response.md

@@ -0,0 +1,36 @@
+# ClerkHttpClient::RevokeInvitation200Response
+
+## 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::RevokeInvitation200Response.new(
+  object: null,
+  id: null,
+  email_address: null,
+  public_metadata: null,
+  revoked: true,
+  status: revoked,
+  url: null,
+  expires_at: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/RevokeOrganizationInvitationRequest.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::RevokeOrganizationInvitationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **requesting_user_id** | **String** | The ID of the user that revokes the invitation. Must be an administrator in the organization. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::RevokeOrganizationInvitationRequest.new(
+  requesting_user_id: null
+)
+```
+

data/docs/SAML.md

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

data/docs/SAMLAccount.md

@@ -0,0 +1,38 @@
+# ClerkHttpClient::SAMLAccount
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **object** | **String** | String representing the object's type. Objects of the same type share the same value.  |  |
+| **provider** | **String** |  |  |
+| **active** | **Boolean** |  |  |
+| **email_address** | **String** |  |  |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+| **provider_user_id** | **String** |  | [optional] |
+| **public_metadata** | **Object** |  | [optional] |
+| **verification** | [**SAMLAccountVerification**](SAMLAccountVerification.md) |  |  |
+| **saml_connection** | [**SAMLAccountSamlConnection**](SAMLAccountSamlConnection.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SAMLAccount.new(
+  id: null,
+  object: null,
+  provider: null,
+  active: null,
+  email_address: null,
+  first_name: null,
+  last_name: null,
+  provider_user_id: null,
+  public_metadata: null,
+  verification: null,
+  saml_connection: null
+)
+```
+

data/docs/SAMLAccountSamlConnection.md

@@ -0,0 +1,47 @@
+# ClerkHttpClient::SAMLAccountSamlConnection
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'clerk-http-client'
+
+ClerkHttpClient::SAMLAccountSamlConnection.openapi_one_of
+# =>
+# [
+#   :'SAMLConnection'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'clerk-http-client'
+
+ClerkHttpClient::SAMLAccountSamlConnection.build(data)
+# => #<SAMLConnection:0x00007fdd4aab02a0>
+
+ClerkHttpClient::SAMLAccountSamlConnection.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SAMLConnection`
+- `nil` (if no type matches)
+

data/docs/SAMLAccountVerification.md

@@ -0,0 +1,49 @@
+# ClerkHttpClient::SAMLAccountVerification
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'clerk-http-client'
+
+ClerkHttpClient::SAMLAccountVerification.openapi_one_of
+# =>
+# [
+#   :'SAML',
+#   :'Ticket'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'clerk-http-client'
+
+ClerkHttpClient::SAMLAccountVerification.build(data)
+# => #<SAML:0x00007fdd4aab02a0>
+
+ClerkHttpClient::SAMLAccountVerification.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `SAML`
+- `Ticket`
+- `nil` (if no type matches)
+

data/docs/SAMLConnection.md

@@ -0,0 +1,38 @@
+# ClerkHttpClient::SAMLConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **domain** | **String** |  |  |
+| **active** | **Boolean** |  |  |
+| **provider** | **String** |  |  |
+| **sync_user_attributes** | **Boolean** |  |  |
+| **allow_subdomains** | **Boolean** |  | [optional] |
+| **allow_idp_initiated** | **Boolean** |  | [optional] |
+| **disable_additional_identifications** | **Boolean** |  | [optional] |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SAMLConnection.new(
+  id: null,
+  name: null,
+  domain: null,
+  active: null,
+  provider: null,
+  sync_user_attributes: null,
+  allow_subdomains: null,
+  allow_idp_initiated: null,
+  disable_additional_identifications: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/SAMLConnections.md

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