zyphr 0.1.34 → 0.1.36

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f36ed1222d5a3811592b282181dd2f67143e4740fbfe7de4d18df12191ea3850
-  data.tar.gz: 43f947c3f31db15a223c7413363a94c0c0bbf161e59917d648fe56030031fe35
+  metadata.gz: b0067ad17150f659eb4ef54057a18ad5f7a92e1d764548ab45fbe31dd782928a
+  data.tar.gz: 7b22a003289b965f16f30d233a346ae5ae5aaf3a6f1367dc828cd6a5f0bf8eb5
 SHA512:
-  metadata.gz: 9475d1b9bd76ebb758d05850dd196872e08735851fa0ea4cb4ad2ee8860320083411a4d09c0ca2a006770e34f321ed93e936fbc6063731368a5144ac23277fe5
-  data.tar.gz: 0562256d9740f5f67df0facd9d401aed1e7de28e99e43b2124f7cca0dcd78ff6d8d063d486791efb1354294ef0558b34159d88da9c89e71e5f597e1227ac24e7
+  metadata.gz: 84c95f09224c4d7de78be1df8cd3225dbb44e04275fd83089a17e0c44c52325895d39b8747e15c574c007907c59a969c8fce250e5817c39c09aeae5c21e29786
+  data.tar.gz: 3445f3a9cfbbe02b737e73c287265ee893ead08f168d54d62ac54833bc8e3e46614507c38667ba8db63956139f5d57390d5274ff52bee88eac6afd33a3c9ad3e

data/README.md

@@ -95,13 +95,6 @@ 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 faraday connection
-  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
-
   # 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)
@@ -110,15 +103,14 @@ Zyphr.configure do |config|
   config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
 end
 
-api_instance = Zyphr::AuthEmailTemplatesApi.new
-bulk_upsert_auth_email_templates_request = Zyphr::BulkUpsertAuthEmailTemplatesRequest.new # BulkUpsertAuthEmailTemplatesRequest | 
+api_instance = Zyphr::AuthEmailOTPApi.new
 
 begin
-  #Bulk-upsert auth email templates
-  result = api_instance.bulk_upsert_auth_email_templates(bulk_upsert_auth_email_templates_request)
+  #Check email OTP availability
+  result = api_instance.check_email_otp_availability
   p result
 rescue Zyphr::ApiError => e
