clerk-http-client 1.0.0 → 2.0.0.beta2

data/docs/SessionsApi.md

@@ -4,6 +4,8 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
+| [**create_session**](SessionsApi.md#create_session) | **POST** /sessions | Create a new active session |
+| [**create_session_token**](SessionsApi.md#create_session_token) | **POST** /sessions/{session_id}/tokens | Create a session token |
 | [**create_session_token_from_template**](SessionsApi.md#create_session_token_from_template) | **POST** /sessions/{session_id}/tokens/{template_name} | Create a session token from a jwt template |
 | [**get_session**](SessionsApi.md#get_session) | **GET** /sessions/{session_id} | Retrieve a session |
 | [**get_session_list**](SessionsApi.md#get_session_list) | **GET** /sessions | List all sessions |
@@ -11,9 +13,151 @@ All URIs are relative to *https://api.clerk.com/v1*
 | [**verify_session**](SessionsApi.md#verify_session) | **POST** /sessions/{session_id}/verify | Verify a session |
 
 
+## create_session
+
+> <Session> create_session(opts)
+
+Create a new active session
+
+Create a new active session for the provided user ID.  This operation is only available for Clerk Development instances.
+
+### Examples
+
+```ruby
+require 'time'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
+end
+
+opts = {
+  create_session_request: ClerkHttpClient::CreateSessionRequest.new # CreateSessionRequest | 
+}
+
+begin
+  # Create a new active session
+  result = Clerk::SDK.sessions.create_session(opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling Clerk::SDK.sessions->create_session: #{e}"
+end
+```
+
+#### Using the `create_session_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Session>, Integer, Hash)> create_session_with_http_info(opts)
+
+```ruby
+begin
+  # Create a new active session
+  data, status_code, headers = Clerk::SDK.sessions.create_session_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Session>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling Clerk::SDK.sessions->create_session_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_session_request** | [**CreateSessionRequest**](CreateSessionRequest.md) |  | [optional] |
+
+### Return type
+
+[**Session**](Session.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_session_token
+
+> <CreateSessionToken200Response> create_session_token(session_id, opts)
+
+Create a session token
+
+Creates a session JSON Web Token (JWT) based on a session.
+
+### Examples
+
+```ruby
+require 'time'
+require 'clerk'
+
+## Setup
+Clerk.configure do |config|
+  config.secret_key = 'sk_test_xxxxxxxxx'
+end
+
+session_id = 'session_id_example' # String | The ID of the session
+opts = {
+  create_session_token_request: ClerkHttpClient::CreateSessionTokenRequest.new # CreateSessionTokenRequest | 
+}
+
+begin
+  # Create a session token
+  result = Clerk::SDK.sessions.create_session_token(session_id, opts)
+  p result
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling Clerk::SDK.sessions->create_session_token: #{e}"
+end
+```
+
+#### Using the `create_session_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateSessionToken200Response>, Integer, Hash)> create_session_token_with_http_info(session_id, opts)
+
+```ruby
+begin
+  # Create a session token
+  data, status_code, headers = Clerk::SDK.sessions.create_session_token_with_http_info(session_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateSessionToken200Response>
+rescue ClerkHttpClient::ApiError => e
+  puts "Error when calling Clerk::SDK.sessions->create_session_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **session_id** | **String** | The ID of the session |  |
+| **create_session_token_request** | [**CreateSessionTokenRequest**](CreateSessionTokenRequest.md) |  | [optional] |
+
+### Return type
+
+[**CreateSessionToken200Response**](CreateSessionToken200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
 ## create_session_token_from_template
 
-> <CreateSessionTokenFromTemplate200Response> create_session_token_from_template(session_id, template_name)
+> <CreateSessionToken200Response> create_session_token_from_template(session_id, template_name, opts)
 
 Create a session token from a jwt template
 
@@ -23,41 +167,43 @@ Creates a JSON Web Token(JWT) based on a session and a JWT Template name defined
 
 ```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::SessionsApi.new
 session_id = 'session_id_example' # String | The ID of the session
 template_name = 'template_name_example' # String | The name of the JWT Template defined in your instance (e.g. `custom_hasura`).
+opts = {
+  create_session_token_from_template_request: ClerkHttpClient::CreateSessionTokenFromTemplateRequest.new # CreateSessionTokenFromTemplateRequest | 
+}
 
 begin
   # Create a session token from a jwt template
-  result = api_instance.create_session_token_from_template(session_id, template_name)
+  result = Clerk::SDK.sessions.create_session_token_from_template(session_id, template_name, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->create_session_token_from_template: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->create_session_token_from_template: #{e}"
 end
 ```
 
-#### Using the create_session_token_from_template_with_http_info variant
+#### Using the `create_session_token_from_template_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<CreateSessionTokenFromTemplate200Response>, Integer, Hash)> create_session_token_from_template_with_http_info(session_id, template_name)
+> <Array(<CreateSessionToken200Response>, Integer, Hash)> create_session_token_from_template_with_http_info(session_id, template_name, opts)
 
 ```ruby
 begin
   # Create a session token from a jwt template
-  data, status_code, headers = api_instance.create_session_token_from_template_with_http_info(session_id, template_name)
+  data, status_code, headers = Clerk::SDK.sessions.create_session_token_from_template_with_http_info(session_id, template_name, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <CreateSessionTokenFromTemplate200Response>
+  p data # => <CreateSessionToken200Response>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->create_session_token_from_template_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->create_session_token_from_template_with_http_info: #{e}"
 end
 ```
 
@@ -67,10 +213,11 @@ end
 | ---- | ---- | ----------- | ----- |
 | **session_id** | **String** | The ID of the session |  |
 | **template_name** | **String** | The name of the JWT Template defined in your instance (e.g. &#x60;custom_hasura&#x60;). |  |
+| **create_session_token_from_template_request** | [**CreateSessionTokenFromTemplateRequest**](CreateSessionTokenFromTemplateRequest.md) |  | [optional] |
 
 ### Return type
 
-[**CreateSessionTokenFromTemplate200Response**](CreateSessionTokenFromTemplate200Response.md)
+[**CreateSessionToken200Response**](CreateSessionToken200Response.md)
 
 ### Authorization
 
@@ -78,7 +225,7 @@ end
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
@@ -94,26 +241,25 @@ Retrieve the details of a session
 
 ```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::SessionsApi.new
 session_id = 'session_id_example' # String | The ID of the session
 
 begin
   # Retrieve a session
-  result = api_instance.get_session(session_id)
+  result = Clerk::SDK.sessions.get_session(session_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->get_session: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->get_session: #{e}"
 end
 ```
 
-#### Using the get_session_with_http_info variant
+#### Using the `get_session_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -122,12 +268,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Retrieve a session
-  data, status_code, headers = api_instance.get_session_with_http_info(session_id)
+  data, status_code, headers = Clerk::SDK.sessions.get_session_with_http_info(session_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Session>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->get_session_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->get_session_with_http_info: #{e}"
 end
 ```
 
@@ -163,14 +309,13 @@ Returns a list of all sessions. The sessions are returned sorted by creation dat
 
 ```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::SessionsApi.new
 opts = {
   client_id: 'client_id_example', # String | List sessions for the given client
   user_id: 'user_id_example', # String | List sessions for the given user
@@ -181,14 +326,14 @@ opts = {
 
 begin
   # List all sessions
-  result = api_instance.get_session_list(opts)
+  result = Clerk::SDK.sessions.get_session_list(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->get_session_list: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->get_session_list: #{e}"
 end
 ```
 
-#### Using the get_session_list_with_http_info variant
+#### Using the `get_session_list_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -197,12 +342,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # List all sessions
-  data, status_code, headers = api_instance.get_session_list_with_http_info(opts)
+  data, status_code, headers = Clerk::SDK.sessions.get_session_list_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Array<Session>>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->get_session_list_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->get_session_list_with_http_info: #{e}"
 end
 ```
 
@@ -242,26 +387,25 @@ Sets the status of a session as \"revoked\", which is an unauthenticated state.
 
 ```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::SessionsApi.new
 session_id = 'session_id_example' # String | The ID of the session
 
 begin
   # Revoke a session
-  result = api_instance.revoke_session(session_id)
+  result = Clerk::SDK.sessions.revoke_session(session_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->revoke_session: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->revoke_session: #{e}"
 end
 ```
 
-#### Using the revoke_session_with_http_info variant
+#### Using the `revoke_session_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -270,12 +414,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Revoke a session
-  data, status_code, headers = api_instance.revoke_session_with_http_info(session_id)
+  data, status_code, headers = Clerk::SDK.sessions.revoke_session_with_http_info(session_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Session>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->revoke_session_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->revoke_session_with_http_info: #{e}"
 end
 ```
 
@@ -311,14 +455,13 @@ Returns the session if it is authenticated, otherwise returns an error. WARNING:
 
 ```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::SessionsApi.new
 session_id = 'session_id_example' # String | The ID of the session
 opts = {
   verify_session_request: ClerkHttpClient::VerifySessionRequest.new # VerifySessionRequest | Parameters.
@@ -326,14 +469,14 @@ opts = {
 
 begin
   # Verify a session
-  result = api_instance.verify_session(session_id, opts)
+  result = Clerk::SDK.sessions.verify_session(session_id, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->verify_session: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->verify_session: #{e}"
 end
 ```
 
-#### Using the verify_session_with_http_info variant
+#### Using the `verify_session_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -342,12 +485,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Verify a session
-  data, status_code, headers = api_instance.verify_session_with_http_info(session_id, opts)
+  data, status_code, headers = Clerk::SDK.sessions.verify_session_with_http_info(session_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <Session>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SessionsApi->verify_session_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sessions->verify_session_with_http_info: #{e}"
 end
 ```
 

data/docs/SignInTokensApi.md

@@ -10,7 +10,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## create_sign_in_token
 
-> <SignInToken> create_sign_in_token(create_sign_in_token_request)
+> <SignInToken> create_sign_in_token(opts)
 
 Create sign-in token
 
@@ -20,40 +20,41 @@ Creates a new sign-in token and associates it with the given user. By default, s
 
 ```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::SignInTokensApi.new
-create_sign_in_token_request = ClerkHttpClient::CreateSignInTokenRequest.new # CreateSignInTokenRequest | 
+opts = {
+  create_sign_in_token_request: ClerkHttpClient::CreateSignInTokenRequest.new # CreateSignInTokenRequest | 
+}
 
 begin
   # Create sign-in token
-  result = api_instance.create_sign_in_token(create_sign_in_token_request)
+  result = Clerk::SDK.sign_in_tokens.create_sign_in_token(opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SignInTokensApi->create_sign_in_token: #{e}"
+  puts "Error when calling Clerk::SDK.sign_in_tokens->create_sign_in_token: #{e}"
 end
 ```
 
-#### Using the create_sign_in_token_with_http_info variant
+#### Using the `create_sign_in_token_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SignInToken>, Integer, Hash)> create_sign_in_token_with_http_info(create_sign_in_token_request)
+> <Array(<SignInToken>, Integer, Hash)> create_sign_in_token_with_http_info(opts)
 
 ```ruby
 begin
   # Create sign-in token
-  data, status_code, headers = api_instance.create_sign_in_token_with_http_info(create_sign_in_token_request)
+  data, status_code, headers = Clerk::SDK.sign_in_tokens.create_sign_in_token_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SignInToken>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SignInTokensApi->create_sign_in_token_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sign_in_tokens->create_sign_in_token_with_http_info: #{e}"
 end
 ```
 
@@ -61,7 +62,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **create_sign_in_token_request** | [**CreateSignInTokenRequest**](CreateSignInTokenRequest.md) |  |  |
+| **create_sign_in_token_request** | [**CreateSignInTokenRequest**](CreateSignInTokenRequest.md) |  | [optional] |
 
 ### Return type
 
@@ -89,26 +90,25 @@ Revokes a pending sign-in 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::SignInTokensApi.new
 sign_in_token_id = 'sign_in_token_id_example' # String | The ID of the sign-in token to be revoked
 
 begin
   # Revoke the given sign-in token
-  result = api_instance.revoke_sign_in_token(sign_in_token_id)
+  result = Clerk::SDK.sign_in_tokens.revoke_sign_in_token(sign_in_token_id)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SignInTokensApi->revoke_sign_in_token: #{e}"
+  puts "Error when calling Clerk::SDK.sign_in_tokens->revoke_sign_in_token: #{e}"
 end
 ```
 
-#### Using the revoke_sign_in_token_with_http_info variant
+#### Using the `revoke_sign_in_token_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
@@ -117,12 +117,12 @@ This returns an Array which contains the response data, status code and headers.
 ```ruby
 begin
   # Revoke the given sign-in token
-  data, status_code, headers = api_instance.revoke_sign_in_token_with_http_info(sign_in_token_id)
+  data, status_code, headers = Clerk::SDK.sign_in_tokens.revoke_sign_in_token_with_http_info(sign_in_token_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SignInToken>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SignInTokensApi->revoke_sign_in_token_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sign_in_tokens->revoke_sign_in_token_with_http_info: #{e}"
 end
 ```
 

data/docs/SignUp.md

@@ -19,13 +19,14 @@
 | **password_enabled** | **Boolean** |  |  |
 | **first_name** | **String** |  | [optional] |
 | **last_name** | **String** |  | [optional] |
-| **unsafe_metadata** | **Object** |  | [optional] |
-| **public_metadata** | **Object** |  | [optional] |
+| **unsafe_metadata** | **Hash<String, Object>** |  | [optional] |
+| **public_metadata** | **Hash<String, Object>** |  | [optional] |
 | **custom_action** | **Boolean** |  |  |
 | **external_id** | **String** |  | [optional] |
 | **created_session_id** | **String** |  | [optional] |
 | **created_user_id** | **String** |  | [optional] |
 | **abandon_at** | **Integer** |  |  |
+| **legal_accepted_at** | **Integer** | Unix timestamp at which the user accepted the legal requirements.  | [optional] |
 | **external_account** | **Object** |  | [optional] |
 
 ## Example
@@ -56,6 +57,7 @@ instance = ClerkHttpClient::SignUp.new(
   created_session_id: null,
   created_user_id: null,
   abandon_at: null,
+  legal_accepted_at: 1700690400000,
   external_account: null
 )
 ```

data/docs/SignUpsApi.md

@@ -9,7 +9,7 @@ All URIs are relative to *https://api.clerk.com/v1*
 
 ## update_sign_up
 
-> <SignUp> update_sign_up(id, update_sign_up_request)
+> <SignUp> update_sign_up(id, opts)
 
 Update a sign-up
 
@@ -19,41 +19,42 @@ Update the sign-up with the given ID
 
 ```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::SignUpsApi.new
 id = 'id_example' # String | The ID of the sign-up to update
-update_sign_up_request = ClerkHttpClient::UpdateSignUpRequest.new # UpdateSignUpRequest | 
+opts = {
+  update_sign_up_request: ClerkHttpClient::UpdateSignUpRequest.new # UpdateSignUpRequest | 
+}
 
 begin
   # Update a sign-up
-  result = api_instance.update_sign_up(id, update_sign_up_request)
+  result = Clerk::SDK.sign_ups.update_sign_up(id, opts)
   p result
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SignUpsApi->update_sign_up: #{e}"
+  puts "Error when calling Clerk::SDK.sign_ups->update_sign_up: #{e}"
 end
 ```
 
-#### Using the update_sign_up_with_http_info variant
+#### Using the `update_sign_up_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<SignUp>, Integer, Hash)> update_sign_up_with_http_info(id, update_sign_up_request)
+> <Array(<SignUp>, Integer, Hash)> update_sign_up_with_http_info(id, opts)
 
 ```ruby
 begin
   # Update a sign-up
-  data, status_code, headers = api_instance.update_sign_up_with_http_info(id, update_sign_up_request)
+  data, status_code, headers = Clerk::SDK.sign_ups.update_sign_up_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <SignUp>
 rescue ClerkHttpClient::ApiError => e
-  puts "Error when calling SignUpsApi->update_sign_up_with_http_info: #{e}"
+  puts "Error when calling Clerk::SDK.sign_ups->update_sign_up_with_http_info: #{e}"
 end
 ```
 
@@ -62,7 +63,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | The ID of the sign-up to update |  |
-| **update_sign_up_request** | [**UpdateSignUpRequest**](UpdateSignUpRequest.md) |  |  |
+| **update_sign_up_request** | [**UpdateSignUpRequest**](UpdateSignUpRequest.md) |  | [optional] |
 
 ### Return type