clerk-http-client 0.0.1

data/docs/SAMLConnectionsApi.md

@@ -0,0 +1,363 @@
+# ClerkHttpClient::SAMLConnectionsApi
+
+All URIs are relative to *https://api.clerk.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_saml_connection**](SAMLConnectionsApi.md#create_saml_connection) | **POST** /saml_connections | Create a SAML Connection |
+| [**delete_saml_connection**](SAMLConnectionsApi.md#delete_saml_connection) | **DELETE** /saml_connections/{saml_connection_id} | Delete a SAML Connection |
+| [**get_saml_connection**](SAMLConnectionsApi.md#get_saml_connection) | **GET** /saml_connections/{saml_connection_id} | Retrieve a SAML Connection by ID |
+| [**list_saml_connections**](SAMLConnectionsApi.md#list_saml_connections) | **GET** /saml_connections | Get a list of SAML Connections for an instance |
+| [**update_saml_connection**](SAMLConnectionsApi.md#update_saml_connection) | **PATCH** /saml_connections/{saml_connection_id} | Update a SAML Connection |
+
+
+## create_saml_connection
+
+> <SchemasSAMLConnection> create_saml_connection(create_saml_connection_request)
+
+Create a SAML Connection
+
+Create a new SAML Connection.
+
+### 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::SAMLConnectionsApi.new
+create_saml_connection_request = ClerkHttpClient::CreateSAMLConnectionRequest.new({name: 'name_example', domain: 'domain_example', provider: 'saml_custom'}) # CreateSAMLConnectionRequest | 
+
+begin
+  # Create a SAML Connection
+  result = api_instance.create_saml_connection(create_saml_connection_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->create_saml_connection: #{e}"
+end
+```
+
+#### Using the create_saml_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SchemasSAMLConnection>, Integer, Hash)> create_saml_connection_with_http_info(create_saml_connection_request)
+
+```ruby
+begin
+  # Create a SAML Connection
+  data, status_code, headers = api_instance.create_saml_connection_with_http_info(create_saml_connection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SchemasSAMLConnection>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->create_saml_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_saml_connection_request** | [**CreateSAMLConnectionRequest**](CreateSAMLConnectionRequest.md) |  |  |
+
+### Return type
+
+[**SchemasSAMLConnection**](SchemasSAMLConnection.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_saml_connection
+
+> <DeletedObject> delete_saml_connection(saml_connection_id)
+
+Delete a SAML Connection
+
+Deletes the SAML Connection 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::SAMLConnectionsApi.new
+saml_connection_id = 'saml_connection_id_example' # String | The ID of the SAML Connection to delete
+
+begin
+  # Delete a SAML Connection
+  result = api_instance.delete_saml_connection(saml_connection_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->delete_saml_connection: #{e}"
+end
+```
+
+#### Using the delete_saml_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DeletedObject>, Integer, Hash)> delete_saml_connection_with_http_info(saml_connection_id)
+
+```ruby
+begin
+  # Delete a SAML Connection
+  data, status_code, headers = api_instance.delete_saml_connection_with_http_info(saml_connection_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DeletedObject>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->delete_saml_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **saml_connection_id** | **String** | The ID of the SAML Connection to delete |  |
+
+### Return type
+
+[**DeletedObject**](DeletedObject.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_saml_connection
+
+> <SchemasSAMLConnection> get_saml_connection(saml_connection_id)
+
+Retrieve a SAML Connection by ID
+
+Fetches the SAML Connection whose ID matches the provided `saml_connection_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::SAMLConnectionsApi.new
+saml_connection_id = 'saml_connection_id_example' # String | The ID of the SAML Connection
+
+begin
+  # Retrieve a SAML Connection by ID
+  result = api_instance.get_saml_connection(saml_connection_id)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->get_saml_connection: #{e}"
+end
+```
+
+#### Using the get_saml_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SchemasSAMLConnection>, Integer, Hash)> get_saml_connection_with_http_info(saml_connection_id)
+
+```ruby
+begin
+  # Retrieve a SAML Connection by ID
+  data, status_code, headers = api_instance.get_saml_connection_with_http_info(saml_connection_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SchemasSAMLConnection>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->get_saml_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **saml_connection_id** | **String** | The ID of the SAML Connection |  |
+
+### Return type
+
+[**SchemasSAMLConnection**](SchemasSAMLConnection.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_saml_connections
+
+> <SAMLConnections> list_saml_connections(opts)
+
+Get a list of SAML Connections for an instance
+
+Returns the list of SAML Connections for an instance. Results can be paginated using the optional `limit` and `offset` query parameters. The SAML Connections are ordered by descending creation date and the most recent 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::SAMLConnectionsApi.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 SAML Connections for an instance
+  result = api_instance.list_saml_connections(opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->list_saml_connections: #{e}"
+end
+```
+
+#### Using the list_saml_connections_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SAMLConnections>, Integer, Hash)> list_saml_connections_with_http_info(opts)
+
+```ruby
+begin
+  # Get a list of SAML Connections for an instance
+  data, status_code, headers = api_instance.list_saml_connections_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SAMLConnections>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->list_saml_connections_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
+
+[**SAMLConnections**](SAMLConnections.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_saml_connection
+
+> <SchemasSAMLConnection> update_saml_connection(saml_connection_id, update_saml_connection_request)
+
+Update a SAML Connection
+
+Updates the SAML Connection 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::SAMLConnectionsApi.new
+saml_connection_id = 'saml_connection_id_example' # String | The ID of the SAML Connection to update
+update_saml_connection_request = ClerkHttpClient::UpdateSAMLConnectionRequest.new # UpdateSAMLConnectionRequest | 
+
+begin
+  # Update a SAML Connection
+  result = api_instance.update_saml_connection(saml_connection_id, update_saml_connection_request)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->update_saml_connection: #{e}"
+end
+```
+
+#### Using the update_saml_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SchemasSAMLConnection>, Integer, Hash)> update_saml_connection_with_http_info(saml_connection_id, update_saml_connection_request)
+
+```ruby
+begin
+  # Update a SAML Connection
+  data, status_code, headers = api_instance.update_saml_connection_with_http_info(saml_connection_id, update_saml_connection_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SchemasSAMLConnection>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling SAMLConnectionsApi->update_saml_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **saml_connection_id** | **String** | The ID of the SAML Connection to update |  |
+| **update_saml_connection_request** | [**UpdateSAMLConnectionRequest**](UpdateSAMLConnectionRequest.md) |  |  |
+
+### Return type
+
+[**SchemasSAMLConnection**](SchemasSAMLConnection.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SchemasPasskey.md

@@ -0,0 +1,26 @@
+# ClerkHttpClient::SchemasPasskey
+
+## 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.  |  |
+| **name** | **String** |  |  |
+| **last_used_at** | **Integer** | Unix timestamp of when the passkey was last used.  |  |
+| **verification** | [**SchemasPasskeyVerification**](SchemasPasskeyVerification.md) |  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SchemasPasskey.new(
+  id: null,
+  object: null,
+  name: null,
+  last_used_at: null,
+  verification: null
+)
+```
+

data/docs/SchemasPasskeyVerification.md

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

data/docs/SchemasSAMLConnection.md

@@ -0,0 +1,60 @@
+# ClerkHttpClient::SchemasSAMLConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **domain** | **String** |  |  |
+| **idp_entity_id** | **String** |  |  |
+| **idp_sso_url** | **String** |  |  |
+| **idp_certificate** | **String** |  |  |
+| **idp_metadata_url** | **String** |  | [optional] |
+| **idp_metadata** | **String** |  | [optional] |
+| **acs_url** | **String** |  |  |
+| **sp_entity_id** | **String** |  |  |
+| **sp_metadata_url** | **String** |  |  |
+| **attribute_mapping** | [**SchemasSAMLConnectionAttributeMapping**](SchemasSAMLConnectionAttributeMapping.md) |  | [optional] |
+| **active** | **Boolean** |  |  |
+| **provider** | **String** |  |  |
+| **user_count** | **Integer** |  |  |
+| **sync_user_attributes** | **Boolean** |  |  |
+| **allow_subdomains** | **Boolean** |  | [optional] |
+| **allow_idp_initiated** | **Boolean** |  | [optional] |
+| **disable_additional_identifications** | **Boolean** |  | [optional] |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SchemasSAMLConnection.new(
+  object: null,
+  id: null,
+  name: null,
+  domain: null,
+  idp_entity_id: null,
+  idp_sso_url: null,
+  idp_certificate: null,
+  idp_metadata_url: null,
+  idp_metadata: null,
+  acs_url: null,
+  sp_entity_id: null,
+  sp_metadata_url: null,
+  attribute_mapping: null,
+  active: null,
+  provider: null,
+  user_count: null,
+  sync_user_attributes: null,
+  allow_subdomains: null,
+  allow_idp_initiated: null,
+  disable_additional_identifications: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/SchemasSAMLConnectionAttributeMapping.md

@@ -0,0 +1,24 @@
+# ClerkHttpClient::SchemasSAMLConnectionAttributeMapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** |  | [optional] |
+| **email_address** | **String** |  | [optional] |
+| **first_name** | **String** |  | [optional] |
+| **last_name** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SchemasSAMLConnectionAttributeMapping.new(
+  user_id: null,
+  email_address: null,
+  first_name: null,
+  last_name: null
+)
+```
+

data/docs/Session.md

@@ -0,0 +1,42 @@
+# ClerkHttpClient::Session
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | String representing the object's type. Objects of the same type share the same value.  |  |
+| **id** | **String** |  |  |
+| **user_id** | **String** |  |  |
+| **client_id** | **String** |  |  |
+| **actor** | **Object** |  | [optional] |
+| **status** | **String** |  |  |
+| **last_active_organization_id** | **String** |  | [optional] |
+| **last_active_at** | **Integer** |  |  |
+| **latest_activity** | [**SessionLatestActivity**](SessionLatestActivity.md) |  | [optional] |
+| **expire_at** | **Integer** |  |  |
+| **abandon_at** | **Integer** |  |  |
+| **updated_at** | **Integer** | Unix timestamp of last update.  |  |
+| **created_at** | **Integer** | Unix timestamp of creation.  |  |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::Session.new(
+  object: null,
+  id: null,
+  user_id: null,
+  client_id: null,
+  actor: null,
+  status: null,
+  last_active_organization_id: null,
+  last_active_at: null,
+  latest_activity: null,
+  expire_at: null,
+  abandon_at: null,
+  updated_at: null,
+  created_at: null
+)
+```
+

data/docs/SessionLatestActivity.md

@@ -0,0 +1,34 @@
+# ClerkHttpClient::SessionLatestActivity
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  |  |
+| **id** | **String** |  |  |
+| **device_type** | **String** |  | [optional] |
+| **is_mobile** | **Boolean** |  | [optional] |
+| **browser_name** | **String** |  | [optional] |
+| **browser_version** | **String** |  | [optional] |
+| **ip_address** | **String** |  | [optional] |
+| **city** | **String** |  | [optional] |
+| **country** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::SessionLatestActivity.new(
+  object: null,
+  id: null,
+  device_type: null,
+  is_mobile: null,
+  browser_name: null,
+  browser_version: null,
+  ip_address: null,
+  city: null,
+  country: null
+)
+```
+