telvri_security 1.0.0

data/lib/telvri_security/models/sim_swap_response_dto.rb

@@ -0,0 +1,256 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module TelvriSecurity
+  class SimSwapResponseDto < ApiModelBase
+    # Subscriber phone number in E.164 format.
+    attr_accessor :phone_number
+
+    # Whether the network registry indicates a recent SIM swap.
+    attr_accessor :swapped
+
+    # ISO-8601 timestamp of the most recent SIM-swap signal.
+    attr_accessor :last_swapped_at
+
+    # Resolved mobile network operator or telecom provider (global prefix catalog).
+    attr_accessor :provider
+
+    # Resolved mobile network operator. Alias retained for telco domain consumers.
+    attr_accessor :operator
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'phone_number' => :'phoneNumber',
+        :'swapped' => :'swapped',
+        :'last_swapped_at' => :'lastSwappedAt',
+        :'provider' => :'provider',
+        :'operator' => :'operator'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'phone_number' => :'String',
+        :'swapped' => :'Boolean',
+        :'last_swapped_at' => :'Time',
+        :'provider' => :'String',
+        :'operator' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `TelvriSecurity::SimSwapResponseDto` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `TelvriSecurity::SimSwapResponseDto`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'phone_number')
+        self.phone_number = attributes[:'phone_number']
+      else
+        self.phone_number = nil
+      end
+
+      if attributes.key?(:'swapped')
+        self.swapped = attributes[:'swapped']
+      else
+        self.swapped = nil
+      end
+
+      if attributes.key?(:'last_swapped_at')
+        self.last_swapped_at = attributes[:'last_swapped_at']
+      end
+
+      if attributes.key?(:'provider')
+        self.provider = attributes[:'provider']
+      else
+        self.provider = nil
+      end
+
+      if attributes.key?(:'operator')
+        self.operator = attributes[:'operator']
+      else
+        self.operator = nil
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @phone_number.nil?
+        invalid_properties.push('invalid value for "phone_number", phone_number cannot be nil.')
+      end
+
+      if @swapped.nil?
+        invalid_properties.push('invalid value for "swapped", swapped cannot be nil.')
+      end
+
+      if @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @operator.nil?
+        invalid_properties.push('invalid value for "operator", operator cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @phone_number.nil?
+      return false if @swapped.nil?
+      return false if @provider.nil?
+      return false if @operator.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      if phone_number.nil?
+        fail ArgumentError, 'phone_number cannot be nil'
+      end
+
+      @phone_number = phone_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] swapped Value to be assigned
+    def swapped=(swapped)
+      if swapped.nil?
+        fail ArgumentError, 'swapped cannot be nil'
+      end
+
+      @swapped = swapped
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] provider Value to be assigned
+    def provider=(provider)
+      if provider.nil?
+        fail ArgumentError, 'provider cannot be nil'
+      end
+
+      @provider = provider
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] operator Value to be assigned
+    def operator=(operator)
+      if operator.nil?
+        fail ArgumentError, 'operator cannot be nil'
+      end
+
+      @operator = operator
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          phone_number == o.phone_number &&
+          swapped == o.swapped &&
+          last_swapped_at == o.last_swapped_at &&
+          provider == o.provider &&
+          operator == o.operator
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [phone_number, swapped, last_swapped_at, provider, operator].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/telvri_security/version.rb

@@ -0,0 +1,15 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+module TelvriSecurity
+  VERSION = '1.0.0'
+end

data/lib/telvri_security.rb

@@ -0,0 +1,46 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+# Common files
+require 'telvri_security/api_client'
+require 'telvri_security/api_error'
+require 'telvri_security/api_model_base'
+require 'telvri_security/version'
+require 'telvri_security/configuration'
+
+# Models
+require 'telvri_security/models/check_sim_swap_dto'
+require 'telvri_security/models/login_dto'
+require 'telvri_security/models/signup_dto'
+require 'telvri_security/models/sim_swap_response_dto'
+
+# APIs
+require 'telvri_security/api/developer_auth_api'
+require 'telvri_security/api/sim_swap_intelligence_api'
+
+module TelvriSecurity
+  class << self
+    # Customize default settings for the SDK using block.
+    #   TelvriSecurity.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/spec/api/developer_auth_api_spec.rb

