passbase 1.0.1 → 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
 
@@ -19,6 +19,7 @@ require 'passbase/configuration'
 # Models
 require 'passbase/models/cursor'
 require 'passbase/models/identity'
+require 'passbase/models/identity_owner'
 require 'passbase/models/identity_resource'
 require 'passbase/models/paginated_identities'
 require 'passbase/models/paginated_resources'

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
 
@@ -19,6 +19,69 @@ module Passbase
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get identity
+    # Retrieve an identity by providing the identity ID.
+    # @param id [String] Unique ID of the identity to return
+    # @param [Hash] opts the optional parameters
+    # @return [Identity]
+    def get_identity_by_id(id, opts = {})
+      data, _status_code, _headers = get_identity_by_id_with_http_info(id, opts)
+      data
+    end
+
+    # Get identity
+    # Retrieve an identity by providing the identity ID.
+    # @param id [String] Unique ID of the identity to return
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
+    def get_identity_by_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IdentityApi.get_identity_by_id ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.get_identity_by_id"
+      end
+      # resource path
+      local_var_path = '/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Identity'
+
+      # auth_names
+      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,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IdentityApi#get_identity_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get resource
     # Get a resource attached to an identity by providing the resource ID. 
     # @param id [String] Identity id
@@ -49,7 +112,7 @@ module Passbase
         fail ArgumentError, "Missing the required parameter 'resource_id' when calling IdentityApi.get_identity_resource_by_id"
       end
       # resource path
-      local_var_path = '/identities/{id}/resource/{resource_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s))
+      local_var_path = '/identity/{id}/resources/{resource_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -63,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,
@@ -87,31 +151,43 @@ module Passbase
       return data, status_code, headers
     end
 
-    # Get identity
-    # Retrieve an identity by providing the identity ID.
-    # @param id [String] Unique ID of the identity to return
+    # Get resource file
+    # Get a raw resource file attached to an identity by providing the resource ID and the resource file ID. This is a protected route and you'll need a specific government authorization to access it. 
+    # @param id [String] Identity id
+    # @param resource_id [String] Resource id
+    # @param resource_file_id [String] Resource file id
     # @param [Hash] opts the optional parameters
-    # @return [Array<Identity>]
-    def get_identy_by_id(id, opts = {})
-      data, _status_code, _headers = get_identy_by_id_with_http_info(id, opts)
+    # @return [ResourceFile]
+    def get_identity_resource_file_by_id(id, resource_id, resource_file_id, opts = {})
+      data, _status_code, _headers = get_identity_resource_file_by_id_with_http_info(id, resource_id, resource_file_id, opts)
       data
     end
 
-    # Get identity
-    # Retrieve an identity by providing the identity ID.
-    # @param id [String] Unique ID of the identity to return
+    # Get resource file
+    # Get a raw resource file attached to an identity by providing the resource ID and the resource file ID. This is a protected route and you&#39;ll need a specific government authorization to access it. 
+    # @param id [String] Identity id
+    # @param resource_id [String] Resource id
+    # @param resource_file_id [String] Resource file id
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Array<Identity>, Integer, Hash)>] Array<Identity> data, response status code and response headers
-    def get_identy_by_id_with_http_info(id, opts = {})
+    # @return [Array<(ResourceFile, Integer, Hash)>] ResourceFile data, response status code and response headers
+    def get_identity_resource_file_by_id_with_http_info(id, resource_id, resource_file_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: IdentityApi.get_identy_by_id ...'
+        @api_client.config.logger.debug 'Calling API: IdentityApi.get_identity_resource_file_by_id ...'
       end
       # verify the required parameter 'id' is set
       if @api_client.config.client_side_validation && id.nil?
-        fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.get_identy_by_id"
+        fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.get_identity_resource_file_by_id"
+      end
+      # verify the required parameter 'resource_id' is set
+      if @api_client.config.client_side_validation && resource_id.nil?
+        fail ArgumentError, "Missing the required parameter 'resource_id' when calling IdentityApi.get_identity_resource_file_by_id"
+      end
+      # verify the required parameter 'resource_file_id' is set
+      if @api_client.config.client_side_validation && resource_file_id.nil?
+        fail ArgumentError, "Missing the required parameter 'resource_file_id' when calling IdentityApi.get_identity_resource_file_by_id"
       end
       # resource path
-      local_var_path = '/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/identity/{id}/resources/{resource_id}/resource_files/{resource_file_id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'resource_id' + '}', CGI.escape(resource_id.to_s)).sub('{' + 'resource_file_id' + '}', CGI.escape(resource_file_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -125,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] || 'Array<Identity>' 
+      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,
@@ -144,7 +221,7 @@ module Passbase
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: IdentityApi#get_identy_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: IdentityApi#get_identity_resource_file_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -187,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,
@@ -239,7 +317,7 @@ module Passbase
         fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.list_identity_resources"
       end
       # resource path
-      local_var_path = '/identities/{id}/resources'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+      local_var_path = '/identity/{id}/resources'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -255,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.0.1"
+      @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