clerk-http-client 1.0.0 → 2.0.0.beta2

data/docs/ClientsApi.md

@@ -21,26 +21,25 @@ Returns the details of a client.
 
 ```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::ClientsApi.new
 client_id = 'client_id_example' # String | Client ID.
 
 begin
   # Get a client
-  result = api_instance.get_client(client_id)
+  result = Clerk::SDK.clients.get_client(client_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling ClientsApi->get_client: #{e}"
+  puts "Error when calling Clerk::SDK.clients->get_client: #{e}"
 end
 ```
 
-#### Using the get_client_with_http_info variant
+#### Using the `get_client_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -49,12 +48,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Get a client
-  data, status_code, headers = api_instance.get_client_with_http_info(client_id)
+  data, status_code, headers = Clerk::SDK.clients.get_client_with_http_info(client_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Client>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling ClientsApi->get_client_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.clients->get_client_with_http_info: #{e}"
 end
 ```
 
@@ -90,14 +89,13 @@ Returns a list of all clients. The clients are returned sorted by creation date,
 
 ```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::ClientsApi.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`.
@@ -105,14 +103,14 @@ opts = {
 
 begin
   # List all clients
-  result = api_instance.get_client_list(opts)
+  result = Clerk::SDK.clients.get_client_list(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling ClientsApi->get_client_list: #{e}"
+  puts "Error when calling Clerk::SDK.clients->get_client_list: #{e}"
 end
 ```
 
-#### Using the get_client_list_with_http_info variant
+#### Using the `get_client_list_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -121,12 +119,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # List all clients
-  data, status_code, headers = api_instance.get_client_list_with_http_info(opts)
+  data, status_code, headers = Clerk::SDK.clients.get_client_list_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<Client>>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling ClientsApi->get_client_list_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.clients->get_client_list_with_http_info: #{e}"
 end
 ```
 
@@ -153,7 +151,7 @@ end
 
 ## verify_client
 
-> <Client> verify_client(verify_client_request)
+> <Client> verify_client(opts)
 
 Verify a client
 
@@ -163,40 +161,41 @@ Verifies the client in the provided token
 
 ```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::ClientsApi.new
-verify_client_request = ClerkHttpClient::VerifyClientRequest.new # VerifyClientRequest | 
+opts = {
+  verify_client_request: ClerkHttpClient::VerifyClientRequest.new # VerifyClientRequest | Parameters.
+}
 
 begin
   # Verify a client
-  result = api_instance.verify_client(verify_client_request)
+  result = Clerk::SDK.clients.verify_client(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling ClientsApi->verify_client: #{e}"
+  puts "Error when calling Clerk::SDK.clients->verify_client: #{e}"
 end
 ```
 
-#### Using the verify_client_with_http_info variant
+#### Using the `verify_client_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Client>, Integer, Hash)> verify_client_with_http_info(verify_client_request)
+> <Array(<Client>, Integer, Hash)> verify_client_with_http_info(opts)
 
 ```ruby
 begin
   # Verify a client
-  data, status_code, headers = api_instance.verify_client_with_http_info(verify_client_request)
+  data, status_code, headers = Clerk::SDK.clients.verify_client_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Client>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling ClientsApi->verify_client_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.clients->verify_client_with_http_info: #{e}"
 end
 ```
 
@@ -204,7 +203,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **verify_client_request** | [**VerifyClientRequest**](VerifyClientRequest.md) |  |  |
+| **verify_client_request** | [**VerifyClientRequest**](VerifyClientRequest.md) | Parameters. | [optional] |
 
 ### Return type
 

data/docs/CreateBulkInvitationsRequestInner.md

@@ -0,0 +1,28 @@
+# ClerkHttpClient::CreateBulkInvitationsRequestInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The email address the invitation will be sent to |  |
+| **public_metadata** | **Hash<String, Object>** | Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. | [optional] |
+| **redirect_url** | **String** | The URL where the user is redirected upon visiting the invitation link, where they can accept the invitation. Required if you have implemented a [custom flow for handling application invitations](/docs/custom-flows/invitations). | [optional] |
+| **notify** | **Boolean** | Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true. | [optional][default to true] |
+| **ignore_existing** | **Boolean** | Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user. | [optional][default to false] |
+| **expires_in_days** | **Integer** | The number of days the invitation will be valid for. By default, the invitation expires after 30 days. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateBulkInvitationsRequestInner.new(
+  email_address: null,
+  public_metadata: null,
+  redirect_url: null,
+  notify: null,
+  ignore_existing: null,
+  expires_in_days: null
+)
+```
+

data/docs/CreateInvitationRequest.md

@@ -5,11 +5,12 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **email_address** | **String** | The email address the invitation will be sent to |  |
-| **public_metadata** | **Object** | Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata that will be attached to the newly created invitation. The value of this property should be a well-formed JSON object. Once the user accepts the invitation and signs up, these metadata will end up in the user's public metadata. | [optional] |
 | **redirect_url** | **String** | Optional URL which specifies where to redirect the user once they click the invitation link. This is only required if you have implemented a [custom flow](https://clerk.com/docs/authentication/invitations#custom-flow) and you're not using Clerk Hosted Pages or Clerk Components. | [optional] |
-| **notify** | **Boolean** | Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to true. | [optional][default to true] |
+| **notify** | **Boolean** | Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to `true`. | [optional][default to true] |
 | **ignore_existing** | **Boolean** | Whether an invitation should be created if there is already an existing invitation for this email address, or it's claimed by another user. | [optional][default to false] |
-| **expires_in_days** | **Integer** | The number of days the invitation will be valid for. By default, the invitation does not expire. | [optional] |
+| **expires_in_days** | **Integer** | The number of days the invitation will be valid for. By default, the invitation expires after 30 days. | [optional] |
+| **template_slug** | **String** | The slug of the email template to use for the invitation email. If not provided, the \"invitation\" template will be used. | [optional] |
 
 ## Example
 
@@ -22,7 +23,8 @@ instance = ClerkHttpClient::CreateInvitationRequest.new(
   redirect_url: null,
   notify: null,
   ignore_existing: null,
-  expires_in_days: null
+  expires_in_days: null,
+  template_slug: null
 )
 ```
 

data/docs/{CreateOAuthApplicationRequest.md → CreateOauthApplicationRequest.md}

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the new OAuth application |  |
-| **callback_url** | **String** | The callback URL of the new OAuth application |  |
+| **callback_url** | **String** | The callback URL of the new OAuth application | [optional] |
 | **scopes** | **String** | Define the allowed scopes for the new OAuth applications that dictate the user payload of the OAuth user info endpoint. Available scopes are `profile`, `email`, `public_metadata`, `private_metadata`. Provide the requested scopes as a string, separated by spaces. | [optional][default to 'profile email'] |
 | **public** | **Boolean** | If true, this client is public and cannot securely store a client secret. Only the authorization code flow with proof key for code exchange (PKCE) may be used. Public clients cannot be updated to be confidential clients, and vice versa. | [optional] |
 

data/docs/CreateOrganizationInvitationBulkRequestInner.md

@@ -7,8 +7,8 @@
 | **email_address** | **String** | The email address of the new member that is going to be invited to the organization |  |
 | **inviter_user_id** | **String** | The ID of the user that invites the new member to the organization. Must be an administrator in the organization. | [optional] |
 | **role** | **String** | The role of the new member in the organization. |  |
-| **public_metadata** | **Object** | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | [optional] |
-| **private_metadata** | **Object** | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership. | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership. | [optional] |
 | **redirect_url** | **String** | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | [optional] |
 
 ## Example

data/docs/CreateOrganizationInvitationRequest.md

@@ -7,9 +7,10 @@
 | **email_address** | **String** | The email address of the new member that is going to be invited to the organization |  |
 | **inviter_user_id** | **String** | The ID of the user that invites the new member to the organization. Must be an administrator in the organization. | [optional] |
 | **role** | **String** | The role of the new member in the organization |  |
-| **public_metadata** | **Object** | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. | [optional] |
-| **private_metadata** | **Object** | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the organization invitation, read-only from the Frontend API and fully accessible (read/write) from the Backend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership. | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the organization invitation, fully accessible (read/write) from the Backend API but not visible from the Frontend API. When the organization invitation is accepted, the metadata will be transferred to the newly created organization membership. | [optional] |
 | **redirect_url** | **String** | Optional URL that the invitee will be redirected to once they accept the invitation by clicking the join link in the invitation email. | [optional] |
+| **expires_in_days** | **Integer** | The number of days the invitation will be valid for. By default, the invitation has a 30 days expire. | [optional] |
 
 ## Example
 
@@ -22,7 +23,8 @@ instance = ClerkHttpClient::CreateOrganizationInvitationRequest.new(
   role: null,
   public_metadata: null,
   private_metadata: null,
-  redirect_url: null
+  redirect_url: null,
+  expires_in_days: null
 )
 ```
 

data/docs/CreateOrganizationRequest.md

@@ -5,9 +5,9 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | The name of the new organization. May not contain URLs or HTML. |  |
-| **created_by** | **String** | The ID of the User who will become the administrator for the new organization |  |
-| **private_metadata** | **Object** | Metadata saved on the organization, accessible only from the Backend API | [optional] |
-| **public_metadata** | **Object** | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API | [optional] |
+| **created_by** | **String** | The ID of the User who will become the administrator for the new organization | [optional] |
+| **private_metadata** | **Hash<String, Object>** | Metadata saved on the organization, accessible only from the Backend API | [optional] |
+| **public_metadata** | **Hash<String, Object>** | Metadata saved on the organization, read-only from the Frontend API and fully accessible (read/write) from the Backend API | [optional] |
 | **slug** | **String** | A slug for the new organization. Can contain only lowercase alphanumeric characters and the dash \"-\". Must be unique for the instance. | [optional] |
 | **max_allowed_memberships** | **Integer** | The maximum number of memberships allowed for this organization | [optional] |
 | **created_at** | **String** | A custom date/time denoting _when_ the organization was created, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | [optional] |

data/docs/CreateSAMLConnectionRequest.md

@@ -12,6 +12,7 @@
 | **idp_certificate** | **String** | The X.509 certificate 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 | [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** | [**CreateSAMLConnectionRequestAttributeMapping**](CreateSAMLConnectionRequestAttributeMapping.md) |  | [optional] |
 
 ## Example
@@ -28,6 +29,7 @@ instance = ClerkHttpClient::CreateSAMLConnectionRequest.new(
   idp_certificate: null,
   idp_metadata_url: null,
   idp_metadata: null,
+  organization_id: null,
   attribute_mapping: null
 )
 ```

data/docs/CreateSessionRequest.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::CreateSessionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The ID representing the user | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSessionRequest.new(
+  user_id: null
+)
+```
+

data/docs/CreateSessionToken200Response.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::CreateSessionToken200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** |  | [optional] |
+| **jwt** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSessionToken200Response.new(
+  object: null,
+  jwt: null
+)
+```
+

data/docs/CreateSessionTokenFromTemplateRequest.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::CreateSessionTokenFromTemplateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_in_seconds** | **Float** | Use this parameter to override the JWT token lifetime. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSessionTokenFromTemplateRequest.new(
+  expires_in_seconds: null
+)
+```
+

data/docs/CreateSessionTokenRequest.md

@@ -0,0 +1,18 @@
+# ClerkHttpClient::CreateSessionTokenRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_in_seconds** | **Float** | Use this parameter to override the default session token lifetime. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateSessionTokenRequest.new(
+  expires_in_seconds: null
+)
+```
+

data/docs/CreateUserRequest.md

@@ -18,9 +18,9 @@
 | **skip_password_requirement** | **Boolean** | When set to `true`, `password` is not required anymore when creating the user and can be omitted. This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. Please note that you cannot use this flag if password is the only way for a user to sign into your instance. | [optional] |
 | **totp_secret** | **String** | In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created 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 newly created 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 enabled, user can delete themselves via FAPI.  | [optional] |
 | **legal_accepted_at** | **String** | A custom timestamp denoting _when_ the user accepted legal requirements, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). | [optional] |
 | **skip_legal_checks** | **Boolean** | When set to `true` all legal checks are skipped. It is not recommended to skip legal checks unless you are migrating a user to Clerk. | [optional] |

