clerk-http-client 1.0.0 → 2.0.0.beta1

data/docs/PhoneNumbersApi.md

@@ -12,7 +12,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## create_phone_number
 
-> <PhoneNumber> create_phone_number(create_phone_number_request)
+> <PhoneNumber> create_phone_number(opts)
 
 Create a phone number
 
@@ -22,40 +22,41 @@ Create a new phone number
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::PhoneNumbersApi.new
-create_phone_number_request = ClerkHttpClient::CreatePhoneNumberRequest.new # CreatePhoneNumberRequest | 
+opts = {
+  create_phone_number_request: ClerkHttpClient::CreatePhoneNumberRequest.new # CreatePhoneNumberRequest | 
+}
 
 begin
   # Create a phone number
-  result = api_instance.create_phone_number(create_phone_number_request)
+  result = Clerk::SDK.phone_numbers.create_phone_number(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling PhoneNumbersApi->create_phone_number: #{e}"
+  puts "Error when calling Clerk::SDK.phone_numbers->create_phone_number: #{e}"
 end
 ```
 
-#### Using the create_phone_number_with_http_info variant
+#### 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)
+> <Array(<PhoneNumber>, Integer, Hash)> create_phone_number_with_http_info(opts)
 
 ```ruby
 begin
   # Create a phone number
-  data, status_code, headers = api_instance.create_phone_number_with_http_info(create_phone_number_request)
+  data, status_code, headers = Clerk::SDK.phone_numbers.create_phone_number_with_http_info(opts)
   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}"
+  puts "Error when calling Clerk::SDK.phone_numbers->create_phone_number_with_http_info: #{e}"
 end
 ```
 
@@ -63,7 +64,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_phone_number_request** | [**CreatePhoneNumberRequest**](CreatePhoneNumberRequest.md) |  |  |
+| **create_phone_number_request** | [**CreatePhoneNumberRequest**](CreatePhoneNumberRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -91,26 +92,25 @@ Delete the phone number with the given ID
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 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)
+  result = Clerk::SDK.phone_numbers.delete_phone_number(phone_number_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling PhoneNumbersApi->delete_phone_number: #{e}"
+  puts "Error when calling Clerk::SDK.phone_numbers->delete_phone_number: #{e}"
 end
 ```
 
-#### Using the delete_phone_number_with_http_info variant
+#### Using the `delete_phone_number_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -119,12 +119,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Delete a phone number
-  data, status_code, headers = api_instance.delete_phone_number_with_http_info(phone_number_id)
+  data, status_code, headers = Clerk::SDK.phone_numbers.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}"
+  puts "Error when calling Clerk::SDK.phone_numbers->delete_phone_number_with_http_info: #{e}"
 end
 ```
 
@@ -160,26 +160,25 @@ Returns the details of a phone number
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 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)
+  result = Clerk::SDK.phone_numbers.get_phone_number(phone_number_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling PhoneNumbersApi->get_phone_number: #{e}"
+  puts "Error when calling Clerk::SDK.phone_numbers->get_phone_number: #{e}"
 end
 ```
 
-#### Using the get_phone_number_with_http_info variant
+#### Using the `get_phone_number_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -188,12 +187,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Retrieve a phone number
-  data, status_code, headers = api_instance.get_phone_number_with_http_info(phone_number_id)
+  data, status_code, headers = Clerk::SDK.phone_numbers.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}"
+  puts "Error when calling Clerk::SDK.phone_numbers->get_phone_number_with_http_info: #{e}"
 end
 ```
 
@@ -219,7 +218,7 @@ end
 
 ## update_phone_number
 
-> <PhoneNumber> update_phone_number(phone_number_id, update_phone_number_request)
+> <PhoneNumber> update_phone_number(phone_number_id, opts)
 
 Update a phone number
 
@@ -229,41 +228,42 @@ Updates a phone number
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 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 | 
+opts = {
+  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)
+  result = Clerk::SDK.phone_numbers.update_phone_number(phone_number_id, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling PhoneNumbersApi->update_phone_number: #{e}"
+  puts "Error when calling Clerk::SDK.phone_numbers->update_phone_number: #{e}"
 end
 ```
 