@@ -0,0 +1,64 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TelvriSecurity::DeveloperAuthApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'DeveloperAuthApi' do
+  before do
+    # run before each test
+    @api_instance = TelvriSecurity::DeveloperAuthApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DeveloperAuthApi' do
+    it 'should create an instance of DeveloperAuthApi' do
+      expect(@api_instance).to be_instance_of(TelvriSecurity::DeveloperAuthApi)
+    end
+  end
+
+  # unit tests for auth_controller_login
+  # Authenticate a developer account
+  # Accepts login credentials and redirects to the dashboard on success.
+  # @param email Developer account email address.
+  # @param password Account password.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'auth_controller_login test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for auth_controller_signup
+  # Create a developer account
+  # Registers a developer account and redirects to the dashboard on success.
+  # @param full_name Full name for the developer account.
+  # @param email Work email used for dashboard access and API key delivery.
+  # @param password Account password.
+  # @param confirm_password Password confirmation.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :company Company or team name.
+  # @return [nil]
+  describe 'auth_controller_signup test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/api/sim_swap_intelligence_api_spec.rb

@@ -0,0 +1,48 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for TelvriSecurity::SIMSwapIntelligenceApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'SIMSwapIntelligenceApi' do
+  before do
+    # run before each test
+    @api_instance = TelvriSecurity::SIMSwapIntelligenceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of SIMSwapIntelligenceApi' do
+    it 'should create an instance of SIMSwapIntelligenceApi' do
+      expect(@api_instance).to be_instance_of(TelvriSecurity::SIMSwapIntelligenceApi)
+    end
+  end
+
+  # unit tests for sim_swap_controller_check_sim_swap
+  # Run a real-time SIM-swap risk check
+  # Checks a subscriber phone number against mocked telecom registry intelligence and returns whether recent SIM-swap activity is present.
+  # @param check_sim_swap_dto 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :x_api_key Developer API key. Alternative: Authorization: Bearer <KEY>.
+  # @return [SimSwapResponseDto]
+  describe 'sim_swap_controller_check_sim_swap test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/check_sim_swap_dto_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TelvriSecurity::CheckSimSwapDto
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe TelvriSecurity::CheckSimSwapDto do
+  #let(:instance) { TelvriSecurity::CheckSimSwapDto.new }
+
+  describe 'test an instance of CheckSimSwapDto' do
+    it 'should create an instance of CheckSimSwapDto' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(TelvriSecurity::CheckSimSwapDto)
+    end
+  end
+
+  describe 'test attribute "phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "max_age_hours"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/login_dto_spec.rb

@@ -0,0 +1,42 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TelvriSecurity::LoginDto
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe TelvriSecurity::LoginDto do
+  #let(:instance) { TelvriSecurity::LoginDto.new }
+
+  describe 'test an instance of LoginDto' do
+    it 'should create an instance of LoginDto' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(TelvriSecurity::LoginDto)
+    end
+  end
+
+  describe 'test attribute "email"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "password"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/signup_dto_spec.rb

@@ -0,0 +1,60 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TelvriSecurity::SignupDto
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe TelvriSecurity::SignupDto do
+  #let(:instance) { TelvriSecurity::SignupDto.new }
+
+  describe 'test an instance of SignupDto' do
+    it 'should create an instance of SignupDto' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(TelvriSecurity::SignupDto)
+    end
+  end
+
+  describe 'test attribute "full_name"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "email"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "company"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "password"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "confirm_password"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/sim_swap_response_dto_spec.rb

@@ -0,0 +1,60 @@
+=begin
+#Telvri Security API Gateway
+
+#Developer-first Identity and Security Platform for real-time telco fraud mitigation, including SIM-swap intelligence for trusted application workflows.
+
+The version of the OpenAPI document: 1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for TelvriSecurity::SimSwapResponseDto
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe TelvriSecurity::SimSwapResponseDto do
+  #let(:instance) { TelvriSecurity::SimSwapResponseDto.new }
+
+  describe 'test an instance of SimSwapResponseDto' do
+    it 'should create an instance of SimSwapResponseDto' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(TelvriSecurity::SimSwapResponseDto)
+    end
+  end
+
+  describe 'test attribute "phone_number"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "swapped"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "last_swapped_at"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "provider"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "operator"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end