telvri_security 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e6650b740eff6625789231b8409450339e67a929a57bef5c91dc588d9a6ab24b
+  data.tar.gz: a2f1cd60dd0cda77f071f4714fd4789e71b08600ccbacacfa9677c90ad1a5bed
+SHA512:
+  metadata.gz: 8f07c1af6d82088f92aff09d261b7d254b9a17560f46eaacf176b5fc108d7bf61efc087fadd0d0e5440df6378871abd9f89423d568bad1bb11da08200a3f4e24
+  data.tar.gz: 0b94794033fa5bf0263589e85e83deb2b5601900b48dae509cb4b0d107404eefc978118152815a218d3f8e100a9573385852a4a87192a21744960aa27af6f8ba

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Telvri Security
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# telvri-ruby
+
+Official Ruby SDK for the [Telvri Security API](https://telvrisecurity.vercel.app) — real-time SIM-swap and mobile identity risk checks for login recovery, payouts, and wallet protection.
+
+## Install
+
+### From GitHub (works now)
+
+In your `Gemfile`:
+
+```ruby
+gem 'telvri_security', git: 'https://github.com/Granville-Christopher/telvri-ruby', tag: 'v1.0.0'
+```
+
+Then:
+
+```bash
+bundle install
+```
+
+Requires Ruby 2.7+.
+
+### RubyGems (after publish)
+
+```bash
+gem install telvri_security
+```
+
+Or in your `Gemfile`:
+
+```ruby
+gem 'telvri_security', '~> 1.0.0'
+```
+
+## Quick start — SIM-swap check
+
+```ruby
+require 'telvri_security'
+
+TelvriSecurity.configure do |config|
+  config.api_key['X-API-Key'] = ENV.fetch('TELVRI_API_KEY')
+end
+
+api = TelvriSecurity::SIMSwapIntelligenceApi.new
+dto = TelvriSecurity::CheckSimSwapDto.new(
+  phone_number: '+2348031234569',
+  max_age_hours: 24
+)
+
+result = api.sim_swap_controller_check_sim_swap(dto)
+
+puts "swapped=#{result.swapped} provider=#{result.provider} operator=#{result.operator}"
+```
+
+Set your key first:
+
+```bash
+export TELVRI_API_KEY=rt_live_your_api_key
+```
+
+## API reference
+
+All URIs are relative to `https://telvrisecurity.vercel.app`.
+
+| Class | Method | HTTP request | Description |
+|-------|--------|--------------|-------------|
+| `SIMSwapIntelligenceApi` | `sim_swap_controller_check_sim_swap` | `POST /v1/security/sim-check` | Run a real-time SIM-swap risk check |
+| `DeveloperAuthApi` | `auth_controller_login` | `POST /auth/login` | Authenticate a developer account |
+| `DeveloperAuthApi` | `auth_controller_signup` | `POST /auth/signup` | Create a developer account |
+
+### Models
+
+- `CheckSimSwapDto`
+- `SimSwapResponseDto`
+- `LoginDto`
+- `SignupDto`
+
+Full per-method and per-model docs are in the [`docs/`](./docs) folder.
+
+## Development
+
+This SDK is generated from the Telvri Security OpenAPI contract using [OpenAPI Generator](https://openapi-generator.tech). To regenerate from the API project:
+
+```bash
+npm run sdk:fetch-spec
+npm run sdk:generate:ruby
+```
+
+- API version: `1.0`
+- Gem version: `1.0.0`
+- Gem name: `telvri_security`
+- Module: `TelvriSecurity`
+
+## License
+
+MIT — see [LICENSE](./LICENSE).

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/CheckSimSwapDto.md

@@ -0,0 +1,20 @@
+# TelvriSecurity::CheckSimSwapDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Subscriber phone number in strict E.164 format. Supports global numbering plans (e.g. +1 US, +49 DE, +234 NG Airtel/MTN). |  |
+| **max_age_hours** | **Float** | Maximum acceptable age, in hours, for SIM-swap intelligence. | [optional][default to 24] |
+
+## Example
+
+```ruby
+require 'telvri_security'
+
+instance = TelvriSecurity::CheckSimSwapDto.new(
+  phone_number: +2348021234567,
+  max_age_hours: 24
+)
+```
+

data/docs/DeveloperAuthApi.md

@@ -0,0 +1,206 @@
+# TelvriSecurity::DeveloperAuthApi
+
+All URIs are relative to *https://telvrisecurity.vercel.app*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**auth_controller_login**](DeveloperAuthApi.md#auth_controller_login) | **POST** /auth/login | Authenticate a developer account |
+| [**auth_controller_logout**](DeveloperAuthApi.md#auth_controller_logout) | **POST** /auth/logout | Sign out of the developer dashboard |
+| [**auth_controller_signup**](DeveloperAuthApi.md#auth_controller_signup) | **POST** /auth/signup | Create a developer account |
+
+
+## auth_controller_login
+
+> auth_controller_login(email, password)
+
+Authenticate a developer account
+
+Accepts login credentials and redirects to the dashboard on success.
+
+### Examples
+
+```ruby
+require 'time'
+require 'telvri_security'
+
+api_instance = TelvriSecurity::DeveloperAuthApi.new
+email = 'email_example' # String | Developer account email address.
+password = 'password_example' # String | Account password.
+
+begin
+  # Authenticate a developer account
+  api_instance.auth_controller_login(email, password)
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling DeveloperAuthApi->auth_controller_login: #{e}"
+end
+```
+
+#### Using the auth_controller_login_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> auth_controller_login_with_http_info(email, password)
+
+```ruby
+begin
+  # Authenticate a developer account
+  data, status_code, headers = api_instance.auth_controller_login_with_http_info(email, password)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling DeveloperAuthApi->auth_controller_login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Developer account email address. |  |
+| **password** | **String** | Account password. |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, application/json
+- **Accept**: Not defined
+
+
+## auth_controller_logout
+
+> auth_controller_logout
+
+Sign out of the developer dashboard
+
+### Examples
+
+```ruby
+require 'time'
+require 'telvri_security'
+
+api_instance = TelvriSecurity::DeveloperAuthApi.new
+
+begin
+  # Sign out of the developer dashboard
+  api_instance.auth_controller_logout
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling DeveloperAuthApi->auth_controller_logout: #{e}"
+end
+```
+
+#### Using the auth_controller_logout_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> auth_controller_logout_with_http_info
+
+```ruby
+begin
+  # Sign out of the developer dashboard
+  data, status_code, headers = api_instance.auth_controller_logout_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling DeveloperAuthApi->auth_controller_logout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## auth_controller_signup
+
+> auth_controller_signup(full_name, email, password, confirm_password, opts)
+
+Create a developer account
+
+Registers a developer account and redirects to the dashboard on success.
+
+### Examples
+
+```ruby
+require 'time'
+require 'telvri_security'
+
+api_instance = TelvriSecurity::DeveloperAuthApi.new
+full_name = 'full_name_example' # String | Full name for the developer account.
+email = 'email_example' # String | Work email used for dashboard access and API key delivery.
+password = 'password_example' # String | Account password.
+confirm_password = 'confirm_password_example' # String | Password confirmation.
+opts = {
+  company: 'company_example' # String | Company or team name.
+}
+
+begin
+  # Create a developer account
+  api_instance.auth_controller_signup(full_name, email, password, confirm_password, opts)
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling DeveloperAuthApi->auth_controller_signup: #{e}"
+end
+```
+
+#### Using the auth_controller_signup_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> auth_controller_signup_with_http_info(full_name, email, password, confirm_password, opts)
+
+```ruby
+begin
+  # Create a developer account
+  data, status_code, headers = api_instance.auth_controller_signup_with_http_info(full_name, email, password, confirm_password, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling DeveloperAuthApi->auth_controller_signup_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | Full name for the developer account. |  |
+| **email** | **String** | Work email used for dashboard access and API key delivery. |  |
+| **password** | **String** | Account password. |  |
+| **confirm_password** | **String** | Password confirmation. |  |
+| **company** | **String** | Company or team name. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded, application/json
+- **Accept**: Not defined
+

data/docs/LoginDto.md

@@ -0,0 +1,20 @@
+# TelvriSecurity::LoginDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Developer account email address. |  |
+| **password** | **String** | Account password. |  |
+
+## Example
+
+```ruby
+require 'telvri_security'
+
+instance = TelvriSecurity::LoginDto.new(
+  email: dev@telvri.security,
+  password: TelvriSecure123
+)
+```
+

data/docs/SIMSwapIntelligenceApi.md

@@ -0,0 +1,86 @@
+# TelvriSecurity::SIMSwapIntelligenceApi
+
+All URIs are relative to *https://telvrisecurity.vercel.app*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**sim_swap_controller_check_sim_swap**](SIMSwapIntelligenceApi.md#sim_swap_controller_check_sim_swap) | **POST** /v1/security/sim-check | Run a real-time SIM-swap risk check |
+
+
+## sim_swap_controller_check_sim_swap
+
+> <SimSwapResponseDto> sim_swap_controller_check_sim_swap(check_sim_swap_dto, opts)
+
+Run a real-time SIM-swap risk check
+
+Checks a subscriber phone number against mocked global telecom registry intelligence and returns whether recent SIM-swap activity is present. Carrier resolution uses national mobile prefixes worldwide (Nigeria MTN/Airtel/Glo/9mobile, Germany Telekom/Vodafone/O2, US AT&T/T-Mobile/Verizon, UK, India, UAE, and more). Mock rule: numbers ending in 9 report a swap within the last 2 hours.
+
+### Examples
+
+```ruby
+require 'time'
+require 'telvri_security'
+# setup authorization
+TelvriSecurity.configure do |config|
+  # Configure API key authorization: X-API-Key
+  config.api_key['X-API-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-API-Key'] = 'Bearer'
+
+  # Configure Bearer authorization (API Key): Bearer
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TelvriSecurity::SIMSwapIntelligenceApi.new
+check_sim_swap_dto = TelvriSecurity::CheckSimSwapDto.new({phone_number: '+2348021234567'}) # CheckSimSwapDto | 
+opts = {
+  x_api_key: 'x_api_key_example' # String | Developer API key. Alternative: Authorization: Bearer <KEY>.
+}
+
+begin
+  # Run a real-time SIM-swap risk check
+  result = api_instance.sim_swap_controller_check_sim_swap(check_sim_swap_dto, opts)
+  p result
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling SIMSwapIntelligenceApi->sim_swap_controller_check_sim_swap: #{e}"
+end
+```
+
+#### Using the sim_swap_controller_check_sim_swap_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SimSwapResponseDto>, Integer, Hash)> sim_swap_controller_check_sim_swap_with_http_info(check_sim_swap_dto, opts)
+
+```ruby
+begin
+  # Run a real-time SIM-swap risk check
+  data, status_code, headers = api_instance.sim_swap_controller_check_sim_swap_with_http_info(check_sim_swap_dto, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SimSwapResponseDto>
+rescue TelvriSecurity::ApiError => e
+  puts "Error when calling SIMSwapIntelligenceApi->sim_swap_controller_check_sim_swap_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **check_sim_swap_dto** | [**CheckSimSwapDto**](CheckSimSwapDto.md) |  |  |
+| **x_api_key** | **String** | Developer API key. Alternative: Authorization: Bearer &lt;KEY&gt;. | [optional] |
+
+### Return type
+
+[**SimSwapResponseDto**](SimSwapResponseDto.md)
+
+### Authorization
+
+[X-API-Key](../README.md#X-API-Key), [Bearer](../README.md#Bearer)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/SignupDto.md

@@ -0,0 +1,26 @@
+# TelvriSecurity::SignupDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **full_name** | **String** | Full name for the developer account. |  |
+| **email** | **String** | Work email used for dashboard access and API key delivery. |  |
+| **company** | **String** | Company or team name. | [optional] |
+| **password** | **String** | Account password. |  |
+| **confirm_password** | **String** | Password confirmation. |  |
+
+## Example
+
+```ruby
+require 'telvri_security'
+
+instance = TelvriSecurity::SignupDto.new(
+  full_name: Ada Okonkwo,
+  email: ada@fintech.example,
+  company: Northwind Fintech,
+  password: TelvriSecure123,
+  confirm_password: TelvriSecure123
+)
+```
+

data/docs/SimSwapResponseDto.md

@@ -0,0 +1,26 @@
+# TelvriSecurity::SimSwapResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **phone_number** | **String** | Subscriber phone number in E.164 format. |  |
+| **swapped** | **Boolean** | Whether the network registry indicates a recent SIM swap. |  |
+| **last_swapped_at** | **Time** | ISO-8601 timestamp of the most recent SIM-swap signal. | [optional] |
+| **provider** | **String** | Resolved mobile network operator or telecom provider (global prefix catalog). |  |
+| **operator** | **String** | Resolved mobile network operator. Alias retained for telco domain consumers. |  |
+
+## Example
+
+```ruby
+require 'telvri_security'
+
+instance = TelvriSecurity::SimSwapResponseDto.new(
+  phone_number: +2348021234567,
+  swapped: false,
+  last_swapped_at: 2026-07-14T16:27Z,
+  provider: Airtel Nigeria,
+  operator: Airtel Nigeria
+)
+```
+