clerk-http-client 0.0.1

data/docs/OAuthApplicationsApi.md

@@ -0,0 +1,433 @@
+# ClerkHttpClient::OAuthApplicationsApi
+
+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_o_auth_application
+
+> <OAuthApplicationWithSecret> create_o_auth_application(create_o_auth_application_request)
+
+Create an OAuth application
+
+Creates a new OAuth application with the given name and callback URL for an instance. The callback URL must be a valid url. All URL schemes are allowed such as `http://`, `https://`, `myapp://`, etc...
+
+### 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::OAuthApplicationsApi.new
+create_o_auth_application_request = ClerkHttpClient::CreateOAuthApplicationRequest.new({name: 'name_example', callback_url: 'callback_url_example'}) # CreateOAuthApplicationRequest | 
+
+begin
+  # Create an OAuth application
+  result = api_instance.create_o_auth_application(create_o_auth_application_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling OAuthApplicationsApi->create_o_auth_application: #{e}"
+end
+```
+
+#### Using the create_o_auth_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)
+
+```ruby
+begin
+  # Create an OAuth application
+  data, status_code, headers = api_instance.create_o_auth_application_with_http_info(create_o_auth_application_request)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_o_auth_application_request** | [**CreateOAuthApplicationRequest**](CreateOAuthApplicationRequest.md) |  |  |
+
+### Return type
+
+[**OAuthApplicationWithSecret**](OAuthApplicationWithSecret.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_o_auth_application
+
+> <DeletedObject> delete_o_auth_application(oauth_application_id)
+
+Delete an OAuth application
+
+Deletes the given OAuth application. This is not reversible.
+
+### 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::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)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling OAuthApplicationsApi->delete_o_auth_application: #{e}"
+end
+```
+
+#### Using the delete_o_auth_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)
+
+```ruby
+begin
+  # Delete an OAuth application
+  data, status_code, headers = api_instance.delete_o_auth_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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **oauth_application_id** | **String** | The ID of the OAuth application to delete |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_o_auth_application
+
+> <OAuthApplication> get_o_auth_application(oauth_application_id)
+
+Retrieve an OAuth application by ID
+
+Fetches the OAuth application whose ID matches the provided `id` in the path.
+
+### 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::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)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling OAuthApplicationsApi->get_o_auth_application: #{e}"
+end
+```
+
+#### Using the get_o_auth_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)
+
+```ruby
+begin
+  # Retrieve an OAuth application by ID
+  data, status_code, headers = api_instance.get_o_auth_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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **oauth_application_id** | **String** | The ID of the OAuth application |  |
+
+### Return type
+
+[**OAuthApplication**](OAuthApplication.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_o_auth_applications
+
+> <OAuthApplications> list_o_auth_applications(opts)
+
+Get a list of OAuth applications for an instance
+
+This request returns the list of OAuth applications for an instance. Results can be paginated using the optional `limit` and `offset` query parameters. The OAuth applications are ordered by descending creation date. Most recent OAuth applications will be returned first.
+
+### 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::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`.
+}
+
+begin
+  # Get a list of OAuth applications for an instance
+  result = api_instance.list_o_auth_applications(opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling OAuthApplicationsApi->list_o_auth_applications: #{e}"
+end
+```
+
+#### Using the list_o_auth_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)
+
+```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)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** | Applies a limit to the number of results returned. Can be used for paginating the results together with &#x60;offset&#x60;. | [optional][default to 10] |
+| **offset** | **Float** | Skip the first &#x60;offset&#x60; results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with &#x60;limit&#x60;. | [optional][default to 0] |
+
+### Return type
+
+[**OAuthApplications**](OAuthApplications.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## rotate_o_auth_application_secret
+
+> <OAuthApplicationWithSecret> rotate_o_auth_application_secret(oauth_application_id)
+
+Rotate the client secret of the given OAuth application
+
+Rotates the OAuth application's client secret. When the client secret is rotated, make sure to update it in authorized OAuth clients.
+
+### 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::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)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling OAuthApplicationsApi->rotate_o_auth_application_secret: #{e}"
+end
+```
+
+#### Using the rotate_o_auth_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)
+
+```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)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **oauth_application_id** | **String** | The ID of the OAuth application for which to rotate the client secret |  |
+
+### Return type
+
+[**OAuthApplicationWithSecret**](OAuthApplicationWithSecret.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_o_auth_application
+
+> <OAuthApplication> update_o_auth_application(oauth_application_id, update_o_auth_application_request)
+
+Update an OAuth application
+
+Updates an existing OAuth application
+
+### 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::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 | 
+
+begin
+  # Update an OAuth application
+  result = api_instance.update_o_auth_application(oauth_application_id, update_o_auth_application_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling OAuthApplicationsApi->update_o_auth_application: #{e}"
+end
+```
+
+#### Using the update_o_auth_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)
+
+```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)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **oauth_application_id** | **String** | The ID of the OAuth application to update |  |
+| **update_o_auth_application_request** | [**UpdateOAuthApplicationRequest**](UpdateOAuthApplicationRequest.md) |  |  |
+
+### Return type
+
+[**OAuthApplication**](OAuthApplication.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OTP.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::OTP
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **strategy** | **String** |  |  |
+| **attempts** | **Integer** |  |  |
+| **expire_at** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::OTP.new(
+  status: null,
+  strategy: null,
+  attempts: null,
+  expire_at: null
+)
+```
+

data/docs/Oauth.md

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

data/docs/OauthError.md

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

data/docs/Organization.md

@@ -0,0 +1,40 @@
+# ClerkHttpClient::Organization
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **slug** | **String** |  |  |
+| **members_count** | **Integer** |  | [optional] |
+| **max_allowed_memberships** | **Integer** |  |  |
+| **admin_delete_enabled** | **Boolean** |  | [optional] |
+| **public_metadata** | **Object** |  |  |
+| **private_metadata** | **Object** |  |  |
+| **created_by** | **String** |  | [optional] |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::Organization.new(
+  object: null,
+  id: null,
+  name: null,
+  slug: null,
+  members_count: null,
+  max_allowed_memberships: null,
+  admin_delete_enabled: null,
+  public_metadata: null,
+  private_metadata: null,
+  created_by: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/OrganizationDomain.md

@@ -0,0 +1,38 @@
+# ClerkHttpClient::OrganizationDomain
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the organization domain | [optional] |
+| **object** | **String** | String representing the object's type. Objects of the same type share the same value. Always `organization_domain`  | [optional] |
+| **organization_id** | **String** | Unique identifier for the organization | [optional] |
+| **name** | **String** | Name of the organization domain | [optional] |
+| **enrollment_mode** | **String** | Mode of enrollment for the domain | [optional] |
+| **affiliation_email_address** | **String** | Affiliation email address for the domain, if available. | [optional] |
+| **verification** | [**OrganizationDomainVerification**](OrganizationDomainVerification.md) | Verification details for the domain | [optional] |
+| **total_pending_invitations** | **Integer** | Total number of pending invitations associated with this domain | [optional] |
+| **total_pending_suggestions** | **Integer** | Total number of pending suggestions associated with this domain | [optional] |
+| **created_at** | **Integer** | Unix timestamp when the domain was created | [optional] |
+| **updated_at** | **Integer** | Unix timestamp of the last update to the domain | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::OrganizationDomain.new(
+  id: null,
+  object: null,
+  organization_id: null,
+  name: null,
+  enrollment_mode: null,
+  affiliation_email_address: null,
+  verification: null,
+  total_pending_invitations: null,
+  total_pending_suggestions: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/OrganizationDomainApi.md

@@ -0,0 +1,81 @@
+# ClerkHttpClient::OrganizationDomainApi
+
+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_organization_domain
+
+> <OrganizationDomain> update_organization_domain(organization_id, domain_id, update_organization_domain_request)
+
+Update an organization domain.
+
+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'
+end
+
+api_instance = 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)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling OrganizationDomainApi->update_organization_domain: #{e}"
+end
+```
+
+#### Using the update_organization_domain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrganizationDomain>, Integer, Hash)> update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)
+
+```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)
+  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}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **organization_id** | **String** | The ID of the organization the domain belongs to |  |
+| **domain_id** | **String** | The ID of the domain |  |
+| **update_organization_domain_request** | [**UpdateOrganizationDomainRequest**](UpdateOrganizationDomainRequest.md) |  |  |
+
+### Return type
+
+[**OrganizationDomain**](OrganizationDomain.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+