clerk-http-client 0.0.1 → 2.0.0.beta1

data/docs/{OAuthApplicationsApi.md → OauthApplicationsApi.md}

@@ -4,17 +4,17 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**create_o_auth_application**](OAuthApplicationsApi.md#create_o_auth_application) | **POST** /oauth_applications | Create an OAuth application |
-| [**delete_o_auth_application**](OAuthApplicationsApi.md#delete_o_auth_application) | **DELETE** /oauth_applications/{oauth_application_id} | Delete an OAuth application |
-| [**get_o_auth_application**](OAuthApplicationsApi.md#get_o_auth_application) | **GET** /oauth_applications/{oauth_application_id} | Retrieve an OAuth application by ID |
-| [**list_o_auth_applications**](OAuthApplicationsApi.md#list_o_auth_applications) | **GET** /oauth_applications | Get a list of OAuth applications for an instance |
-| [**rotate_o_auth_application_secret**](OAuthApplicationsApi.md#rotate_o_auth_application_secret) | **POST** /oauth_applications/{oauth_application_id}/rotate_secret | Rotate the client secret of the given OAuth application |
-| [**update_o_auth_application**](OAuthApplicationsApi.md#update_o_auth_application) | **PATCH** /oauth_applications/{oauth_application_id} | Update an OAuth application |
+| [**create_oauth_application**](OAuthApplicationsApi.md#create_oauth_application) | **POST** /oauth_applications | Create an OAuth application |
+| [**delete_oauth_application**](OAuthApplicationsApi.md#delete_oauth_application) | **DELETE** /oauth_applications/{oauth_application_id} | Delete an OAuth application |
+| [**get_oauth_application**](OAuthApplicationsApi.md#get_oauth_application) | **GET** /oauth_applications/{oauth_application_id} | Retrieve an OAuth application by ID |
+| [**list_oauth_applications**](OAuthApplicationsApi.md#list_oauth_applications) | **GET** /oauth_applications | Get a list of OAuth applications for an instance |
+| [**rotate_oauth_application_secret**](OAuthApplicationsApi.md#rotate_oauth_application_secret) | **POST** /oauth_applications/{oauth_application_id}/rotate_secret | Rotate the client secret of the given OAuth application |
+| [**update_oauth_application**](OAuthApplicationsApi.md#update_oauth_application) | **PATCH** /oauth_applications/{oauth_application_id} | Update an OAuth application |
 
 
-## create_o_auth_application
+## create_oauth_application
 
-> <OAuthApplicationWithSecret> create_o_auth_application(create_o_auth_application_request)
+> <OAuthApplicationWithSecret> create_oauth_application(opts)
 
 Create an OAuth application
 
@@ -24,40 +24,41 @@ Creates a new OAuth application with the given name and callback URL for an inst
 
 ```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::OAuthApplicationsApi.new
-create_o_auth_application_request = ClerkHttpClient::CreateOAuthApplicationRequest.new({name: 'name_example', callback_url: 'callback_url_example'}) # CreateOAuthApplicationRequest | 
+opts = {
+  create_oauth_application_request: ClerkHttpClient::CreateOAuthApplicationRequest.new({name: 'name_example'}) # CreateOAuthApplicationRequest | 
+}
 
 begin
   # Create an OAuth application
-  result = api_instance.create_o_auth_application(create_o_auth_application_request)
+  result = Clerk::SDK.oauth_applications.create_oauth_application(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->create_o_auth_application: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->create_oauth_application: #{e}"
 end
 ```
 
-#### Using the create_o_auth_application_with_http_info variant
+#### Using the `create_oauth_application_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<OAuthApplicationWithSecret>, Integer, Hash)> create_o_auth_application_with_http_info(create_o_auth_application_request)
+> <Array(<OAuthApplicationWithSecret>, Integer, Hash)> create_oauth_application_with_http_info(opts)
 
 ```ruby
 begin
   # Create an OAuth application
-  data, status_code, headers = api_instance.create_o_auth_application_with_http_info(create_o_auth_application_request)
+  data, status_code, headers = Clerk::SDK.oauth_applications.create_oauth_application_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OAuthApplicationWithSecret>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->create_o_auth_application_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->create_oauth_application_with_http_info: #{e}"
 end
 ```
 
@@ -65,7 +66,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_o_auth_application_request** | [**CreateOAuthApplicationRequest**](CreateOAuthApplicationRequest.md) |  |  |
+| **create_oauth_application_request** | [**CreateOAuthApplicationRequest**](CreateOAuthApplicationRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -81,9 +82,9 @@ end
 - **Accept**: application/json
 
 
-## delete_o_auth_application
+## delete_oauth_application
 
-> <DeletedObject> delete_o_auth_application(oauth_application_id)
+> <DeletedObject> delete_oauth_application(oauth_application_id)
 
 Delete an OAuth application
 
@@ -93,40 +94,39 @@ Deletes the given OAuth application. This is not reversible.
 
 ```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::OAuthApplicationsApi.new
 oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application to delete
 
 begin
   # Delete an OAuth application
-  result = api_instance.delete_o_auth_application(oauth_application_id)
+  result = Clerk::SDK.oauth_applications.delete_oauth_application(oauth_application_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->delete_o_auth_application: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->delete_oauth_application: #{e}"
 end
 ```
 
-#### Using the delete_o_auth_application_with_http_info variant
+#### Using the `delete_oauth_application_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<DeletedObject>, Integer, Hash)> delete_o_auth_application_with_http_info(oauth_application_id)
+> <Array(<DeletedObject>, Integer, Hash)> delete_oauth_application_with_http_info(oauth_application_id)
 
 ```ruby
 begin
   # Delete an OAuth application
-  data, status_code, headers = api_instance.delete_o_auth_application_with_http_info(oauth_application_id)
+  data, status_code, headers = Clerk::SDK.oauth_applications.delete_oauth_application_with_http_info(oauth_application_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <DeletedObject>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->delete_o_auth_application_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->delete_oauth_application_with_http_info: #{e}"
 end
 ```
 
@@ -150,9 +150,9 @@ end
 - **Accept**: application/json
 
 
-## get_o_auth_application
+## get_oauth_application
 
-> <OAuthApplication> get_o_auth_application(oauth_application_id)
+> <OAuthApplication> get_oauth_application(oauth_application_id)
 
 Retrieve an OAuth application by ID
 
@@ -162,40 +162,39 @@ Fetches the OAuth application whose ID matches the provided `id` in the path.
 
 ```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::OAuthApplicationsApi.new
 oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application
 
 begin
   # Retrieve an OAuth application by ID
-  result = api_instance.get_o_auth_application(oauth_application_id)
+  result = Clerk::SDK.oauth_applications.get_oauth_application(oauth_application_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->get_o_auth_application: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->get_oauth_application: #{e}"
 end
 ```
 
-#### Using the get_o_auth_application_with_http_info variant
+#### Using the `get_oauth_application_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<OAuthApplication>, Integer, Hash)> get_o_auth_application_with_http_info(oauth_application_id)
+> <Array(<OAuthApplication>, Integer, Hash)> get_oauth_application_with_http_info(oauth_application_id)
 
 ```ruby
 begin
   # Retrieve an OAuth application by ID
-  data, status_code, headers = api_instance.get_o_auth_application_with_http_info(oauth_application_id)
+  data, status_code, headers = Clerk::SDK.oauth_applications.get_oauth_application_with_http_info(oauth_application_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OAuthApplication>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->get_o_auth_application_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->get_oauth_application_with_http_info: #{e}"
 end
 ```
 
@@ -219,9 +218,9 @@ end
 - **Accept**: application/json
 
 
-## list_o_auth_applications
+## list_oauth_applications
 
-> <OAuthApplications> list_o_auth_applications(opts)
+> <OAuthApplications> list_oauth_applications(opts)
 
 Get a list of OAuth applications for an instance
 
@@ -231,14 +230,13 @@ This request returns the list of OAuth applications for an instance. Results can
 
 ```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::OAuthApplicationsApi.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`.
@@ -246,28 +244,28 @@ opts = {
 
 begin
   # Get a list of OAuth applications for an instance
-  result = api_instance.list_o_auth_applications(opts)
+  result = Clerk::SDK.oauth_applications.list_oauth_applications(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->list_o_auth_applications: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->list_oauth_applications: #{e}"
 end
 ```
 
-#### Using the list_o_auth_applications_with_http_info variant
+#### Using the `list_oauth_applications_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<OAuthApplications>, Integer, Hash)> list_o_auth_applications_with_http_info(opts)
+> <Array(<OAuthApplications>, Integer, Hash)> list_oauth_applications_with_http_info(opts)
 
 ```ruby
 begin
   # Get a list of OAuth applications for an instance
-  data, status_code, headers = api_instance.list_o_auth_applications_with_http_info(opts)
+  data, status_code, headers = Clerk::SDK.oauth_applications.list_oauth_applications_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OAuthApplications>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->list_o_auth_applications_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->list_oauth_applications_with_http_info: #{e}"
 end
 ```
 
@@ -292,9 +290,9 @@ end
 - **Accept**: application/json
 
 
-## rotate_o_auth_application_secret
+## rotate_oauth_application_secret
 
-> <OAuthApplicationWithSecret> rotate_o_auth_application_secret(oauth_application_id)
+> <OAuthApplicationWithSecret> rotate_oauth_application_secret(oauth_application_id)
 
 Rotate the client secret of the given OAuth application
 
@@ -304,40 +302,39 @@ Rotates the OAuth application's client secret. When the client secret is rotated
 
 ```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::OAuthApplicationsApi.new
 oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application for which to rotate the client secret
 
 begin
   # Rotate the client secret of the given OAuth application
-  result = api_instance.rotate_o_auth_application_secret(oauth_application_id)
+  result = Clerk::SDK.oauth_applications.rotate_oauth_application_secret(oauth_application_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->rotate_o_auth_application_secret: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->rotate_oauth_application_secret: #{e}"
 end
 ```
 
-#### Using the rotate_o_auth_application_secret_with_http_info variant
+#### Using the `rotate_oauth_application_secret_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<OAuthApplicationWithSecret>, Integer, Hash)> rotate_o_auth_application_secret_with_http_info(oauth_application_id)
+> <Array(<OAuthApplicationWithSecret>, Integer, Hash)> rotate_oauth_application_secret_with_http_info(oauth_application_id)
 
 ```ruby
 begin
   # Rotate the client secret of the given OAuth application
-  data, status_code, headers = api_instance.rotate_o_auth_application_secret_with_http_info(oauth_application_id)
+  data, status_code, headers = Clerk::SDK.oauth_applications.rotate_oauth_application_secret_with_http_info(oauth_application_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OAuthApplicationWithSecret>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->rotate_o_auth_application_secret_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->rotate_oauth_application_secret_with_http_info: #{e}"
 end
 ```
 
@@ -361,9 +358,9 @@ end
 - **Accept**: application/json
 
 
-## update_o_auth_application
+## update_oauth_application
 
-> <OAuthApplication> update_o_auth_application(oauth_application_id, update_o_auth_application_request)
+> <OAuthApplication> update_oauth_application(oauth_application_id, update_oauth_application_request)
 
 Update an OAuth application
 
@@ -373,41 +370,40 @@ Updates an existing OAuth application
 
 ```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::OAuthApplicationsApi.new
 oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application to update
-update_o_auth_application_request = ClerkHttpClient::UpdateOAuthApplicationRequest.new # UpdateOAuthApplicationRequest | 
+update_oauth_application_request = ClerkHttpClient::UpdateOAuthApplicationRequest.new # UpdateOAuthApplicationRequest | 
 
 begin
   # Update an OAuth application
-  result = api_instance.update_o_auth_application(oauth_application_id, update_o_auth_application_request)
+  result = Clerk::SDK.oauth_applications.update_oauth_application(oauth_application_id, update_oauth_application_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->update_o_auth_application: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->update_oauth_application: #{e}"
 end
 ```
 
-#### Using the update_o_auth_application_with_http_info variant
+#### Using the `update_oauth_application_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<OAuthApplication>, Integer, Hash)> update_o_auth_application_with_http_info(oauth_application_id, update_o_auth_application_request)
+> <Array(<OAuthApplication>, Integer, Hash)> update_oauth_application_with_http_info(oauth_application_id, update_oauth_application_request)
 
 ```ruby
 begin
   # Update an OAuth application
-  data, status_code, headers = api_instance.update_o_auth_application_with_http_info(oauth_application_id, update_o_auth_application_request)
+  data, status_code, headers = Clerk::SDK.oauth_applications.update_oauth_application_with_http_info(oauth_application_id, update_oauth_application_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OAuthApplication>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OAuthApplicationsApi->update_o_auth_application_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.oauth_applications->update_oauth_application_with_http_info: #{e}"
 end
 ```
 
@@ -416,7 +412,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **oauth_application_id** | **String** | The ID of the OAuth application to update |  |
-| **update_o_auth_application_request** | [**UpdateOAuthApplicationRequest**](UpdateOAuthApplicationRequest.md) |  |  |
+| **update_oauth_application_request** | [**UpdateOAuthApplicationRequest**](UpdateOAuthApplicationRequest.md) |  |  |
 
 ### Return type
 

data/docs/Organization.md

@@ -11,8 +11,8 @@
 | **members_count** | **Integer** |  | [optional] |
 | **max_allowed_memberships** | **Integer** |  |  |
 | **admin_delete_enabled** | **Boolean** |  | [optional] |
-| **public_metadata** | **Object** |  |  |
-| **private_metadata** | **Object** |  |  |
+| **public_metadata** | **Hash<String, Object>** |  |  |
+| **private_metadata** | **Hash<String, Object>** |  |  |
 | **created_by** | **String** |  | [optional] |
 | **created_at** | **Integer** | Unix timestamp of creation.  |  |
 | **updated_at** | **Integer** | Unix timestamp of last update.  |  |

data/docs/OrganizationDomainApi.md

@@ -4,10 +4,10 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**update_organization_domain**](OrganizationDomainApi.md#update_organization_domain) | **PATCH** /organizations/{organization_id}/domains/{domain_id} | Update an organization domain. |
+| [**update**](OrganizationDomainApi.md#update) | **PATCH** /organizations/{organization_id}/domains/{domain_id} | Update an organization domain. |
 
 
-## update_organization_domain
+## update
 
 > <OrganizationDomain> update_organization_domain(organization_id, domain_id, update_organization_domain_request)
 
@@ -17,30 +17,32 @@ Updates the properties of an existing organization 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'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
 end
 
-api_instance = ClerkHttpClient::OrganizationDomainApi.new
+sdk = ClerkHttpClient::OrganizationDomainApi.new
 organization_id = 'organization_id_example' # String | The ID of the organization the domain belongs to
 domain_id = 'domain_id_example' # String | The ID of the domain
 update_organization_domain_request = ClerkHttpClient::UpdateOrganizationDomainRequest.new # UpdateOrganizationDomainRequest | 
 
 begin
   # Update an organization domain.
-  result = api_instance.update_organization_domain(organization_id, domain_id, update_organization_domain_request)
+  result = sdk.update(organization_id, domain_id, update_organization_domain_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationDomainApi->update_organization_domain: #{e}"
+  puts "Error when calling OrganizationDomainApi->update: #{e}"
 end
 ```
 
-#### Using the update_organization_domain_with_http_info variant
+#### Using the `update_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -49,12 +51,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Update an organization domain.
-  data, status_code, headers = api_instance.update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)
+  data, status_code, headers = sdk.update_with_http_info(organization_id, domain_id, update_organization_domain_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <OrganizationDomain>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling OrganizationDomainApi->update_organization_domain_with_http_info: #{e}"
+  puts "Error when calling OrganizationDomainApi->update_with_http_info: #{e}"
 end
 ```