zyphr 0.1.0

data/docs/AuthPasswordResetApi.md

@@ -0,0 +1,238 @@
+# Zyphr::AuthPasswordResetApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**forgot_password**](AuthPasswordResetApi.md#forgot_password) | **POST** /auth/forgot-password | Request a password reset |
+| [**reset_end_user_password**](AuthPasswordResetApi.md#reset_end_user_password) | **POST** /auth/reset-password | Reset password |
+| [**validate_reset_token**](AuthPasswordResetApi.md#validate_reset_token) | **POST** /auth/validate-reset-token | Validate a password reset token |
+
+
+## forgot_password
+
+> <SuccessResult> forgot_password(forgot_password_request)
+
+Request a password reset
+
+Request a password reset email. Creates a reset token and sends an email to the user. Always returns success to prevent email enumeration.
+
+### 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::AuthPasswordResetApi.new
+forgot_password_request = Zyphr::ForgotPasswordRequest.new({email: 'email_example'}) # ForgotPasswordRequest | 
+
+begin
+  # Request a password reset
+  result = api_instance.forgot_password(forgot_password_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPasswordResetApi->forgot_password: #{e}"
+end
+```
+
+#### Using the forgot_password_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResult>, Integer, Hash)> forgot_password_with_http_info(forgot_password_request)
+
+```ruby
+begin
+  # Request a password reset
+  data, status_code, headers = api_instance.forgot_password_with_http_info(forgot_password_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResult>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPasswordResetApi->forgot_password_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **forgot_password_request** | [**ForgotPasswordRequest**](ForgotPasswordRequest.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
+
+
+## reset_end_user_password
+
+> <ResetPasswordResponse> reset_end_user_password(reset_password_request)
+
+Reset password
+
+Reset a user's password using a valid reset token.
+
+### 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::AuthPasswordResetApi.new
+reset_password_request = Zyphr::ResetPasswordRequest.new({token: 'token_example', new_password: 'new_password_example'}) # ResetPasswordRequest | 
+
+begin
+  # Reset password
+  result = api_instance.reset_end_user_password(reset_password_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPasswordResetApi->reset_end_user_password: #{e}"
+end
+```
+
+#### Using the reset_end_user_password_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResetPasswordResponse>, Integer, Hash)> reset_end_user_password_with_http_info(reset_password_request)
+
+```ruby
+begin
+  # Reset password
+  data, status_code, headers = api_instance.reset_end_user_password_with_http_info(reset_password_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResetPasswordResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPasswordResetApi->reset_end_user_password_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reset_password_request** | [**ResetPasswordRequest**](ResetPasswordRequest.md) |  |  |
+
+### Return type
+
+[**ResetPasswordResponse**](ResetPasswordResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## validate_reset_token
+
+> <ValidateResetTokenResponse> validate_reset_token(validate_reset_token_request)
+
+Validate a password reset token
+
+Validate a password reset token without consuming it. Useful for checking if a token is valid before showing the reset form.
+
+### 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::AuthPasswordResetApi.new
+validate_reset_token_request = Zyphr::ValidateResetTokenRequest.new({token: 'token_example'}) # ValidateResetTokenRequest | 
+
+begin
+  # Validate a password reset token
+  result = api_instance.validate_reset_token(validate_reset_token_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPasswordResetApi->validate_reset_token: #{e}"
+end
+```
+
+#### Using the validate_reset_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ValidateResetTokenResponse>, Integer, Hash)> validate_reset_token_with_http_info(validate_reset_token_request)
+
+```ruby
+begin
+  # Validate a password reset token
+  data, status_code, headers = api_instance.validate_reset_token_with_http_info(validate_reset_token_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ValidateResetTokenResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPasswordResetApi->validate_reset_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **validate_reset_token_request** | [**ValidateResetTokenRequest**](ValidateResetTokenRequest.md) |  |  |
+
+### Return type
+
+[**ValidateResetTokenResponse**](ValidateResetTokenResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AuthPhoneApi.md

@@ -0,0 +1,384 @@
+# Zyphr::AuthPhoneApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_phone_auth_availability**](AuthPhoneApi.md#check_phone_auth_availability) | **GET** /auth/phone/available | Check phone auth availability |
+| [**send_phone_login_otp**](AuthPhoneApi.md#send_phone_login_otp) | **POST** /auth/phone/login/send | Send phone login OTP |
+| [**send_phone_registration_otp**](AuthPhoneApi.md#send_phone_registration_otp) | **POST** /auth/phone/register/send | Send phone registration OTP |
+| [**verify_phone_login**](AuthPhoneApi.md#verify_phone_login) | **POST** /auth/phone/login/verify | Verify phone login OTP |
+| [**verify_phone_registration**](AuthPhoneApi.md#verify_phone_registration) | **POST** /auth/phone/register/verify | Verify phone registration OTP |
+
+
+## check_phone_auth_availability
+
+> <PhoneAuthAvailabilityResponse> check_phone_auth_availability
+
+Check phone auth availability
+
+Check if phone authentication is available for this application. Requires Twilio credentials to be configured.
+
+### Examples
+
+```ruby
+require 'time'
+require 'zyphr'
+# setup authorization
+Zyphr.configure do |config|
+  # 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::AuthPhoneApi.new
+
+begin
+  # Check phone auth availability
+  result = api_instance.check_phone_auth_availability
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->check_phone_auth_availability: #{e}"
+end
+```
+
+#### Using the check_phone_auth_availability_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneAuthAvailabilityResponse>, Integer, Hash)> check_phone_auth_availability_with_http_info
+
+```ruby
+begin
+  # Check phone auth availability
+  data, status_code, headers = api_instance.check_phone_auth_availability_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneAuthAvailabilityResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->check_phone_auth_availability_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PhoneAuthAvailabilityResponse**](PhoneAuthAvailabilityResponse.md)
+
+### Authorization
+
+[ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## send_phone_login_otp
+
+> <PhoneOtpSentResponse> send_phone_login_otp(phone_otp_send_request)
+
+Send phone login OTP
+
+Send an OTP to a phone number for an existing user login.
+
+### 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::AuthPhoneApi.new
+phone_otp_send_request = Zyphr::PhoneOtpSendRequest.new({phone_number: '+15551234567'}) # PhoneOtpSendRequest | 
+
+begin
+  # Send phone login OTP
+  result = api_instance.send_phone_login_otp(phone_otp_send_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->send_phone_login_otp: #{e}"
+end
+```
+
+#### Using the send_phone_login_otp_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneOtpSentResponse>, Integer, Hash)> send_phone_login_otp_with_http_info(phone_otp_send_request)
+
+```ruby
+begin
+  # Send phone login OTP
+  data, status_code, headers = api_instance.send_phone_login_otp_with_http_info(phone_otp_send_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneOtpSentResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->send_phone_login_otp_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_otp_send_request** | [**PhoneOtpSendRequest**](PhoneOtpSendRequest.md) |  |  |
+
+### Return type
+
+[**PhoneOtpSentResponse**](PhoneOtpSentResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_phone_registration_otp
+
+> <PhoneOtpSentResponse> send_phone_registration_otp(phone_otp_send_request)
+
+Send phone registration OTP
+
+Send an OTP to a phone number for new user registration.
+
+### 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::AuthPhoneApi.new
+phone_otp_send_request = Zyphr::PhoneOtpSendRequest.new({phone_number: '+15551234567'}) # PhoneOtpSendRequest | 
+
+begin
+  # Send phone registration OTP
+  result = api_instance.send_phone_registration_otp(phone_otp_send_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->send_phone_registration_otp: #{e}"
+end
+```
+
+#### Using the send_phone_registration_otp_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneOtpSentResponse>, Integer, Hash)> send_phone_registration_otp_with_http_info(phone_otp_send_request)
+
+```ruby
+begin
+  # Send phone registration OTP
+  data, status_code, headers = api_instance.send_phone_registration_otp_with_http_info(phone_otp_send_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneOtpSentResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->send_phone_registration_otp_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_otp_send_request** | [**PhoneOtpSendRequest**](PhoneOtpSendRequest.md) |  |  |
+
+### Return type
+
+[**PhoneOtpSentResponse**](PhoneOtpSentResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_phone_login
+
+> <AuthLoginResponse> verify_phone_login(phone_login_verify_request)
+
+Verify phone login OTP
+
+Verify the OTP and login an existing user. If MFA is enabled, returns mfa_required with a challenge token.
+
+### 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::AuthPhoneApi.new
+phone_login_verify_request = Zyphr::PhoneLoginVerifyRequest.new({phone_number: 'phone_number_example', code: 'code_example'}) # PhoneLoginVerifyRequest | 
+
+begin
+  # Verify phone login OTP
+  result = api_instance.verify_phone_login(phone_login_verify_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->verify_phone_login: #{e}"
+end
+```
+
+#### Using the verify_phone_login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthLoginResponse>, Integer, Hash)> verify_phone_login_with_http_info(phone_login_verify_request)
+
+```ruby
+begin
+  # Verify phone login OTP
+  data, status_code, headers = api_instance.verify_phone_login_with_http_info(phone_login_verify_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthLoginResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->verify_phone_login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_login_verify_request** | [**PhoneLoginVerifyRequest**](PhoneLoginVerifyRequest.md) |  |  |
+
+### Return type
+
+[**AuthLoginResponse**](AuthLoginResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## verify_phone_registration
+
+> <AuthResultResponse> verify_phone_registration(phone_register_verify_request)
+
+Verify phone registration OTP
+
+Verify the OTP and create a new user account with the phone number.
+
+### 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::AuthPhoneApi.new
+phone_register_verify_request = Zyphr::PhoneRegisterVerifyRequest.new({phone_number: 'phone_number_example', code: 'code_example'}) # PhoneRegisterVerifyRequest | 
+
+begin
+  # Verify phone registration OTP
+  result = api_instance.verify_phone_registration(phone_register_verify_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->verify_phone_registration: #{e}"
+end
+```
+
+#### Using the verify_phone_registration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResultResponse>, Integer, Hash)> verify_phone_registration_with_http_info(phone_register_verify_request)
+
+```ruby
+begin
+  # Verify phone registration OTP
+  data, status_code, headers = api_instance.verify_phone_registration_with_http_info(phone_register_verify_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResultResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthPhoneApi->verify_phone_registration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_register_verify_request** | [**PhoneRegisterVerifyRequest**](PhoneRegisterVerifyRequest.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
+

data/docs/AuthRegistrationApi.md

@@ -0,0 +1,84 @@
+# Zyphr::AuthRegistrationApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**register_end_user**](AuthRegistrationApi.md#register_end_user) | **POST** /auth/users/register | Register a new end user |
+
+
+## register_end_user
+
+> <AuthResultResponse> register_end_user(register_request)
+
+Register a new end user
+
+Register a new end user with email and password.
+
+### 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::AuthRegistrationApi.new
+register_request = Zyphr::RegisterRequest.new({email: 'email_example', password: 'password_example'}) # RegisterRequest | 
+
+begin
+  # Register a new end user
+  result = api_instance.register_end_user(register_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthRegistrationApi->register_end_user: #{e}"
+end
+```
+
+#### Using the register_end_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResultResponse>, Integer, Hash)> register_end_user_with_http_info(register_request)
+
+```ruby
+begin
+  # Register a new end user
+  data, status_code, headers = api_instance.register_end_user_with_http_info(register_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResultResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthRegistrationApi->register_end_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **register_request** | [**RegisterRequest**](RegisterRequest.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
+