clerk-http-client 0.0.1

data/docs/DomainsApi.md

@@ -0,0 +1,286 @@
+# ClerkHttpClient::DomainsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**add_domain**](DomainsApi.md#add_domain) | **POST** /domains | Add a domain |
+| [**delete_domain**](DomainsApi.md#delete_domain) | **DELETE** /domains/{domain_id} | Delete a satellite domain |
+| [**list_domains**](DomainsApi.md#list_domains) | **GET** /domains | List all instance domains |
+| [**update_domain**](DomainsApi.md#update_domain) | **PATCH** /domains/{domain_id} | Update a domain |
+
+
+## add_domain
+
+> <Domain> add_domain(add_domain_request)
+
+Add a domain
+
+Add a new domain for your instance. Useful in the case of multi-domain instances, allows adding satellite domains to an instance. The new domain must have a `name`. The domain name can contain the port for development instances, like `localhost:3000`. At the moment, instances can have only one primary domain, so the `is_satellite` parameter must be set to `true`. If you're planning to configure the new satellite domain to run behind a proxy, pass the `proxy_url` parameter accordingly.
+
+### 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::DomainsApi.new
+add_domain_request = ClerkHttpClient::AddDomainRequest.new({name: 'name_example', is_satellite: false}) # AddDomainRequest | 
+
+begin
+  # Add a domain
+  result = api_instance.add_domain(add_domain_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->add_domain: #{e}"
+end
+```
+
+#### Using the add_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> add_domain_with_http_info(add_domain_request)
+
+```ruby
+begin
+  # Add a domain
+  data, status_code, headers = api_instance.add_domain_with_http_info(add_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->add_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_domain_request** | [**AddDomainRequest**](AddDomainRequest.md) |  |  |
+
+### Return type
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_domain
+
+> <DeletedObject> delete_domain(domain_id)
+
+Delete a satellite domain
+
+Deletes a satellite domain for the instance. It is currently not possible to delete the instance's primary domain.
+
+### 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::DomainsApi.new
+domain_id = 'domain_id_example' # String | The ID of the domain that will be deleted. Must be a satellite domain.
+
+begin
+  # Delete a satellite domain
+  result = api_instance.delete_domain(domain_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->delete_domain: #{e}"
+end
+```
+
+#### Using the delete_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_domain_with_http_info(domain_id)
+
+```ruby
+begin
+  # Delete a satellite domain
+  data, status_code, headers = api_instance.delete_domain_with_http_info(domain_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedObject>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->delete_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_id** | **String** | The ID of the domain that will be deleted. Must be a satellite domain. |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_domains
+
+> <Domains> list_domains
+
+List all instance domains
+
+Use this endpoint to get a list of all domains for an instance. The response will contain the primary domain for the instance and any satellite domains. Each domain in the response contains information about the URLs where Clerk operates and the required CNAME targets.
+
+### 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::DomainsApi.new
+
+begin
+  # List all instance domains
+  result = api_instance.list_domains
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->list_domains: #{e}"
+end
+```
+
+#### Using the list_domains_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domains>, Integer, Hash)> list_domains_with_http_info
+
+```ruby
+begin
+  # List all instance domains
+  data, status_code, headers = api_instance.list_domains_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domains>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->list_domains_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Domains**](Domains.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_domain
+
+> <Domain> update_domain(domain_id, update_domain_request)
+
+Update a domain
+
+The `proxy_url` can be updated only for production instances. Update one of the instance's domains. Both primary and satellite domains can be updated. If you choose to use Clerk via proxy, use this endpoint to specify the `proxy_url`. Whenever you decide you'd rather switch to DNS setup for Clerk, simply set `proxy_url` to `null` for the domain. When you update a production instance's primary domain name, you have to make sure that you've completed all the necessary setup steps for DNS and emails to work. Expect downtime otherwise. Updating a primary domain's name will also update the instance's home origin, affecting the default application paths.
+
+### 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::DomainsApi.new
+domain_id = 'domain_id_example' # String | The ID of the domain that will be updated.
+update_domain_request = ClerkHttpClient::UpdateDomainRequest.new # UpdateDomainRequest | 
+
+begin
+  # Update a domain
+  result = api_instance.update_domain(domain_id, update_domain_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->update_domain: #{e}"
+end
+```
+
+#### Using the update_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Domain>, Integer, Hash)> update_domain_with_http_info(domain_id, update_domain_request)
+
+```ruby
+begin
+  # Update a domain
+  data, status_code, headers = api_instance.update_domain_with_http_info(domain_id, update_domain_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Domain>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling DomainsApi->update_domain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain_id** | **String** | The ID of the domain that will be updated. |  |
+| **update_domain_request** | [**UpdateDomainRequest**](UpdateDomainRequest.md) |  |  |
+
+### Return type
+
+[**Domain**](Domain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/EmailAddress.md

@@ -0,0 +1,32 @@
+# ClerkHttpClient::EmailAddress
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **object** | **String** | String representing the object's type. Objects of the same type share the same value.  |  |
+| **email_address** | **String** |  |  |
+| **reserved** | **Boolean** |  |  |
+| **verification** | [**EmailAddressVerification**](EmailAddressVerification.md) |  |  |
+| **linked_to** | [**Array<IdentificationLink>**](IdentificationLink.md) |  |  |
+| **created_at** | **Integer** | Unix timestamp of creation  |  |
+| **updated_at** | **Integer** | Unix timestamp of creation  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::EmailAddress.new(
+  id: null,
+  object: null,
+  email_address: null,
+  reserved: null,
+  verification: null,
+  linked_to: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/EmailAddressVerification.md

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

data/docs/EmailAddressesApi.md

@@ -0,0 +1,289 @@
+# ClerkHttpClient::EmailAddressesApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_email_address**](EmailAddressesApi.md#create_email_address) | **POST** /email_addresses | Create an email address |
+| [**delete_email_address**](EmailAddressesApi.md#delete_email_address) | **DELETE** /email_addresses/{email_address_id} | Delete an email address |
+| [**get_email_address**](EmailAddressesApi.md#get_email_address) | **GET** /email_addresses/{email_address_id} | Retrieve an email address |
+| [**update_email_address**](EmailAddressesApi.md#update_email_address) | **PATCH** /email_addresses/{email_address_id} | Update an email address |
+
+
+## create_email_address
+
+> <EmailAddress> create_email_address(create_email_address_request)
+
+Create an email address
+
+Create a new email address
+
+### 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::EmailAddressesApi.new
+create_email_address_request = ClerkHttpClient::CreateEmailAddressRequest.new # CreateEmailAddressRequest | 
+
+begin
+  # Create an email address
+  result = api_instance.create_email_address(create_email_address_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->create_email_address: #{e}"
+end
+```
+
+#### Using the create_email_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailAddress>, Integer, Hash)> create_email_address_with_http_info(create_email_address_request)
+
+```ruby
+begin
+  # Create an email address
+  data, status_code, headers = api_instance.create_email_address_with_http_info(create_email_address_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailAddress>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->create_email_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_email_address_request** | [**CreateEmailAddressRequest**](CreateEmailAddressRequest.md) |  |  |
+
+### Return type
+
+[**EmailAddress**](EmailAddress.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_email_address
+
+> <DeletedObject> delete_email_address(email_address_id)
+
+Delete an email address
+
+Delete the email address 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::EmailAddressesApi.new
+email_address_id = 'email_address_id_example' # String | The ID of the email address to delete
+
+begin
+  # Delete an email address
+  result = api_instance.delete_email_address(email_address_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->delete_email_address: #{e}"
+end
+```
+
+#### Using the delete_email_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_email_address_with_http_info(email_address_id)
+
+```ruby
+begin
+  # Delete an email address
+  data, status_code, headers = api_instance.delete_email_address_with_http_info(email_address_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedObject>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->delete_email_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address_id** | **String** | The ID of the email address to delete |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_email_address
+
+> <EmailAddress> get_email_address(email_address_id)
+
+Retrieve an email address
+
+Returns the details of an email address.
+
+### 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::EmailAddressesApi.new
+email_address_id = 'email_address_id_example' # String | The ID of the email address to retrieve
+
+begin
+  # Retrieve an email address
+  result = api_instance.get_email_address(email_address_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->get_email_address: #{e}"
+end
+```
+
+#### Using the get_email_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailAddress>, Integer, Hash)> get_email_address_with_http_info(email_address_id)
+
+```ruby
+begin
+  # Retrieve an email address
+  data, status_code, headers = api_instance.get_email_address_with_http_info(email_address_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailAddress>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->get_email_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address_id** | **String** | The ID of the email address to retrieve |  |
+
+### Return type
+
+[**EmailAddress**](EmailAddress.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_email_address
+
+> <EmailAddress> update_email_address(email_address_id, update_email_address_request)
+
+Update an email address
+
+Updates an email address.
+
+### 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::EmailAddressesApi.new
+email_address_id = 'email_address_id_example' # String | The ID of the email address to update
+update_email_address_request = ClerkHttpClient::UpdateEmailAddressRequest.new # UpdateEmailAddressRequest | 
+
+begin
+  # Update an email address
+  result = api_instance.update_email_address(email_address_id, update_email_address_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->update_email_address: #{e}"
+end
+```
+
+#### Using the update_email_address_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EmailAddress>, Integer, Hash)> update_email_address_with_http_info(email_address_id, update_email_address_request)
+
+```ruby
+begin
+  # Update an email address
+  data, status_code, headers = api_instance.update_email_address_with_http_info(email_address_id, update_email_address_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EmailAddress>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling EmailAddressesApi->update_email_address_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address_id** | **String** | The ID of the email address to update |  |
+| **update_email_address_request** | [**UpdateEmailAddressRequest**](UpdateEmailAddressRequest.md) |  |  |
+
+### Return type
+
+[**EmailAddress**](EmailAddress.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+