clerk-http-client 0.0.1

data/docs/PhoneNumbersApi.md

@@ -0,0 +1,289 @@
+# ClerkHttpClient::PhoneNumbersApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_phone_number**](PhoneNumbersApi.md#create_phone_number) | **POST** /phone_numbers | Create a phone number |
+| [**delete_phone_number**](PhoneNumbersApi.md#delete_phone_number) | **DELETE** /phone_numbers/{phone_number_id} | Delete a phone number |
+| [**get_phone_number**](PhoneNumbersApi.md#get_phone_number) | **GET** /phone_numbers/{phone_number_id} | Retrieve a phone number |
+| [**update_phone_number**](PhoneNumbersApi.md#update_phone_number) | **PATCH** /phone_numbers/{phone_number_id} | Update a phone number |
+
+
+## create_phone_number
+
+> <PhoneNumber> create_phone_number(create_phone_number_request)
+
+Create a phone number
+
+Create a new phone number
+
+### 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::PhoneNumbersApi.new
+create_phone_number_request = ClerkHttpClient::CreatePhoneNumberRequest.new # CreatePhoneNumberRequest | 
+
+begin
+  # Create a phone number
+  result = api_instance.create_phone_number(create_phone_number_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->create_phone_number: #{e}"
+end
+```
+
+#### Using the create_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneNumber>, Integer, Hash)> create_phone_number_with_http_info(create_phone_number_request)
+
+```ruby
+begin
+  # Create a phone number
+  data, status_code, headers = api_instance.create_phone_number_with_http_info(create_phone_number_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneNumber>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->create_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_phone_number_request** | [**CreatePhoneNumberRequest**](CreatePhoneNumberRequest.md) |  |  |
+
+### Return type
+
+[**PhoneNumber**](PhoneNumber.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_phone_number
+
+> <DeletedObject> delete_phone_number(phone_number_id)
+
+Delete a phone number
+
+Delete the phone number 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::PhoneNumbersApi.new
+phone_number_id = 'phone_number_id_example' # String | The ID of the phone number to delete
+
+begin
+  # Delete a phone number
+  result = api_instance.delete_phone_number(phone_number_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->delete_phone_number: #{e}"
+end
+```
+
+#### Using the delete_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_phone_number_with_http_info(phone_number_id)
+
+```ruby
+begin
+  # Delete a phone number
+  data, status_code, headers = api_instance.delete_phone_number_with_http_info(phone_number_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedObject>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->delete_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number_id** | **String** | The ID of the phone number to delete |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_phone_number
+
+> <PhoneNumber> get_phone_number(phone_number_id)
+
+Retrieve a phone number
+
+Returns the details of a phone number
+
+### 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::PhoneNumbersApi.new
+phone_number_id = 'phone_number_id_example' # String | The ID of the phone number to retrieve
+
+begin
+  # Retrieve a phone number
+  result = api_instance.get_phone_number(phone_number_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->get_phone_number: #{e}"
+end
+```
+
+#### Using the get_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneNumber>, Integer, Hash)> get_phone_number_with_http_info(phone_number_id)
+
+```ruby
+begin
+  # Retrieve a phone number
+  data, status_code, headers = api_instance.get_phone_number_with_http_info(phone_number_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneNumber>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->get_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number_id** | **String** | The ID of the phone number to retrieve |  |
+
+### Return type
+
+[**PhoneNumber**](PhoneNumber.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_phone_number
+
+> <PhoneNumber> update_phone_number(phone_number_id, update_phone_number_request)
+
+Update a phone number
+
+Updates a phone number
+
+### 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::PhoneNumbersApi.new
+phone_number_id = 'phone_number_id_example' # String | The ID of the phone number to update
+update_phone_number_request = ClerkHttpClient::UpdatePhoneNumberRequest.new # UpdatePhoneNumberRequest | 
+
+begin
+  # Update a phone number
+  result = api_instance.update_phone_number(phone_number_id, update_phone_number_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->update_phone_number: #{e}"
+end
+```
+
+#### Using the update_phone_number_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneNumber>, Integer, Hash)> update_phone_number_with_http_info(phone_number_id, update_phone_number_request)
+
+```ruby
+begin
+  # Update a phone number
+  data, status_code, headers = api_instance.update_phone_number_with_http_info(phone_number_id, update_phone_number_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneNumber>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling PhoneNumbersApi->update_phone_number_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number_id** | **String** | The ID of the phone number to update |  |
+| **update_phone_number_request** | [**UpdatePhoneNumberRequest**](UpdatePhoneNumberRequest.md) |  |  |
+
+### Return type
+
+[**PhoneNumber**](PhoneNumber.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PreviewTemplateRequest.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::PreviewTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subject** | **String** | The email subject. Applicable only to email templates. | [optional] |
+| **body** | **String** | The template body before variable interpolation | [optional] |
+| **from_email_name** | **String** | The local part of the From email address that will be used for emails. For example, in the address 'hello@example.com', the local part is 'hello'. Applicable only to email templates. | [optional] |
+| **reply_to_email_name** | **String** | The local part of the Reply To email address that will be used for emails. For example, in the address 'hello@example.com', the local part is 'hello'. Applicable only to email templates. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::PreviewTemplateRequest.new(
+  subject: null,
+  body: null,
+  from_email_name: null,
+  reply_to_email_name: null
+)
+```
+

data/docs/ProxyCheck.md

@@ -0,0 +1,32 @@
+# ClerkHttpClient::ProxyCheck
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **domain_id** | **String** |  |  |
+| **last_run_at** | **Integer** |  |  |
+| **proxy_url** | **String** |  |  |
+| **successful** | **Boolean** |  |  |
+| **created_at** | **Integer** |  |  |
+| **updated_at** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::ProxyCheck.new(
+  object: null,
+  id: null,
+  domain_id: null,
+  last_run_at: null,
+  proxy_url: null,
+  successful: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/ProxyChecksApi.md

@@ -0,0 +1,77 @@
+# ClerkHttpClient::ProxyChecksApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**verify_domain_proxy**](ProxyChecksApi.md#verify_domain_proxy) | **POST** /proxy_checks | Verify the proxy configuration for your domain |
+
+
+## verify_domain_proxy
+
+> <ProxyCheck> verify_domain_proxy(verify_domain_proxy_request)
+
+Verify the proxy configuration for your domain
+
+This endpoint can be used to validate that a proxy-enabled domain is operational. It tries to verify that the proxy URL provided in the parameters maps to a functional proxy that can reach the Clerk Frontend API.  You can use this endpoint before you set a proxy URL for a domain. This way you can ensure that switching to proxy-based configuration will not lead to downtime for your instance.  The `proxy_url` parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy.
+
+### 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::ProxyChecksApi.new
+verify_domain_proxy_request = ClerkHttpClient::VerifyDomainProxyRequest.new # VerifyDomainProxyRequest | 
+
+begin
+  # Verify the proxy configuration for your domain
+  result = api_instance.verify_domain_proxy(verify_domain_proxy_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ProxyChecksApi->verify_domain_proxy: #{e}"
+end
+```
+
+#### Using the verify_domain_proxy_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProxyCheck>, Integer, Hash)> verify_domain_proxy_with_http_info(verify_domain_proxy_request)
+
+```ruby
+begin
+  # Verify the proxy configuration for your domain
+  data, status_code, headers = api_instance.verify_domain_proxy_with_http_info(verify_domain_proxy_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProxyCheck>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling ProxyChecksApi->verify_domain_proxy_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verify_domain_proxy_request** | [**VerifyDomainProxyRequest**](VerifyDomainProxyRequest.md) |  |  |
+
+### Return type
+
+[**ProxyCheck**](ProxyCheck.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/RedirectURL.md

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