zyphr 0.1.0

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/AddTopicSubscribersRequest.md

@@ -0,0 +1,20 @@
+# Zyphr::AddTopicSubscribersRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscriber_ids** | **Array<String>** | Array of subscriber IDs to add |  |
+| **metadata** | **Object** | Optional metadata to associate with the subscriptions | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::AddTopicSubscribersRequest.new(
+  subscriber_ids: null,
+  metadata: null
+)
+```
+

data/docs/ApiError.md

@@ -0,0 +1,20 @@
+# Zyphr::ApiError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ApiErrorError**](ApiErrorError.md) |  |  |
+| **meta** | [**ApiErrorMeta**](ApiErrorMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ApiError.new(
+  error: null,
+  meta: null
+)
+```
+

data/docs/ApiErrorError.md

@@ -0,0 +1,22 @@
+# Zyphr::ApiErrorError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **message** | **String** |  |  |
+| **details** | **Hash<String, Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ApiErrorError.new(
+  code: validation_error,
+  message: Invalid request body,
+  details: null
+)
+```
+

data/docs/ApiErrorMeta.md

@@ -0,0 +1,18 @@
+# Zyphr::ApiErrorMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **request_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::ApiErrorMeta.new(
+  request_id: req_abc123
+)
+```
+

data/docs/AuthEmailVerificationApi.md