-#### Using the update_phone_number_with_http_info variant
+#### 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)
+> <Array(<PhoneNumber>, Integer, Hash)> update_phone_number_with_http_info(phone_number_id, opts)
 
 ```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)
+  data, status_code, headers = Clerk::SDK.phone_numbers.update_phone_number_with_http_info(phone_number_id, opts)
   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}"
+  puts "Error when calling Clerk::SDK.phone_numbers->update_phone_number_with_http_info: #{e}"
 end
 ```
 
@@ -272,7 +272,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **phone_number_id** | **String** | The ID of the phone number to update |  |
-| **update_phone_number_request** | [**UpdatePhoneNumberRequest**](UpdatePhoneNumberRequest.md) |  |  |
+| **update_phone_number_request** | [**UpdatePhoneNumberRequest**](UpdatePhoneNumberRequest.md) |  | [optional] |
 
 ### Return type
 

data/docs/ProxyChecksApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## verify_domain_proxy
 
-> <ProxyCheck> verify_domain_proxy(verify_domain_proxy_request)
+> <ProxyCheck> verify_domain_proxy(opts)
 
 Verify the proxy configuration for your domain
 
@@ -19,40 +19,41 @@ This endpoint can be used to validate that a proxy-enabled domain is operational
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::ProxyChecksApi.new
-verify_domain_proxy_request = ClerkHttpClient::VerifyDomainProxyRequest.new # VerifyDomainProxyRequest | 
+opts = {
+  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)
+  result = Clerk::SDK.proxy_checks.verify_domain_proxy(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling ProxyChecksApi->verify_domain_proxy: #{e}"
+  puts "Error when calling Clerk::SDK.proxy_checks->verify_domain_proxy: #{e}"
 end
 ```
 
-#### Using the verify_domain_proxy_with_http_info variant
+#### 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)
+> <Array(<ProxyCheck>, Integer, Hash)> verify_domain_proxy_with_http_info(opts)
 
 ```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)
+  data, status_code, headers = Clerk::SDK.proxy_checks.verify_domain_proxy_with_http_info(opts)
   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}"
+  puts "Error when calling Clerk::SDK.proxy_checks->verify_domain_proxy_with_http_info: #{e}"
 end
 ```
 
@@ -60,7 +61,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **verify_domain_proxy_request** | [**VerifyDomainProxyRequest**](VerifyDomainProxyRequest.md) |  |  |
+| **verify_domain_proxy_request** | [**VerifyDomainProxyRequest**](VerifyDomainProxyRequest.md) |  | [optional] |
 
 ### Return type
 

data/docs/{RedirectURLsApi.md → RedirectUrlsApi.md}

@@ -12,7 +12,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## create_redirect_url
 
-> <RedirectURL> create_redirect_url(create_redirect_url_request)
+> <RedirectURL> create_redirect_url(opts)
 
 Create a redirect URL
 
@@ -22,40 +22,41 @@ Create a redirect URL
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::RedirectURLsApi.new
-create_redirect_url_request = ClerkHttpClient::CreateRedirectURLRequest.new # CreateRedirectURLRequest | 
+opts = {
+  create_redirect_url_request: ClerkHttpClient::CreateRedirectURLRequest.new # CreateRedirectURLRequest | 
+}
 
 begin
   # Create a redirect URL
-  result = api_instance.create_redirect_url(create_redirect_url_request)
+  result = Clerk::SDK.redirect_urls.create_redirect_url(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling RedirectURLsApi->create_redirect_url: #{e}"
+  puts "Error when calling Clerk::SDK.redirect_urls->create_redirect_url: #{e}"
 end
 ```
 
-#### Using the create_redirect_url_with_http_info variant
+#### 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)
+> <Array(<RedirectURL>, Integer, Hash)> create_redirect_url_with_http_info(opts)
 
 ```ruby
 begin
   # Create a redirect URL
-  data, status_code, headers = api_instance.create_redirect_url_with_http_info(create_redirect_url_request)
+  data, status_code, headers = Clerk::SDK.redirect_urls.create_redirect_url_with_http_info(opts)
   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}"
+  puts "Error when calling Clerk::SDK.redirect_urls->create_redirect_url_with_http_info: #{e}"
 end
 ```
 