data/docs/CreateWaitlistEntryRequest.md

@@ -0,0 +1,20 @@
+# ClerkHttpClient::CreateWaitlistEntryRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_address** | **String** | The email address to add to the waitlist |  |
+| **notify** | **Boolean** | Optional flag which denotes whether an email invitation should be sent to the given email address. Defaults to `true`. | [optional] |
+
+## Example
+
+```ruby
+require 'clerk-http-client'
+
+instance = ClerkHttpClient::CreateWaitlistEntryRequest.new(
+  email_address: null,
+  notify: null
+)
+```
+

data/docs/DomainsApi.md

@@ -12,7 +12,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## add_domain
 
-> <Domain> add_domain(add_domain_request)
+> <Domain> add_domain(opts)
 
 Add a domain
 
@@ -22,40 +22,41 @@ Add a new domain for your instance. Useful in the case of multi-domain instances
 
 ```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::DomainsApi.new
-add_domain_request = ClerkHttpClient::AddDomainRequest.new({name: 'name_example', is_satellite: false}) # AddDomainRequest | 
+opts = {
+  add_domain_request: ClerkHttpClient::AddDomainRequest.new({name: 'name_example', is_satellite: false}) # AddDomainRequest | 
+}
 
 begin
   # Add a domain
-  result = api_instance.add_domain(add_domain_request)
+  result = Clerk::SDK.domains.add_domain(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->add_domain: #{e}"
+  puts "Error when calling Clerk::SDK.domains->add_domain: #{e}"
 end
 ```
 
