clerk-http-client 0.0.1 → 2.0.0.beta1

data/docs/TestingTokensApi.md

@@ -13,31 +13,30 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 Retrieve a new testing token
 
-Retrieve a new testing token. Only available for development instances.
+Retrieve a new testing token.
 
 ### 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::TestingTokensApi.new
 
 begin
   # Retrieve a new testing token
-  result = api_instance.create_testing_token
+  result = Clerk::SDK.testing_tokens.create_testing_token
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling TestingTokensApi->create_testing_token: #{e}"
+  puts "Error when calling Clerk::SDK.testing_tokens->create_testing_token: #{e}"
 end
 ```
 
-#### Using the create_testing_token_with_http_info variant
+#### Using the `create_testing_token_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -46,12 +45,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Retrieve a new testing token
-  data, status_code, headers = api_instance.create_testing_token_with_http_info
+  data, status_code, headers = Clerk::SDK.testing_tokens.create_testing_token_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <TestingToken>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling TestingTokensApi->create_testing_token_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.testing_tokens->create_testing_token_with_http_info: #{e}"
 end
 ```
 

data/docs/UpdateOrganizationMembershipMetadataRequest.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **public_metadata** | **Object** | Metadata saved on the organization membership, that is visible to both your frontend and backend. The new object will be merged with the existing value. | [optional] |
-| **private_metadata** | **Object** | Metadata saved on the organization membership that is only visible to your backend. The new object will be merged with the existing value. | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the organization membership, that is visible to both your frontend and backend. The new object will be merged with the existing value. | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the organization membership that is only visible to your backend. The new object will be merged with the existing value. | [optional] |
 
 ## Example
 

data/docs/UpdateOrganizationRequest.md

@@ -4,8 +4,8 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **public_metadata** | **Object** | Metadata saved on the organization, that is visible to both your frontend and backend. | [optional] |
-| **private_metadata** | **Object** | Metadata saved on the organization that is only visible to your backend. | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the organization, that is visible to both your frontend and backend. | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the organization that is only visible to your backend. | [optional] |
 | **name** | **String** | The new name of the organization. May not contain URLs or HTML. | [optional] |
 | **slug** | **String** | The new slug of the organization, which needs to be unique in the instance | [optional] |
 | **max_allowed_memberships** | **Integer** | The maximum number of memberships allowed for this organization | [optional] |

data/docs/UpdateSAMLConnectionRequest.md

@@ -11,6 +11,7 @@
 | **idp_certificate** | **String** | The x509 certificated as provided by the IdP | [optional] |
 | **idp_metadata_url** | **String** | The URL which serves the IdP metadata. If present, it takes priority over the corresponding individual properties and replaces them | [optional] |
 | **idp_metadata** | **String** | The XML content of the IdP metadata file. If present, it takes priority over the corresponding individual properties | [optional] |
+| **organization_id** | **String** | The ID of the organization to which users of this SAML Connection will be added | [optional] |
 | **attribute_mapping** | [**UpdateSAMLConnectionRequestAttributeMapping**](UpdateSAMLConnectionRequestAttributeMapping.md) |  | [optional] |
 | **active** | **Boolean** | Activate or de-activate the SAML Connection | [optional] |
 | **sync_user_attributes** | **Boolean** | Controls whether to update the user's attributes in each sign-in | [optional] |
@@ -31,6 +32,7 @@ instance = ClerkHttpClient::UpdateSAMLConnectionRequest.new(
   idp_certificate: null,
   idp_metadata_url: null,
   idp_metadata: null,
+  organization_id: null,
   attribute_mapping: null,
   active: null,
   sync_user_attributes: null,

data/docs/UpdateUserRequest.md

@@ -20,9 +20,9 @@
 | **sign_out_of_other_sessions** | **Boolean** | Set to `true` to sign out the user from all their active sessions once their password is updated. This parameter can only be used when providing a `password`. | [optional] |
 | **totp_secret** | **String** | In case TOTP is configured on the instance, you can provide the secret to enable it on the specific user without the need to reset it. Please note that currently the supported options are: * Period: 30 seconds * Code length: 6 digits * Algorithm: SHA1 | [optional] |
 | **backup_codes** | **Array<String>** | If Backup Codes are configured on the instance, you can provide them to enable it on the specific user without the need to reset them. You must provide the backup codes in plain format or the corresponding bcrypt digest. | [optional] |
-| **public_metadata** | **Object** | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | [optional] |
-| **private_metadata** | **Object** | Metadata saved on the user, that is only visible to your Backend API | [optional] |
-| **unsafe_metadata** | **Object** | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the user, that is visible to both your Frontend and Backend APIs | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the user, that is only visible to your Backend API | [optional] |
+| **unsafe_metadata** | **Hash<String, Object>** | Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. | [optional] |
 | **delete_self_enabled** | **Boolean** | If true, the user can delete themselves with the Frontend API. | [optional] |
 | **create_organization_enabled** | **Boolean** | If true, the user can create organizations with the Frontend API. | [optional] |
 | **legal_accepted_at** | **String** | A custom timestamps denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | [optional] |

data/docs/User.md

@@ -16,9 +16,9 @@
 | **profile_image_url** | **String** |  | [optional] |
 | **image_url** | **String** |  | [optional] |
 | **has_image** | **Boolean** |  | [optional] |
-| **public_metadata** | **Object** |  | [optional] |
-| **private_metadata** | **Object** |  | [optional] |
-| **unsafe_metadata** | **Object** |  | [optional] |
+| **public_metadata** | **Hash<String, Object>** |  | [optional] |
+| **private_metadata** | **Hash<String, Object>** |  | [optional] |
+| **unsafe_metadata** | **Hash<String, Object>** |  | [optional] |
 | **email_addresses** | [**Array<EmailAddress>**](EmailAddress.md) |  | [optional] |
 | **phone_numbers** | [**Array<PhoneNumber>**](PhoneNumber.md) |  | [optional] |
 | **web3_wallets** | [**Array<Web3Wallet>**](Web3Wallet.md) |  | [optional] |