@@ -63,7 +64,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_redirect_url_request** | [**CreateRedirectURLRequest**](CreateRedirectURLRequest.md) |  |  |
+| **create_redirect_url_request** | [**CreateRedirectURLRequest**](CreateRedirectURLRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -91,26 +92,25 @@ Remove the selected redirect URL from the whitelist of the instance
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 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)
+  result = Clerk::SDK.redirect_urls.delete_redirect_url(id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling RedirectURLsApi->delete_redirect_url: #{e}"
+  puts "Error when calling Clerk::SDK.redirect_urls->delete_redirect_url: #{e}"
 end
 ```
 
-#### Using the delete_redirect_url_with_http_info variant
+#### Using the `delete_redirect_url_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -119,12 +119,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Delete a redirect URL
-  data, status_code, headers = api_instance.delete_redirect_url_with_http_info(id)
+  data, status_code, headers = Clerk::SDK.redirect_urls.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}"
+  puts "Error when calling Clerk::SDK.redirect_urls->delete_redirect_url_with_http_info: #{e}"
 end
 ```
 
@@ -160,26 +160,25 @@ Retrieve the details of the redirect URL with the given ID
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 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)
+  result = Clerk::SDK.redirect_urls.get_redirect_url(id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling RedirectURLsApi->get_redirect_url: #{e}"
+  puts "Error when calling Clerk::SDK.redirect_urls->get_redirect_url: #{e}"
 end
 ```
 
-#### Using the get_redirect_url_with_http_info variant
+#### Using the `get_redirect_url_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -188,12 +187,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Retrieve a redirect URL
-  data, status_code, headers = api_instance.get_redirect_url_with_http_info(id)
+  data, status_code, headers = Clerk::SDK.redirect_urls.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}"
+  puts "Error when calling Clerk::SDK.redirect_urls->get_redirect_url_with_http_info: #{e}"
 end
 ```
 
@@ -229,25 +228,24 @@ Lists all whitelisted redirect_urls for the instance
 
 ```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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::RedirectURLsApi.new
 
 begin
   # List all redirect URLs
-  result = api_instance.list_redirect_urls
+  result = Clerk::SDK.redirect_urls.list_redirect_urls
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling RedirectURLsApi->list_redirect_urls: #{e}"
+  puts "Error when calling Clerk::SDK.redirect_urls->list_redirect_urls: #{e}"
 end
 ```
 
-#### Using the list_redirect_urls_with_http_info variant
+#### Using the `list_redirect_urls_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -256,12 +254,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # List all redirect URLs
-  data, status_code, headers = api_instance.list_redirect_urls_with_http_info
+  data, status_code, headers = Clerk::SDK.redirect_urls.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}"
+  puts "Error when calling Clerk::SDK.redirect_urls->list_redirect_urls_with_http_info: #{e}"
 end
 ```
 

data/docs/RevokeInvitation200Response.md

@@ -7,7 +7,7 @@
 | **object** | **String** |  |  |
 | **id** | **String** |  |  |
 | **email_address** | **String** |  |  |
-| **public_metadata** | **Object** |  | [optional] |
+| **public_metadata** | **Hash<String, Object>** |  | [optional] |
 | **revoked** | **Boolean** |  | [optional] |
 | **status** | **String** |  |  |
 | **url** | **String** |  | [optional] |

data/docs/SAML.md

@@ -7,7 +7,7 @@
 | **status** | **String** |  |  |
 | **strategy** | **String** |  |  |
 | **external_verification_redirect_url** | **String** |  |  |
-| **error** | [**OauthError**](OauthError.md) |  | [optional] |
+| **error** | [**FromOAuthError**](FromOAuthError.md) |  | [optional] |
 | **expire_at** | **Integer** |  |  |
 | **attempts** | **Integer** |  | [optional] |
 

data/docs/SAMLAccount.md

@@ -12,7 +12,7 @@
 | **first_name** | **String** |  | [optional] |
 | **last_name** | **String** |  | [optional] |
 | **provider_user_id** | **String** |  | [optional] |
-| **public_metadata** | **Object** |  | [optional] |
+| **public_metadata** | **Hash<String, Object>** |  | [optional] |
 | **verification** | [**SAMLAccountVerification**](SAMLAccountVerification.md) |  |  |
 | **saml_connection** | [**SAMLAccountSamlConnection**](SAMLAccountSamlConnection.md) |  | [optional] |