-  puts "Exception when calling AuthEmailTemplatesApi->bulk_upsert_auth_email_templates: #{e}"
+  puts "Exception when calling AuthEmailOTPApi->check_email_otp_availability: #{e}"
 end
 
 ```
@@ -129,6 +121,11 @@ All URIs are relative to *https://api.zyphr.dev/v1*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*Zyphr::AuthEmailOTPApi* | [**check_email_otp_availability**](docs/AuthEmailOTPApi.md#check_email_otp_availability) | **GET** /auth/email-otp/available | Check email OTP availability
+*Zyphr::AuthEmailOTPApi* | [**send_email_otp_login**](docs/AuthEmailOTPApi.md#send_email_otp_login) | **POST** /auth/email-otp/login/send | Send email OTP for login
+*Zyphr::AuthEmailOTPApi* | [**send_email_otp_registration**](docs/AuthEmailOTPApi.md#send_email_otp_registration) | **POST** /auth/email-otp/register/send | Send email OTP for registration
+*Zyphr::AuthEmailOTPApi* | [**verify_email_otp_login**](docs/AuthEmailOTPApi.md#verify_email_otp_login) | **POST** /auth/email-otp/login/verify | Verify email OTP login
+*Zyphr::AuthEmailOTPApi* | [**verify_email_otp_registration**](docs/AuthEmailOTPApi.md#verify_email_otp_registration) | **POST** /auth/email-otp/register/verify | Verify email OTP registration
 *Zyphr::AuthEmailTemplatesApi* | [**bulk_upsert_auth_email_templates**](docs/AuthEmailTemplatesApi.md#bulk_upsert_auth_email_templates) | **PUT** /auth/email-templates | Bulk-upsert auth email templates
 *Zyphr::AuthEmailTemplatesApi* | [**delete_auth_email_template**](docs/AuthEmailTemplatesApi.md#delete_auth_email_template) | **DELETE** /auth/email-templates/{type} | Remove a tenant override
 *Zyphr::AuthEmailTemplatesApi* | [**get_auth_email_template**](docs/AuthEmailTemplatesApi.md#get_auth_email_template) | **GET** /auth/email-templates/{type} | Get an auth email template
@@ -609,6 +606,7 @@ Class | Method | HTTP request | Description
  - [Zyphr::SendBatchSmsData](docs/SendBatchSmsData.md)
  - [Zyphr::SendBatchSmsRequest](docs/SendBatchSmsRequest.md)
  - [Zyphr::SendBatchSmsResponse](docs/SendBatchSmsResponse.md)
+ - [Zyphr::SendEmailOtpRegistrationRequest](docs/SendEmailOtpRegistrationRequest.md)
  - [Zyphr::SendEmailRequest](docs/SendEmailRequest.md)
  - [Zyphr::SendEmailResponse](docs/SendEmailResponse.md)
  - [Zyphr::SendEmailResponseData](docs/SendEmailResponseData.md)
@@ -720,6 +718,8 @@ Class | Method | HTTP request | Description
  - [Zyphr::VerificationStatusResponseData](docs/VerificationStatusResponseData.md)
  - [Zyphr::VerifyDomainResponse](docs/VerifyDomainResponse.md)
  - [Zyphr::VerifyDomainResponseData](docs/VerifyDomainResponseData.md)
+ - [Zyphr::VerifyEmailOtpLoginRequest](docs/VerifyEmailOtpLoginRequest.md)
+ - [Zyphr::VerifyEmailOtpRegistrationRequest](docs/VerifyEmailOtpRegistrationRequest.md)
  - [Zyphr::VerifySmsConfigData](docs/VerifySmsConfigData.md)
  - [Zyphr::VerifySmsConfigResponse](docs/VerifySmsConfigResponse.md)
  - [Zyphr::WaaSApplication](docs/WaaSApplication.md)

data/docs/AuthEmailOTPApi.md

@@ -0,0 +1,384 @@
+# Zyphr::AuthEmailOTPApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**check_email_otp_availability**](AuthEmailOTPApi.md#check_email_otp_availability) | **GET** /auth/email-otp/available | Check email OTP availability |
+| [**send_email_otp_login**](AuthEmailOTPApi.md#send_email_otp_login) | **POST** /auth/email-otp/login/send | Send email OTP for login |
+| [**send_email_otp_registration**](AuthEmailOTPApi.md#send_email_otp_registration) | **POST** /auth/email-otp/register/send | Send email OTP for registration |
+| [**verify_email_otp_login**](AuthEmailOTPApi.md#verify_email_otp_login) | **POST** /auth/email-otp/login/verify | Verify email OTP login |
+| [**verify_email_otp_registration**](AuthEmailOTPApi.md#verify_email_otp_registration) | **POST** /auth/email-otp/register/verify | Verify email OTP registration |
+
+
+## check_email_otp_availability
+
+> <PhoneAuthAvailabilityResponse> check_email_otp_availability
+
+Check email OTP availability
+
+Check if numeric email OTP authentication is available for this application. Requires a verified sending domain on the project.
+
+### 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::AuthEmailOTPApi.new
+
+begin
+  # Check email OTP availability
+  result = api_instance.check_email_otp_availability
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->check_email_otp_availability: #{e}"
+end
+```
+
+#### Using the check_email_otp_availability_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneAuthAvailabilityResponse>, Integer, Hash)> check_email_otp_availability_with_http_info
+
+```ruby
+begin
+  # Check email OTP availability
+  data, status_code, headers = api_instance.check_email_otp_availability_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneAuthAvailabilityResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->check_email_otp_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_email_otp_login
+
+> <PhoneOtpSentResponse> send_email_otp_login(send_email_otp_registration_request)
+
+Send email OTP for login
+
+Send a numeric verification code to an existing user's email address for 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::AuthEmailOTPApi.new
+send_email_otp_registration_request = Zyphr::SendEmailOtpRegistrationRequest.new({email: 'email_example'}) # SendEmailOtpRegistrationRequest | 
+
+begin
+  # Send email OTP for login
+  result = api_instance.send_email_otp_login(send_email_otp_registration_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->send_email_otp_login: #{e}"
+end
+```
+
+#### Using the send_email_otp_login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneOtpSentResponse>, Integer, Hash)> send_email_otp_login_with_http_info(send_email_otp_registration_request)
+
+```ruby
+begin
+  # Send email OTP for login
+  data, status_code, headers = api_instance.send_email_otp_login_with_http_info(send_email_otp_registration_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneOtpSentResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->send_email_otp_login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_email_otp_registration_request** | [**SendEmailOtpRegistrationRequest**](SendEmailOtpRegistrationRequest.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_email_otp_registration
+
+> <PhoneOtpSentResponse> send_email_otp_registration(send_email_otp_registration_request)
+
+Send email OTP for registration
+
+Send a numeric verification code to an email address 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::AuthEmailOTPApi.new
+send_email_otp_registration_request = Zyphr::SendEmailOtpRegistrationRequest.new({email: 'email_example'}) # SendEmailOtpRegistrationRequest | 
+
+begin
+  # Send email OTP for registration
+  result = api_instance.send_email_otp_registration(send_email_otp_registration_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->send_email_otp_registration: #{e}"
+end
+```
+
+#### Using the send_email_otp_registration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PhoneOtpSentResponse>, Integer, Hash)> send_email_otp_registration_with_http_info(send_email_otp_registration_request)
+
+```ruby
+begin
+  # Send email OTP for registration
+  data, status_code, headers = api_instance.send_email_otp_registration_with_http_info(send_email_otp_registration_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PhoneOtpSentResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->send_email_otp_registration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_email_otp_registration_request** | [**SendEmailOtpRegistrationRequest**](SendEmailOtpRegistrationRequest.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_email_otp_login
+
+> <AuthLoginResponse> verify_email_otp_login(verify_email_otp_login_request)
+
+Verify email OTP login
+
+Verify the numeric code 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::AuthEmailOTPApi.new
+verify_email_otp_login_request = Zyphr::VerifyEmailOtpLoginRequest.new({email: 'email_example', code: 'code_example'}) # VerifyEmailOtpLoginRequest | 
+
+begin
+  # Verify email OTP login
+  result = api_instance.verify_email_otp_login(verify_email_otp_login_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->verify_email_otp_login: #{e}"
+end
+```
+
+#### Using the verify_email_otp_login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthLoginResponse>, Integer, Hash)> verify_email_otp_login_with_http_info(verify_email_otp_login_request)
+
+```ruby
+begin
+  # Verify email OTP login
+  data, status_code, headers = api_instance.verify_email_otp_login_with_http_info(verify_email_otp_login_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthLoginResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->verify_email_otp_login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verify_email_otp_login_request** | [**VerifyEmailOtpLoginRequest**](VerifyEmailOtpLoginRequest.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_email_otp_registration
+
+> <AuthResultResponse> verify_email_otp_registration(verify_email_otp_registration_request)
+
+Verify email OTP registration
+
+Verify the numeric code and create a new user account with the email address.
+
+### 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::AuthEmailOTPApi.new
+verify_email_otp_registration_request = Zyphr::VerifyEmailOtpRegistrationRequest.new({email: 'email_example', code: 'code_example'}) # VerifyEmailOtpRegistrationRequest | 
+
+begin
+  # Verify email OTP registration
+  result = api_instance.verify_email_otp_registration(verify_email_otp_registration_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->verify_email_otp_registration: #{e}"
+end
+```
+
+#### Using the verify_email_otp_registration_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthResultResponse>, Integer, Hash)> verify_email_otp_registration_with_http_info(verify_email_otp_registration_request)
+
+```ruby
+begin
+  # Verify email OTP registration
+  data, status_code, headers = api_instance.verify_email_otp_registration_with_http_info(verify_email_otp_registration_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthResultResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailOTPApi->verify_email_otp_registration_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verify_email_otp_registration_request** | [**VerifyEmailOtpRegistrationRequest**](VerifyEmailOtpRegistrationRequest.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/SendEmailOtpRegistrationRequest.md

@@ -0,0 +1,18 @@
+# Zyphr::SendEmailOtpRegistrationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::SendEmailOtpRegistrationRequest.new(
+  email: null
+)
+```
+

data/docs/VerifyEmailOtpLoginRequest.md

@@ -0,0 +1,22 @@
+# Zyphr::VerifyEmailOtpLoginRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **code** | **String** |  |  |
+| **custom_claims** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::VerifyEmailOtpLoginRequest.new(
+  email: null,
+  code: null,
+  custom_claims: null
+)
+```
+

data/docs/VerifyEmailOtpRegistrationRequest.md

@@ -0,0 +1,24 @@
+# Zyphr::VerifyEmailOtpRegistrationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **code** | **String** |  |  |
+| **name** | **String** |  | [optional] |
+| **metadata** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::VerifyEmailOtpRegistrationRequest.new(
+  email: null,
+  code: null,
+  name: null,
+  metadata: null
+)
+```
+