@@ -0,0 +1,248 @@
+# Zyphr::AuthEmailVerificationApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**confirm_email_verification**](AuthEmailVerificationApi.md#confirm_email_verification) | **POST** /auth/verify-email/confirm | Confirm email verification |
+| [**resend_email_verification**](AuthEmailVerificationApi.md#resend_email_verification) | **POST** /auth/verify-email/resend | Resend email verification |
+| [**send_email_verification**](AuthEmailVerificationApi.md#send_email_verification) | **POST** /auth/verify-email/send | Send email verification |
+
+
+## confirm_email_verification
+
+> <ConfirmEmailVerificationResponse> confirm_email_verification(confirm_email_verification_request)
+
+Confirm email verification
+
+Verify the user's email using the token from the verification email.
+
+### 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::AuthEmailVerificationApi.new
+confirm_email_verification_request = Zyphr::ConfirmEmailVerificationRequest.new({token: 'token_example'}) # ConfirmEmailVerificationRequest | 
+
+begin
+  # Confirm email verification
+  result = api_instance.confirm_email_verification(confirm_email_verification_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailVerificationApi->confirm_email_verification: #{e}"
+end
+```
+
+#### Using the confirm_email_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ConfirmEmailVerificationResponse>, Integer, Hash)> confirm_email_verification_with_http_info(confirm_email_verification_request)
+
+```ruby
+begin
+  # Confirm email verification
+  data, status_code, headers = api_instance.confirm_email_verification_with_http_info(confirm_email_verification_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ConfirmEmailVerificationResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailVerificationApi->confirm_email_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **confirm_email_verification_request** | [**ConfirmEmailVerificationRequest**](ConfirmEmailVerificationRequest.md) |  |  |
+
+### Return type
+
+[**ConfirmEmailVerificationResponse**](ConfirmEmailVerificationResponse.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## resend_email_verification
+
+> <SuccessResult> resend_email_verification(opts)
+
+Resend email verification
+
+Resend the verification email to the authenticated user. Rate limited to once per 60 seconds.
+
+### 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 Bearer authorization (JWT): EndUserToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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::AuthEmailVerificationApi.new
+opts = {
+  send_email_verification_request: Zyphr::SendEmailVerificationRequest.new # SendEmailVerificationRequest | 
+}
+
+begin
+  # Resend email verification
+  result = api_instance.resend_email_verification(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailVerificationApi->resend_email_verification: #{e}"
+end
+```
+
+#### Using the resend_email_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResult>, Integer, Hash)> resend_email_verification_with_http_info(opts)
+
+```ruby
+begin
+  # Resend email verification
+  data, status_code, headers = api_instance.resend_email_verification_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResult>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailVerificationApi->resend_email_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_email_verification_request** | [**SendEmailVerificationRequest**](SendEmailVerificationRequest.md) |  | [optional] |
+
+### Return type
+
+[**SuccessResult**](SuccessResult.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [EndUserToken](../README.md#EndUserToken), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_email_verification
+
+> <SuccessResult> send_email_verification(opts)
+
+Send email verification
+
+Send an email verification link to the authenticated 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 Bearer authorization (JWT): EndUserToken
+  config.access_token = 'YOUR_BEARER_TOKEN'
+
+  # 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::AuthEmailVerificationApi.new
+opts = {
+  send_email_verification_request: Zyphr::SendEmailVerificationRequest.new # SendEmailVerificationRequest | 
+}
+
+begin
+  # Send email verification
+  result = api_instance.send_email_verification(opts)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailVerificationApi->send_email_verification: #{e}"
+end
+```
+
+#### Using the send_email_verification_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SuccessResult>, Integer, Hash)> send_email_verification_with_http_info(opts)
+
+```ruby
+begin
+  # Send email verification
+  data, status_code, headers = api_instance.send_email_verification_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SuccessResult>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthEmailVerificationApi->send_email_verification_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **send_email_verification_request** | [**SendEmailVerificationRequest**](SendEmailVerificationRequest.md) |  | [optional] |
+
+### Return type
+
+[**SuccessResult**](SuccessResult.md)
+
+### Authorization
+
+[ApplicationSecret](../README.md#ApplicationSecret), [EndUserToken](../README.md#EndUserToken), [ApplicationPublicKey](../README.md#ApplicationPublicKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/AuthLoginApi.md

@@ -0,0 +1,84 @@
+# Zyphr::AuthLoginApi
+
+All URIs are relative to *https://api.zyphr.dev/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**login_end_user**](AuthLoginApi.md#login_end_user) | **POST** /auth/users/login | Login end user |
+
+
+## login_end_user
+
+> <AuthLoginResponse> login_end_user(login_request)
+
+Login end user
+
+Login end user with email and password. Accepts optional custom_claims to embed in JWT (max 4KB). If MFA is enabled for the user, returns mfa_required: true with a challenge token. The user must then call POST /v1/auth/mfa/verify with the challenge token and TOTP code. 
+
+### 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::AuthLoginApi.new
+login_request = Zyphr::LoginRequest.new({email: 'email_example', password: 'password_example'}) # LoginRequest | 
+
+begin
+  # Login end user
+  result = api_instance.login_end_user(login_request)
+  p result
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthLoginApi->login_end_user: #{e}"
+end
+```
+
+#### Using the login_end_user_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthLoginResponse>, Integer, Hash)> login_end_user_with_http_info(login_request)
+
+```ruby
+begin
+  # Login end user
+  data, status_code, headers = api_instance.login_end_user_with_http_info(login_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthLoginResponse>
+rescue Zyphr::ApiError => e
+  puts "Error when calling AuthLoginApi->login_end_user_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **login_request** | [**LoginRequest**](LoginRequest.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
+

data/docs/AuthLoginResponse.md

@@ -0,0 +1,20 @@
+# Zyphr::AuthLoginResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**AuthLoginResult**](AuthLoginResult.md) |  | [optional] |
+| **meta** | [**RequestMeta**](RequestMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::AuthLoginResponse.new(
+  data: null,
+  meta: null
+)
+```
+

data/docs/AuthLoginResult.md

@@ -0,0 +1,24 @@
+# Zyphr::AuthLoginResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mfa_required** | **Boolean** |  | [optional] |
+| **user** | [**AuthUser**](AuthUser.md) |  | [optional] |
+| **tokens** | [**AuthTokens**](AuthTokens.md) |  | [optional] |
+| **mfa_challenge** | [**AuthLoginResultMfaChallenge**](AuthLoginResultMfaChallenge.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::AuthLoginResult.new(
+  mfa_required: null,
+  user: null,
+  tokens: null,
+  mfa_challenge: null
+)
+```
+

data/docs/AuthLoginResultMfaChallenge.md

@@ -0,0 +1,20 @@
+# Zyphr::AuthLoginResultMfaChallenge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'zyphr'
+
+instance = Zyphr::AuthLoginResultMfaChallenge.new(
+  token: null,
+  expires_at: null
+)
+```
+