passbase 1.2.0 → 1.3.0

data/docs/WatchlistResponse.md

@@ -2,24 +2,25 @@
 
 ## Properties
 
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**clean** | **Boolean** | Indicates whether the authentication watchlist check is clean or not | [optional] 
-**listings** | **Object** | Watchlist check findings | [optional] 
-**media** | **Array<Object>** | List of media entries, with the date, title, and url parameters | [optional] 
-**sources** | **Array<String>** | Array of listing sources (eg. sanction lists) | [optional] 
-**types** | **Array<String>** | What kind of alert or warning is associated with the entity (eg. sanction, pep, warning) | [optional] 
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **clean** | **Boolean** | Indicates whether the authentication watchlist check is clean or not | [optional] |
+| **listings** | **Object** | Watchlist check findings | [optional] |
+| **media** | **Array<Object>** | List of media entries, with the date, title, and url parameters | [optional] |
+| **sources** | **Array<String>** | Array of listing sources (eg. sanction lists) | [optional] |
+| **types** | **Array<String>** | What kind of alert or warning is associated with the entity (eg. sanction, pep, warning) | [optional] |
 
-## Code Sample
+## Example
 
 ```ruby
-require 'Passbase'
+require 'passbase'
 
-instance = Passbase::WatchlistResponse.new(clean: false,
-                                 listings: {"finanstilsynet":{"url":"https://www.finanstilsynet.dk","name":"Denmark Finanstilsynet Foreign Regulators Warnings","aml_types":["warning"],"listing_started_utc":"2020-02-17T00:00:00Z"},"...":{}},
-                                 media: [{"url":"http://www.macnn.com/searchcatnext/tag/Puccini/2","title":"(no title)"}],
-                                 sources: ["african-development-bank","..."],
-                                 types: ["adverse-media","..."])
+instance = Passbase::WatchlistResponse.new(
+  clean: false,
+  listings: {"finanstilsynet":{"url":"https://www.finanstilsynet.dk","name":"Denmark Finanstilsynet Foreign Regulators Warnings","aml_types":["warning"],"listing_started_utc":"2020-02-17T00:00:00Z"},"...":{}},
+  media: [{"url":"http://www.macnn.com/searchcatnext/tag/Puccini/2","title":"(no title)"}],
+  sources: ["african-development-bank","..."],
+  types: ["adverse-media","..."]
+)
 ```
 
-

data/lib/passbase.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 5.2.0-SNAPSHOT
 
 =end
 

data/lib/passbase/api/identity_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 5.2.0-SNAPSHOT
 
 =end
 
