zyphr 0.1.0

data/docs/AuthMFAApi.md

@@ -0,0 +1,546 @@
+# Zyphr::AuthMFAApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**disable_mfa**](AuthMFAApi.md#disable_mfa) | **POST** /auth/mfa/disable | Disable MFA for a user |
+| [**get_mfa_status**](AuthMFAApi.md#get_mfa_status) | **GET** /auth/mfa/status/{userId} | Get MFA status for a user |
+| [**regenerate_backup_codes**](AuthMFAApi.md#regenerate_backup_codes) | **POST** /auth/mfa/regenerate-backup-codes | Regenerate MFA backup codes |
+| [**start_mfa_enrollment**](AuthMFAApi.md#start_mfa_enrollment) | **POST** /auth/mfa/enroll | Start MFA enrollment |
+| [**verify_mfa_challenge**](AuthMFAApi.md#verify_mfa_challenge) | **POST** /auth/mfa/verify | Verify MFA challenge with TOTP code |
+| [**verify_mfa_challenge_with_backup_code**](AuthMFAApi.md#verify_mfa_challenge_with_backup_code) | **POST** /auth/mfa/verify-backup | Verify MFA challenge with backup code |
+| [**verify_mfa_enrollment**](AuthMFAApi.md#verify_mfa_enrollment) | **POST** /auth/mfa/verify-enrollment | Verify MFA enrollment |
+
+
+## disable_mfa
+
+> <MfaDisableResponse> disable_mfa(mfa_disable_request)
+
+Disable MFA for a user
+
+Disables MFA for a user after verifying their identity with a TOTP code or backup code. Removes the TOTP secret and all backup codes. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMFAApi.new
+mfa_disable_request = Zyphr::MfaDisableRequest.new({user_id: 'user_id_example', verification_code: 'verification_code_example'}) # MfaDisableRequest | 
+
+begin
+  # Disable MFA for a user
+  result = api_instance.disable_mfa(mfa_disable_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->disable_mfa: #{e}"
+end
+```
+
+#### Using the disable_mfa_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MfaDisableResponse>, Integer, Hash)> disable_mfa_with_http_info(mfa_disable_request)
+
+```ruby
+begin
+  # Disable MFA for a user
+  data, status_code, headers = api_instance.disable_mfa_with_http_info(mfa_disable_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MfaDisableResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->disable_mfa_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_disable_request** | [**MfaDisableRequest**](MfaDisableRequest.md) |  |  |
+
+### Return type
+
+[**MfaDisableResponse**](MfaDisableResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_mfa_status
+
+> <MfaStatusResponse> get_mfa_status(user_id)
+
+Get MFA status for a user
+
+Returns the current MFA enrollment status for a user, including whether MFA is enabled, the enrollment status, when it was enabled, and the number of remaining backup codes. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMFAApi.new
+user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The end user's ID
+
+begin
+  # Get MFA status for a user
+  result = api_instance.get_mfa_status(user_id)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->get_mfa_status: #{e}"
+end
+```
+
+#### Using the get_mfa_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MfaStatusResponse>, Integer, Hash)> get_mfa_status_with_http_info(user_id)
+
+```ruby
+begin
+  # Get MFA status for a user
+  data, status_code, headers = api_instance.get_mfa_status_with_http_info(user_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MfaStatusResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->get_mfa_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **user_id** | **String** | The end user&#39;s ID |  |
+
+### Return type
+
+[**MfaStatusResponse**](MfaStatusResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## regenerate_backup_codes
+
+> <MfaBackupCodesResponse> regenerate_backup_codes(mfa_regenerate_backup_codes_request)
+
+Regenerate MFA backup codes
+
+Generates a new set of one-time backup codes for a user, invalidating all previous codes. Requires a valid TOTP code to authorize the regeneration. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMFAApi.new
+mfa_regenerate_backup_codes_request = Zyphr::MfaRegenerateBackupCodesRequest.new({user_id: 'user_id_example', totp_code: 'totp_code_example'}) # MfaRegenerateBackupCodesRequest | 
+
+begin
+  # Regenerate MFA backup codes
+  result = api_instance.regenerate_backup_codes(mfa_regenerate_backup_codes_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->regenerate_backup_codes: #{e}"
+end
+```
+
+#### Using the regenerate_backup_codes_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MfaBackupCodesResponse>, Integer, Hash)> regenerate_backup_codes_with_http_info(mfa_regenerate_backup_codes_request)
+
+```ruby
+begin
+  # Regenerate MFA backup codes
+  data, status_code, headers = api_instance.regenerate_backup_codes_with_http_info(mfa_regenerate_backup_codes_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MfaBackupCodesResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->regenerate_backup_codes_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_regenerate_backup_codes_request** | [**MfaRegenerateBackupCodesRequest**](MfaRegenerateBackupCodesRequest.md) |  |  |
+
+### Return type
+
+[**MfaBackupCodesResponse**](MfaBackupCodesResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## start_mfa_enrollment
+
+> <MfaEnrollmentResponse> start_mfa_enrollment(mfa_enroll_request)
+
+Start MFA enrollment
+
+Begins TOTP-based MFA enrollment for a user. Returns the TOTP secret, a QR code data URL for scanning with an authenticator app, and a set of one-time backup codes. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMFAApi.new
+mfa_enroll_request = Zyphr::MfaEnrollRequest.new({user_id: 'user_id_example'}) # MfaEnrollRequest | 
+
+begin
+  # Start MFA enrollment
+  result = api_instance.start_mfa_enrollment(mfa_enroll_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->start_mfa_enrollment: #{e}"
+end
+```
+
+#### Using the start_mfa_enrollment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MfaEnrollmentResponse>, Integer, Hash)> start_mfa_enrollment_with_http_info(mfa_enroll_request)
+
+```ruby
+begin
+  # Start MFA enrollment
+  data, status_code, headers = api_instance.start_mfa_enrollment_with_http_info(mfa_enroll_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MfaEnrollmentResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->start_mfa_enrollment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_enroll_request** | [**MfaEnrollRequest**](MfaEnrollRequest.md) |  |  |
+
+### Return type
+
+[**MfaEnrollmentResponse**](MfaEnrollmentResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_mfa_challenge
+
+> <AuthResultResponse> verify_mfa_challenge(mfa_verify_request)
+
+Verify MFA challenge with TOTP code
+
+Verifies a TOTP code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data with access and refresh tokens. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMFAApi.new
+mfa_verify_request = Zyphr::MfaVerifyRequest.new({challenge_token: 'challenge_token_example', totp_code: 'totp_code_example'}) # MfaVerifyRequest | 
+
+begin
+  # Verify MFA challenge with TOTP code
+  result = api_instance.verify_mfa_challenge(mfa_verify_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->verify_mfa_challenge: #{e}"
+end
+```
+
+#### Using the verify_mfa_challenge_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResultResponse>, Integer, Hash)> verify_mfa_challenge_with_http_info(mfa_verify_request)
+
+```ruby
+begin
+  # Verify MFA challenge with TOTP code
+  data, status_code, headers = api_instance.verify_mfa_challenge_with_http_info(mfa_verify_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResultResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->verify_mfa_challenge_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_verify_request** | [**MfaVerifyRequest**](MfaVerifyRequest.md) |  |  |
+
+### Return type
+
+[**AuthResultResponse**](AuthResultResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_mfa_challenge_with_backup_code
+
+> <MfaVerifyBackupResponse> verify_mfa_challenge_with_backup_code(mfa_verify_backup_request)
+
+Verify MFA challenge with backup code
+
+Verifies a one-time backup code against an MFA challenge token issued during login. On success, completes the authentication flow and returns user data, tokens, and the count of remaining backup codes. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMFAApi.new
+mfa_verify_backup_request = Zyphr::MfaVerifyBackupRequest.new({challenge_token: 'challenge_token_example', backup_code: 'backup_code_example'}) # MfaVerifyBackupRequest | 
+
+begin
+  # Verify MFA challenge with backup code
+  result = api_instance.verify_mfa_challenge_with_backup_code(mfa_verify_backup_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->verify_mfa_challenge_with_backup_code: #{e}"
+end
+```
+
+#### Using the verify_mfa_challenge_with_backup_code_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MfaVerifyBackupResponse>, Integer, Hash)> verify_mfa_challenge_with_backup_code_with_http_info(mfa_verify_backup_request)
+
+```ruby
+begin
+  # Verify MFA challenge with backup code
+  data, status_code, headers = api_instance.verify_mfa_challenge_with_backup_code_with_http_info(mfa_verify_backup_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MfaVerifyBackupResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->verify_mfa_challenge_with_backup_code_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_verify_backup_request** | [**MfaVerifyBackupRequest**](MfaVerifyBackupRequest.md) |  |  |
+
+### Return type
+
+[**MfaVerifyBackupResponse**](MfaVerifyBackupResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_mfa_enrollment
+
+> <MfaVerifyEnrollmentResponse> verify_mfa_enrollment(mfa_verify_enrollment_request)
+
+Verify MFA enrollment
+
+Completes MFA enrollment by verifying a TOTP code from the user's authenticator app. On success, MFA is permanently enabled for the user. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMFAApi.new
+mfa_verify_enrollment_request = Zyphr::MfaVerifyEnrollmentRequest.new({user_id: 'user_id_example', totp_code: 'totp_code_example'}) # MfaVerifyEnrollmentRequest | 
+
+begin
+  # Verify MFA enrollment
+  result = api_instance.verify_mfa_enrollment(mfa_verify_enrollment_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->verify_mfa_enrollment: #{e}"
+end
+```
+
+#### Using the verify_mfa_enrollment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MfaVerifyEnrollmentResponse>, Integer, Hash)> verify_mfa_enrollment_with_http_info(mfa_verify_enrollment_request)
+
+```ruby
+begin
+  # Verify MFA enrollment
+  data, status_code, headers = api_instance.verify_mfa_enrollment_with_http_info(mfa_verify_enrollment_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MfaVerifyEnrollmentResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMFAApi->verify_mfa_enrollment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_verify_enrollment_request** | [**MfaVerifyEnrollmentRequest**](MfaVerifyEnrollmentRequest.md) |  |  |
+
+### Return type
+
+[**MfaVerifyEnrollmentResponse**](MfaVerifyEnrollmentResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AuthMagicLinksApi.md

@@ -0,0 +1,161 @@
+# Zyphr::AuthMagicLinksApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**send_magic_link**](AuthMagicLinksApi.md#send_magic_link) | **POST** /auth/magic-link/send | Send a magic link |
+| [**verify_magic_link**](AuthMagicLinksApi.md#verify_magic_link) | **POST** /auth/magic-link/verify | Verify a magic link |
+
+
+## send_magic_link
+
+> <SuccessResult> send_magic_link(magic_link_send_request)
+
+Send a magic link
+
+Send a magic link email for passwordless authentication.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMagicLinksApi.new
+magic_link_send_request = Zyphr::MagicLinkSendRequest.new({email: 'email_example'}) # MagicLinkSendRequest | 
+
+begin
+  # Send a magic link
+  result = api_instance.send_magic_link(magic_link_send_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMagicLinksApi->send_magic_link: #{e}"
+end
+```
+
+#### Using the send_magic_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResult>, Integer, Hash)> send_magic_link_with_http_info(magic_link_send_request)
+
+```ruby
+begin
+  # Send a magic link
+  data, status_code, headers = api_instance.send_magic_link_with_http_info(magic_link_send_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResult>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMagicLinksApi->send_magic_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **magic_link_send_request** | [**MagicLinkSendRequest**](MagicLinkSendRequest.md) |  |  |
+
+### Return type
+
+[**SuccessResult**](SuccessResult.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_magic_link
+
+> <MagicLinkVerifyResponse> verify_magic_link(magic_link_verify_request)
+
+Verify a magic link
+
+Verify a magic link token and authenticate the user. Returns auth result with is_new_user flag.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # Configure API key authorization: ApplicationSecret
+  config.api_key['X-Application-Secret'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Secret'] = 'Bearer'
+
+  # Configure API key authorization: ApplicationPublicKey
+  config.api_key['X-Application-Key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['X-Application-Key'] = 'Bearer'
+end
+
+api_instance = Zyphr::AuthMagicLinksApi.new
+magic_link_verify_request = Zyphr::MagicLinkVerifyRequest.new({token: 'token_example'}) # MagicLinkVerifyRequest | 
+
+begin
+  # Verify a magic link
+  result = api_instance.verify_magic_link(magic_link_verify_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMagicLinksApi->verify_magic_link: #{e}"
+end
+```
+
+#### Using the verify_magic_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MagicLinkVerifyResponse>, Integer, Hash)> verify_magic_link_with_http_info(magic_link_verify_request)
+
+```ruby
+begin
+  # Verify a magic link
+  data, status_code, headers = api_instance.verify_magic_link_with_http_info(magic_link_verify_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MagicLinkVerifyResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthMagicLinksApi->verify_magic_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **magic_link_verify_request** | [**MagicLinkVerifyRequest**](MagicLinkVerifyRequest.md) |  |  |
+
+### Return type
+
+[**MagicLinkVerifyResponse**](MagicLinkVerifyResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+