-#### Using the add_domain_with_http_info variant
+#### Using the `add_domain_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Domain>, Integer, Hash)> add_domain_with_http_info(add_domain_request)
+> <Array(<Domain>, Integer, Hash)> add_domain_with_http_info(opts)
 
 ```ruby
 begin
   # Add a domain
-  data, status_code, headers = api_instance.add_domain_with_http_info(add_domain_request)
+  data, status_code, headers = Clerk::SDK.domains.add_domain_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Domain>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->add_domain_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.domains->add_domain_with_http_info: #{e}"
 end
 ```
 
@@ -63,7 +64,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **add_domain_request** | [**AddDomainRequest**](AddDomainRequest.md) |  |  |
+| **add_domain_request** | [**AddDomainRequest**](AddDomainRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -91,26 +92,25 @@ Deletes a satellite domain for the instance. It is currently not possible to del
 
 ```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::DomainsApi.new
 domain_id = 'domain_id_example' # String | The ID of the domain that will be deleted. Must be a satellite domain.
 
 begin
   # Delete a satellite domain
-  result = api_instance.delete_domain(domain_id)
+  result = Clerk::SDK.domains.delete_domain(domain_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->delete_domain: #{e}"
+  puts "Error when calling Clerk::SDK.domains->delete_domain: #{e}"
 end
 ```
 
-#### Using the delete_domain_with_http_info variant
+#### Using the `delete_domain_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 satellite domain
-  data, status_code, headers = api_instance.delete_domain_with_http_info(domain_id)
+  data, status_code, headers = Clerk::SDK.domains.delete_domain_with_http_info(domain_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <DeletedObject>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->delete_domain_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.domains->delete_domain_with_http_info: #{e}"
 end
 ```
 
@@ -160,25 +160,24 @@ Use this endpoint to get a list of all domains for an instance. The response wil
 
 ```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::DomainsApi.new
 
 begin
   # List all instance domains
-  result = api_instance.list_domains
+  result = Clerk::SDK.domains.list_domains
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->list_domains: #{e}"
+  puts "Error when calling Clerk::SDK.domains->list_domains: #{e}"
 end
 ```
 
-#### Using the list_domains_with_http_info variant
+#### Using the `list_domains_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -187,12 +186,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # List all instance domains
-  data, status_code, headers = api_instance.list_domains_with_http_info
+  data, status_code, headers = Clerk::SDK.domains.list_domains_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Domains>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->list_domains_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.domains->list_domains_with_http_info: #{e}"
 end
 ```
 
@@ -226,27 +225,26 @@ The `proxy_url` can be updated only for production instances. Update one of the
 
 ```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::DomainsApi.new
 domain_id = 'domain_id_example' # String | The ID of the domain that will be updated.
 update_domain_request = ClerkHttpClient::UpdateDomainRequest.new # UpdateDomainRequest | 
 
 begin
   # Update a domain
-  result = api_instance.update_domain(domain_id, update_domain_request)
+  result = Clerk::SDK.domains.update_domain(domain_id, update_domain_request)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->update_domain: #{e}"
+  puts "Error when calling Clerk::SDK.domains->update_domain: #{e}"
 end
 ```
 
-#### Using the update_domain_with_http_info variant
+#### Using the `update_domain_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -255,12 +253,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Update a domain
-  data, status_code, headers = api_instance.update_domain_with_http_info(domain_id, update_domain_request)
+  data, status_code, headers = Clerk::SDK.domains.update_domain_with_http_info(domain_id, update_domain_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Domain>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling DomainsApi->update_domain_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.domains->update_domain_with_http_info: #{e}"
 end
 ```