@@ -57,15 +57,16 @@ module Passbase
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Identity' 
+      return_type = opts[:debug_return_type] || 'Identity'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['SecretApiKey']
+      auth_names = opts[:debug_auth_names] || ['SecretApiKey']
 
       new_options = opts.merge(
+        :operation => :"IdentityApi.get_identity_by_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -125,15 +126,16 @@ module Passbase
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'Resource' 
+      return_type = opts[:debug_return_type] || 'Resource'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['SecretApiKey']
+      auth_names = opts[:debug_auth_names] || ['SecretApiKey']
 
       new_options = opts.merge(
+        :operation => :"IdentityApi.get_identity_resource_by_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -199,15 +201,16 @@ module Passbase
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'ResourceFile' 
+      return_type = opts[:debug_return_type] || 'ResourceFile'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['SecretApiKey']
+      auth_names = opts[:debug_auth_names] || ['SecretApiKey']
 
       new_options = opts.merge(
+        :operation => :"IdentityApi.get_identity_resource_file_by_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -261,15 +264,16 @@ module Passbase
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'PaginatedIdentities' 
+      return_type = opts[:debug_return_type] || 'PaginatedIdentities'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['SecretApiKey']
+      auth_names = opts[:debug_auth_names] || ['SecretApiKey']
 
       new_options = opts.merge(
+        :operation => :"IdentityApi.list_identities",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -329,15 +333,16 @@ module Passbase
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'PaginatedResources' 
+      return_type = opts[:debug_return_type] || 'PaginatedResources'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['SecretApiKey']
+      auth_names = opts[:debug_auth_names] || ['SecretApiKey']
 
       new_options = opts.merge(
+        :operation => :"IdentityApi.list_identity_resources",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/passbase/api/project_api.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 5.2.0-SNAPSHOT
 
 =end
 
@@ -51,15 +51,16 @@ module Passbase
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'ProjectSettings' 
+      return_type = opts[:debug_return_type] || 'ProjectSettings'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['SecretApiKey']
+      auth_names = opts[:debug_auth_names] || ['SecretApiKey']
 
       new_options = opts.merge(
+        :operation => :"ProjectApi.get_settings",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/passbase/api_client.rb

@@ -1,12 +1,12 @@
 =begin
 #Verification API
 
-## Introduction  <span class=\"subtext\"> Welcome to the Passbase Verifications API docs. This documentation will help you understand our models and the Verification API with its endpoints. Based on this you can build your own system (i.e. verification) and hook it up to Passbase.  In case of feedback or questions you can reach us under this email address: [developer@passbase.com](mailto:developer@passbase.com). </span>  A User submits a video selfie and valid identifying __Resources__ during a __Verification__ guided by the Passbase client-side integration. Once all the necessary __Resources__ are submitted, __Data points__ are extracted, digitized, and authenticated. These Data points then becomes part of the User's __Identity__. The User then consents to share __Resources__ and/or __Data points__ from their Identity with you. This information is passed to you and can be used to make decisions about a User (e.g. activate account). This table below explains our terminology further.  | Term                                    | Description | |-----------------------------------------|-------------| | [Identity](#tag/identity_model)         | A set of Data points and Resources related to and owned by one single User. This data can be accessed by you through a Verification. | | Data points                             | Any data about a User extracted from a Resource (E.g. Passport Number, or Age). | | [Resource](#tag/resource_model)         | A source document used to generate the Data points for a User (E.g. Passport). | | [User](#tag/user_model)                 | The owner of an email address associated with an Identity. | | Verification                            | A transaction through which a User consents to share Data points with you. If the Data points you request are not already available in the User's Identity, the Passbase client will ask the User to submit the necessary Resource required to extract them. | | Re-authentication (login)               | A transaction through which a User can certify the ownership of Personal data previously shared through an Authentication. |   # Authentication  <span class=\"subtext\"> There are two forms of authentication for the API: <br/>&bull; API Key <br/>&bull; Bearer JWT Token  </span> 
+## Introduction  <span class=\"subtext\"> Welcome to the Passbase Verifications API docs. This documentation will help you understand our models and the Verification API with its endpoints. Based on this you can build your own system (i.e. verification) and hook it up to Passbase.  In case of feedback or questions you can reach us under this email address: [developer@passbase.com](mailto:developer@passbase.com). </span>  A User submits a video selfie and valid identifying __Resources__ during a __Verification__ guided by the Passbase client-side integration. Once all the necessary __Resources__ are submitted, __Data points__ are extracted, digitized, and authenticated. These Data points then becomes part of the User's __Identity__. The User then consents to share __Resources__ and/or __Data points__ from their Identity with you. This information is passed to you and can be used to make decisions about a User (e.g. activate account). This table below explains our terminology further.  | Term                                    | Description | |-----------------------------------------|-------------| | [Identity](#tag/identity_model)         | A set of Data points and Resources related to and owned by one single User. This data can be accessed by you through a Verification. | | Data points                             | Any data about a User extracted from a Resource (E.g. Passport Number, or Age). | | [Resource](#tag/resource_model)         | A source document used to generate the Data points for a User (E.g. Passport). | | [User](#tag/user_model)                 | The owner of an email address associated with an Identity. | | Verification                            | A transaction through which a User consents to share Data points with you. If the Data points you request are not already available in the User's Identity, the Passbase client will ask the User to submit the necessary Resource required to extract them. | | Re-authentication (login)               | A transaction through which a User can certify the ownership of Personal data previously shared through an Authentication. |   # Authentication  <span class=\"subtext\"> There are two forms of authentication for the API: <br/>&bull; API Key <br/>&bull; Bearer JWT Token  </span>
 
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 5.2.0-SNAPSHOT
 
 =end
 
@@ -14,6 +14,7 @@ require 'date'
 require 'json'
 require 'logger'
 require 'tempfile'
+require 'time'
 require 'faraday'
 
 module Passbase
@@ -30,7 +31,7 @@ module Passbase
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "passbase/ruby@1.2.0"
+      @user_agent = "passbase/ruby@1.3.0"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent
@@ -106,7 +107,7 @@ module Passbase
     # @option opts [Object] :body HTTP body (JSON/XML)
     # @return [Typhoeus::Request] A Typhoeus Request
     def build_request(http_method, path, request, opts = {})
-      url = build_request_url(path)
+      url = build_request_url(path, opts)
       http_method = http_method.to_sym.downcase
 
       header_params = @default_headers.merge(opts[:header_params] || {})
@@ -171,6 +172,15 @@ module Passbase
       data
     end
 
+    def download_file(request)
+      @stream = []
+
+      # handle streaming Responses
+      request.options.on_data = Proc.new do |chunk, overall_received_bytes|
+        @stream << chunk
+      end
+    end
+
     # Check if the given MIME is a JSON MIME.
     # JSON MIME examples:
     #   application/json
@@ -192,7 +202,25 @@ module Passbase
 
       # handle file downloading - return the File instance processed in request callbacks
       # note that response body is empty when the file is written in chunks in request on_body callback
-      return @tempfile if return_type == 'File'
+      if return_type == 'File'
+        content_disposition = response.headers['Content-Disposition']
+        if content_disposition && content_disposition =~ /filename=/i
+          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
+          prefix = sanitize_filename(filename)
+        else
+          prefix = 'download-'
+        end
+        prefix = prefix + '-' unless prefix.end_with?('-')
+        encoding = body.encoding
+        @tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
+        @tempfile.write(@stream.join.force_encoding(encoding))
+        @tempfile.close
+        @config.logger.info "Temp file written to #{@tempfile.path}, please copy the file to a proper folder "\
+                            "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
+                            "will be deleted automatically with GC. It's also recommended to delete the temp file "\
+                            "explicitly with `tempfile.delete`"
+        return @tempfile
+      end
 
       return nil if body.nil? || body.empty?
 
@@ -207,7 +235,7 @@ module Passbase
       begin
         data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
       rescue JSON::ParserError => e
-        if %w(String Date DateTime).include?(return_type)
+        if %w(String Date Time).include?(return_type)
           data = body
         else
           raise e
@@ -232,9 +260,9 @@ module Passbase
         data.to_f
       when 'Boolean'
         data == true
-      when 'DateTime'
+      when 'Time'
         # parse date time (expecting ISO 8601 format)
-        DateTime.parse data
+        Time.parse data
       when 'Date'
         # parse date time (expecting ISO 8601 format)
         Date.parse data
@@ -252,46 +280,9 @@ module Passbase
           data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
         end
       else
-        # models, e.g. Pet
-        Passbase.const_get(return_type).build_from_hash(data)
-      end
-    end
-
-    # Save response body into a file in (the defined) temporary folder, using the filename
-    # from the "Content-Disposition" header if provided, otherwise a random filename.
-    # The response body is written to the file in chunks in order to handle files which
-    # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
-    # process can use.
-    #
-    # @see Configuration#temp_folder_path
-    def download_file(request)
-      tempfile = nil
-      encoding = nil
-      request.on_headers do |response|
-        content_disposition = response.headers['Content-Disposition']
-        if content_disposition && content_disposition =~ /filename=/i
-          filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
-          prefix = sanitize_filename(filename)
-        else
-          prefix = 'download-'
-        end
-        prefix = prefix + '-' unless prefix.end_with?('-')
-        encoding = response.body.encoding
-        tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
-        @tempfile = tempfile
-      end
-      request.on_body do |chunk|
-        chunk.force_encoding(encoding)
-        tempfile.write(chunk)
-      end
-      request.on_complete do |response|
-        if tempfile
-          tempfile.close
-          @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
-                              "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
-                              "will be deleted automatically with GC. It's also recommended to delete the temp file "\
-                              "explicitly with `tempfile.delete`"
-        end
+        # models (e.g. Pet) or oneOf
+        klass = Passbase.const_get(return_type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
       end
     end
 
@@ -304,10 +295,10 @@ module Passbase
       filename.gsub(/.*[\/\\]/, '')
     end
 
-    def build_request_url(path)
+    def build_request_url(path, opts = {})
       # Add leading and trailing slashes to path
       path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url + path
+      @config.base_url(opts[:operation]) + path
     end
 
     # Update hearder and query params based on authentication settings.
@@ -322,7 +313,7 @@ module Passbase
         case auth_setting[:in]
         when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
         when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
-        else fail ArgumentError, 'Authentication token must be in `query` of `header`'
+        else fail ArgumentError, 'Authentication token must be in `query` or `header`'
         end
       end
     end

data/lib/passbase/api_error.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 5.2.0-SNAPSHOT
 
 =end
 

data/lib/passbase/configuration.rb

@@ -6,7 +6,7 @@
 The version of the OpenAPI document: 1.0.0
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 5.0.0-SNAPSHOT
+OpenAPI Generator version: 5.2.0-SNAPSHOT
 
 =end
 
@@ -21,6 +21,18 @@ module Passbase
     # Defines url base path
     attr_accessor :base_path
 
+    # Define server configuration index
+    attr_accessor :server_index
+
+    # Define server operation configuration index
+    attr_accessor :server_operation_index
+
+    # Default server variables
+    attr_accessor :server_variables
+
+    # Default server operation variables
+    attr_accessor :server_operation_variables
+
     # Defines API keys used with API Key authentications.
     #
     # @return [Hash] key: parameter name, value: parameter value (API key)
@@ -123,7 +135,11 @@ module Passbase
     def initialize
       @scheme = 'https'
       @host = 'api.passbase.com'
-      @base_path = '/verification/v1'
+      @base_path = '/verification/v2'
+      @server_index = 0
+      @server_operation_index = {}
+      @server_variables = {}
+      @server_operation_variables = {}
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
@@ -166,17 +182,23 @@ module Passbase
       @base_path = '' if @base_path == '/'
     end
 
-    def base_url
-      "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
+    # Returns base URL for specified operation based on server settings
+    def base_url(operation = nil)
+      index = server_operation_index.fetch(operation, server_index)
+      return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
+
+      server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
     end
 
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth
-    def api_key_with_prefix(param_name)
+    def api_key_with_prefix(param_name, param_alias = nil)
+      key = @api_key[param_name]
+      key = @api_key.fetch(param_alias, key) unless param_alias.nil?
       if @api_key_prefix[param_name]
-        "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
+        "#{@api_key_prefix[param_name]} #{key}"
       else
-        @api_key[param_name]
+        key
       end
     end
 
@@ -201,14 +223,14 @@ module Passbase
             type: 'api_key',
             in: 'header',
             key: 'X-API-KEY',
-            value: api_key_with_prefix('X-API-KEY')
+            value: api_key_with_prefix('PublishableApiKey')
           },
         'SecretApiKey' =>
           {
             type: 'api_key',
             in: 'header',
             key: 'X-API-KEY',
-            value: api_key_with_prefix('X-API-KEY')
+            value: api_key_with_prefix('SecretApiKey')
           },
       }
     end
@@ -217,18 +239,23 @@ module Passbase
     def server_settings
       [
         {
-          url: "https://api.passbase.com/verification/v1",
+          url: "https://api.passbase.com/verification/v2",
           description: "No description provided",
         }
       ]
     end
 
+    def operation_server_settings
+      {
+      }
+    end
+
     # Returns URL based on server settings
     #
     # @param index array index of the server settings
     # @param variables hash of variable and the corresponding value
-    def server_url(index, variables = {})
-      servers = server_settings
+    def server_url(index, variables = {}, servers = nil)
+      servers = server_settings if servers == nil
 
       # check array index out of bound
       if (index < 0 || index >= servers.size)
@@ -238,10 +265,12 @@ module Passbase
       server = servers[index]
       url = server[:url]
 
+      return url unless server.key? :variables
+
       # go through variable and assign a value
       server[:variables].each do |name, variable|
         if variables.key?(name)
-          if (server[:variables][name][:enum_values].include? variables[name])
+          if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
             url.gsub! "{" + name.to_s + "}", variables[name]
           else
             fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."