diff --git a/.generated/README.md b/.generated/README.md index d0d9608..87cf588 100644 --- a/.generated/README.md +++ b/.generated/README.md @@ -31,7 +31,7 @@ Please review that repository for setup information. ## Installation ```shell -gem 'clerk-http-client', '~> 1.0.0' +gem 'clerk-sdk-ruby', '~> 4.0', require: 'clerk' ``` ## Generate a client diff --git a/.generated/docs/ActorTokensApi.md b/.generated/docs/ActorTokensApi.md index c474e3f..793d94a 100644 --- a/.generated/docs/ActorTokensApi.md +++ b/.generated/docs/ActorTokensApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::ActorTokensApi +# Clerk::SDK.actor_tokens All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/AllowListBlockListApi.md b/.generated/docs/AllowListBlockListApi.md index d1e01a4..b74ed53 100644 --- a/.generated/docs/AllowListBlockListApi.md +++ b/.generated/docs/AllowListBlockListApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::AllowListBlockListApi +# Clerk::SDK.allow_list_block_list All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/BetaFeaturesApi.md b/.generated/docs/BetaFeaturesApi.md index d0dbc45..71cc21b 100644 --- a/.generated/docs/BetaFeaturesApi.md +++ b/.generated/docs/BetaFeaturesApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::BetaFeaturesApi +# Clerk::SDK.beta_features All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/ClientsApi.md b/.generated/docs/ClientsApi.md index 3b412d7..a1997e4 100644 --- a/.generated/docs/ClientsApi.md +++ b/.generated/docs/ClientsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::ClientsApi +# Clerk::SDK.clients All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/DomainsApi.md b/.generated/docs/DomainsApi.md index 9f0d600..9d119f8 100644 --- a/.generated/docs/DomainsApi.md +++ b/.generated/docs/DomainsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::DomainsApi +# Clerk::SDK.domains All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/EmailAddressesApi.md b/.generated/docs/EmailAddressesApi.md index b5417d6..e2250ed 100644 --- a/.generated/docs/EmailAddressesApi.md +++ b/.generated/docs/EmailAddressesApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::EmailAddressesApi +# Clerk::SDK.email_addresses All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/EmailSMSTemplatesApi.md b/.generated/docs/EmailSMSTemplatesApi.md index 6706a65..889d5a5 100644 --- a/.generated/docs/EmailSMSTemplatesApi.md +++ b/.generated/docs/EmailSMSTemplatesApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::EmailSMSTemplatesApi +# Clerk::SDK.email_sms_templates All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/InstanceSettingsApi.md b/.generated/docs/InstanceSettingsApi.md index 37901b7..ac5e48d 100644 --- a/.generated/docs/InstanceSettingsApi.md +++ b/.generated/docs/InstanceSettingsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::InstanceSettingsApi +# Clerk::SDK.instance_settings All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/InvitationsApi.md b/.generated/docs/InvitationsApi.md index 16be382..43d25c4 100644 --- a/.generated/docs/InvitationsApi.md +++ b/.generated/docs/InvitationsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::InvitationsApi +# Clerk::SDK.invitations All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/JWKSApi.md b/.generated/docs/JWKSApi.md index 397936c..d890721 100644 --- a/.generated/docs/JWKSApi.md +++ b/.generated/docs/JWKSApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::JWKSApi +# Clerk::SDK.jwks All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/JWTTemplatesApi.md b/.generated/docs/JWTTemplatesApi.md index f18560c..d85533c 100644 --- a/.generated/docs/JWTTemplatesApi.md +++ b/.generated/docs/JWTTemplatesApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::JWTTemplatesApi +# Clerk::SDK.jwt_templates All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/MiscellaneousApi.md b/.generated/docs/MiscellaneousApi.md index e827c79..dad30c4 100644 --- a/.generated/docs/MiscellaneousApi.md +++ b/.generated/docs/MiscellaneousApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::MiscellaneousApi +# Clerk::SDK.miscellaneous All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/OAuthApplicationsApi.md b/.generated/docs/OAuthApplicationsApi.md deleted file mode 100644 index 0ed3898..0000000 --- a/.generated/docs/OAuthApplicationsApi.md +++ /dev/null @@ -1,429 +0,0 @@ -# ClerkHttpClient::OAuthApplicationsApi - -All URIs are relative to *https://api.clerk.com/v1* - -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_oauth_application**](OAuthApplicationsApi.md#create_oauth_application) | **POST** /oauth_applications | Create an OAuth application | -| [**delete_oauth_application**](OAuthApplicationsApi.md#delete_oauth_application) | **DELETE** /oauth_applications/{oauth_application_id} | Delete an OAuth application | -| [**get_oauth_application**](OAuthApplicationsApi.md#get_oauth_application) | **GET** /oauth_applications/{oauth_application_id} | Retrieve an OAuth application by ID | -| [**list_oauth_applications**](OAuthApplicationsApi.md#list_oauth_applications) | **GET** /oauth_applications | Get a list of OAuth applications for an instance | -| [**rotate_oauth_application_secret**](OAuthApplicationsApi.md#rotate_oauth_application_secret) | **POST** /oauth_applications/{oauth_application_id}/rotate_secret | Rotate the client secret of the given OAuth application | -| [**update_oauth_application**](OAuthApplicationsApi.md#update_oauth_application) | **PATCH** /oauth_applications/{oauth_application_id} | Update an OAuth application | - - -## create_oauth_application - -> create_oauth_application(opts) - -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' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -opts = { - create_oauth_application_request: ClerkHttpClient::CreateOAuthApplicationRequest.new({name: 'name_example'}) # CreateOAuthApplicationRequest | -} - -begin - # Create an OAuth application - result = Clerk::SDK.oauth_applications.create_oauth_application(opts) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->create_oauth_application: #{e}" -end -``` - -#### Using the `create_oauth_application_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> create_oauth_application_with_http_info(opts) - -```ruby -begin - # Create an OAuth application - data, status_code, headers = Clerk::SDK.oauth_applications.create_oauth_application_with_http_info(opts) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->create_oauth_application_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **create_oauth_application_request** | [**CreateOAuthApplicationRequest**](CreateOAuthApplicationRequest.md) | | [optional] | - -### Return type - -[**OAuthApplicationWithSecret**](OAuthApplicationWithSecret.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -## delete_oauth_application - -> delete_oauth_application(oauth_application_id) - -Delete an OAuth application - -Deletes the given OAuth application. This is not reversible. - -### Examples - -```ruby -require 'time' -require 'clerk' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application to delete - -begin - # Delete an OAuth application - result = Clerk::SDK.oauth_applications.delete_oauth_application(oauth_application_id) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->delete_oauth_application: #{e}" -end -``` - -#### Using the `delete_oauth_application_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> delete_oauth_application_with_http_info(oauth_application_id) - -```ruby -begin - # Delete an OAuth application - data, status_code, headers = Clerk::SDK.oauth_applications.delete_oauth_application_with_http_info(oauth_application_id) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->delete_oauth_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_oauth_application - -> get_oauth_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' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application - -begin - # Retrieve an OAuth application by ID - result = Clerk::SDK.oauth_applications.get_oauth_application(oauth_application_id) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->get_oauth_application: #{e}" -end -``` - -#### Using the `get_oauth_application_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> get_oauth_application_with_http_info(oauth_application_id) - -```ruby -begin - # Retrieve an OAuth application by ID - data, status_code, headers = Clerk::SDK.oauth_applications.get_oauth_application_with_http_info(oauth_application_id) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->get_oauth_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_oauth_applications - -> list_oauth_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' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -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 = Clerk::SDK.oauth_applications.list_oauth_applications(opts) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->list_oauth_applications: #{e}" -end -``` - -#### Using the `list_oauth_applications_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> list_oauth_applications_with_http_info(opts) - -```ruby -begin - # Get a list of OAuth applications for an instance - data, status_code, headers = Clerk::SDK.oauth_applications.list_oauth_applications_with_http_info(opts) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->list_oauth_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 `offset`. | [optional][default to 10] | -| **offset** | **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`. | [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_oauth_application_secret - -> rotate_oauth_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' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -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 = Clerk::SDK.oauth_applications.rotate_oauth_application_secret(oauth_application_id) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->rotate_oauth_application_secret: #{e}" -end -``` - -#### Using the `rotate_oauth_application_secret_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> rotate_oauth_application_secret_with_http_info(oauth_application_id) - -```ruby -begin - # Rotate the client secret of the given OAuth application - data, status_code, headers = Clerk::SDK.oauth_applications.rotate_oauth_application_secret_with_http_info(oauth_application_id) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->rotate_oauth_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_oauth_application - -> update_oauth_application(oauth_application_id, update_oauth_application_request) - -Update an OAuth application - -Updates an existing OAuth application - -### Examples - -```ruby -require 'time' -require 'clerk' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -oauth_application_id = 'oauth_application_id_example' # String | The ID of the OAuth application to update -update_oauth_application_request = ClerkHttpClient::UpdateOAuthApplicationRequest.new # UpdateOAuthApplicationRequest | - -begin - # Update an OAuth application - result = Clerk::SDK.oauth_applications.update_oauth_application(oauth_application_id, update_oauth_application_request) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->update_oauth_application: #{e}" -end -``` - -#### Using the `update_oauth_application_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> update_oauth_application_with_http_info(oauth_application_id, update_oauth_application_request) - -```ruby -begin - # Update an OAuth application - data, status_code, headers = Clerk::SDK.oauth_applications.update_oauth_application_with_http_info(oauth_application_id, update_oauth_application_request) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.oauth_applications->update_oauth_application_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **oauth_application_id** | **String** | The ID of the OAuth application to update | | -| **update_oauth_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 - diff --git a/.generated/docs/OauthApplicationsApi.md b/.generated/docs/OauthApplicationsApi.md index 0ed3898..8b8f15e 100644 --- a/.generated/docs/OauthApplicationsApi.md +++ b/.generated/docs/OauthApplicationsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::OAuthApplicationsApi +# Clerk::SDK.oauth_applications All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/OrganizationDomainsApi.md b/.generated/docs/OrganizationDomainsApi.md index b0a2273..c2d4c60 100644 --- a/.generated/docs/OrganizationDomainsApi.md +++ b/.generated/docs/OrganizationDomainsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::OrganizationDomainsApi +# Clerk::SDK.organization_domains All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/OrganizationInvitationsApi.md b/.generated/docs/OrganizationInvitationsApi.md index 7ebda1a..f2a5c60 100644 --- a/.generated/docs/OrganizationInvitationsApi.md +++ b/.generated/docs/OrganizationInvitationsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::OrganizationInvitationsApi +# Clerk::SDK.organization_invitations All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/OrganizationMembershipsApi.md b/.generated/docs/OrganizationMembershipsApi.md index 1df1e1a..bc80de0 100644 --- a/.generated/docs/OrganizationMembershipsApi.md +++ b/.generated/docs/OrganizationMembershipsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::OrganizationMembershipsApi +# Clerk::SDK.organization_memberships All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/OrganizationsApi.md b/.generated/docs/OrganizationsApi.md index cb9dd5f..ad2f266 100644 --- a/.generated/docs/OrganizationsApi.md +++ b/.generated/docs/OrganizationsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::OrganizationsApi +# Clerk::SDK.organizations All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/PhoneNumbersApi.md b/.generated/docs/PhoneNumbersApi.md index b770550..c67425b 100644 --- a/.generated/docs/PhoneNumbersApi.md +++ b/.generated/docs/PhoneNumbersApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::PhoneNumbersApi +# Clerk::SDK.phone_numbers All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/ProxyChecksApi.md b/.generated/docs/ProxyChecksApi.md index 7c135cc..d8ad637 100644 --- a/.generated/docs/ProxyChecksApi.md +++ b/.generated/docs/ProxyChecksApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::ProxyChecksApi +# Clerk::SDK.proxy_checks All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/RedirectURLsApi.md b/.generated/docs/RedirectURLsApi.md index 81110b9..51f1da6 100644 --- a/.generated/docs/RedirectURLsApi.md +++ b/.generated/docs/RedirectURLsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::RedirectURLsApi +# Clerk::SDK.redirect_urls All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/RedirectUrlsApi.md b/.generated/docs/RedirectUrlsApi.md deleted file mode 100644 index 81110b9..0000000 --- a/.generated/docs/RedirectUrlsApi.md +++ /dev/null @@ -1,282 +0,0 @@ -# ClerkHttpClient::RedirectURLsApi - -All URIs are relative to *https://api.clerk.com/v1* - -| Method | HTTP request | Description | -| ------ | ------------ | ----------- | -| [**create_redirect_url**](RedirectURLsApi.md#create_redirect_url) | **POST** /redirect_urls | Create a redirect URL | -| [**delete_redirect_url**](RedirectURLsApi.md#delete_redirect_url) | **DELETE** /redirect_urls/{id} | Delete a redirect URL | -| [**get_redirect_url**](RedirectURLsApi.md#get_redirect_url) | **GET** /redirect_urls/{id} | Retrieve a redirect URL | -| [**list_redirect_urls**](RedirectURLsApi.md#list_redirect_urls) | **GET** /redirect_urls | List all redirect URLs | - - -## create_redirect_url - -> create_redirect_url(opts) - -Create a redirect URL - -Create a redirect URL - -### Examples - -```ruby -require 'time' -require 'clerk' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -opts = { - create_redirect_url_request: ClerkHttpClient::CreateRedirectURLRequest.new # CreateRedirectURLRequest | -} - -begin - # Create a redirect URL - result = Clerk::SDK.redirect_urls.create_redirect_url(opts) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->create_redirect_url: #{e}" -end -``` - -#### Using the `create_redirect_url_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> create_redirect_url_with_http_info(opts) - -```ruby -begin - # Create a redirect URL - data, status_code, headers = Clerk::SDK.redirect_urls.create_redirect_url_with_http_info(opts) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->create_redirect_url_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **create_redirect_url_request** | [**CreateRedirectURLRequest**](CreateRedirectURLRequest.md) | | [optional] | - -### Return type - -[**RedirectURL**](RedirectURL.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - - -## delete_redirect_url - -> delete_redirect_url(id) - -Delete a redirect URL - -Remove the selected redirect URL from the whitelist of the instance - -### Examples - -```ruby -require 'time' -require 'clerk' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -id = 'id_example' # String | The ID of the redirect URL - -begin - # Delete a redirect URL - result = Clerk::SDK.redirect_urls.delete_redirect_url(id) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->delete_redirect_url: #{e}" -end -``` - -#### Using the `delete_redirect_url_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> delete_redirect_url_with_http_info(id) - -```ruby -begin - # Delete a redirect URL - data, status_code, headers = Clerk::SDK.redirect_urls.delete_redirect_url_with_http_info(id) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->delete_redirect_url_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | The ID of the redirect URL | | - -### Return type - -[**DeletedObject**](DeletedObject.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## get_redirect_url - -> get_redirect_url(id) - -Retrieve a redirect URL - -Retrieve the details of the redirect URL with the given ID - -### Examples - -```ruby -require 'time' -require 'clerk' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - -id = 'id_example' # String | The ID of the redirect URL - -begin - # Retrieve a redirect URL - result = Clerk::SDK.redirect_urls.get_redirect_url(id) - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->get_redirect_url: #{e}" -end -``` - -#### Using the `get_redirect_url_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> , Integer, Hash)> get_redirect_url_with_http_info(id) - -```ruby -begin - # Retrieve a redirect URL - data, status_code, headers = Clerk::SDK.redirect_urls.get_redirect_url_with_http_info(id) - p status_code # => 2xx - p headers # => { ... } - p data # => -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->get_redirect_url_with_http_info: #{e}" -end -``` - -### Parameters - -| Name | Type | Description | Notes | -| ---- | ---- | ----------- | ----- | -| **id** | **String** | The ID of the redirect URL | | - -### Return type - -[**RedirectURL**](RedirectURL.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - - -## list_redirect_urls - -> > list_redirect_urls - -List all redirect URLs - -Lists all whitelisted redirect_urls for the instance - -### Examples - -```ruby -require 'time' -require 'clerk' - -## Setup -Clerk.configure do |config| - config.secret_key = 'sk_test_xxxxxxxxx' -end - - -begin - # List all redirect URLs - result = Clerk::SDK.redirect_urls.list_redirect_urls - p result -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->list_redirect_urls: #{e}" -end -``` - -#### Using the `list_redirect_urls_with_http_info variant - -This returns an Array which contains the response data, status code and headers. - -> >, Integer, Hash)> list_redirect_urls_with_http_info - -```ruby -begin - # List all redirect URLs - data, status_code, headers = Clerk::SDK.redirect_urls.list_redirect_urls_with_http_info - p status_code # => 2xx - p headers # => { ... } - p data # => > -rescue ClerkHttpClient::ApiError => e - puts "Error when calling Clerk::SDK.redirect_urls->list_redirect_urls_with_http_info: #{e}" -end -``` - -### Parameters - -This endpoint does not need any parameter. - -### Return type - -[**Array<RedirectURL>**](RedirectURL.md) - -### Authorization - -[bearerAuth](../README.md#bearerAuth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - diff --git a/.generated/docs/SAMLConnectionsApi.md b/.generated/docs/SAMLConnectionsApi.md index 9d942dc..31982f0 100644 --- a/.generated/docs/SAMLConnectionsApi.md +++ b/.generated/docs/SAMLConnectionsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::SAMLConnectionsApi +# Clerk::SDK.saml_connections All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/SessionsApi.md b/.generated/docs/SessionsApi.md index 447d413..7579bac 100644 --- a/.generated/docs/SessionsApi.md +++ b/.generated/docs/SessionsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::SessionsApi +# Clerk::SDK.sessions All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/SignInTokensApi.md b/.generated/docs/SignInTokensApi.md index f93cbc8..81384e4 100644 --- a/.generated/docs/SignInTokensApi.md +++ b/.generated/docs/SignInTokensApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::SignInTokensApi +# Clerk::SDK.sign_in_tokens All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/SignUpsApi.md b/.generated/docs/SignUpsApi.md index 98d7358..8d7c162 100644 --- a/.generated/docs/SignUpsApi.md +++ b/.generated/docs/SignUpsApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::SignUpsApi +# Clerk::SDK.sign_ups All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/TestingTokensApi.md b/.generated/docs/TestingTokensApi.md index d9818b4..be00493 100644 --- a/.generated/docs/TestingTokensApi.md +++ b/.generated/docs/TestingTokensApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::TestingTokensApi +# Clerk::SDK.testing_tokens All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/UsersApi.md b/.generated/docs/UsersApi.md index 3dc25cb..3e3f607 100644 --- a/.generated/docs/UsersApi.md +++ b/.generated/docs/UsersApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::UsersApi +# Clerk::SDK.users All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/WaitlistEntriesApi.md b/.generated/docs/WaitlistEntriesApi.md index b6105e4..8e98c2e 100644 --- a/.generated/docs/WaitlistEntriesApi.md +++ b/.generated/docs/WaitlistEntriesApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::WaitlistEntriesApi +# Clerk::SDK.waitlist_entries All URIs are relative to *https://api.clerk.com/v1* diff --git a/.generated/docs/WebhooksApi.md b/.generated/docs/WebhooksApi.md index 6d57a7d..5c38501 100644 --- a/.generated/docs/WebhooksApi.md +++ b/.generated/docs/WebhooksApi.md @@ -1,4 +1,4 @@ -# ClerkHttpClient::WebhooksApi +# Clerk::SDK.webhooks All URIs are relative to *https://api.clerk.com/v1* diff --git a/resources/templates/README.mustache b/resources/templates/README.mustache index 3f19416..2b66ecd 100644 --- a/resources/templates/README.mustache +++ b/resources/templates/README.mustache @@ -29,7 +29,7 @@ Please review that repository for setup information. ## Installation ```shell -gem '{{{gemName}}}', '~> {{{gemVersion}}}' +gem 'clerk-sdk-ruby', '~> 4.0', require: 'clerk' ``` ## Generate a client diff --git a/resources/templates/api_doc.mustache b/resources/templates/api_doc.mustache index d580a73..07741d2 100644 --- a/resources/templates/api_doc.mustache +++ b/resources/templates/api_doc.mustache @@ -1,4 +1,4 @@ -# {{moduleName}}::{{classname}}{{#description}} +# {{{sdk_module_prefix}}}.{{#snakecase}}{{#remove_api_suffix}}{{classname}}{{/remove_api_suffix}}{{/snakecase}}{{#description}} {{.}}{{/description}}