masspay_ruby_sdk 1.0.0

data/lib/masspay_ruby_sdk/api/kyc_api.rb

@@ -0,0 +1,290 @@
+=begin
+#MassPay API
+
+#MassPay API
+
+The version of the OpenAPI document: 0.1.4
+Contact: support@masspay.io
+Generated by: MassPay Inc.
+OpenAPI Generator version: 6.5.0
+=end
+
+require 'cgi'
+
+module MassPayRubySdk
+  class KYCApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Attributes velocity check
+    # This **POST** endpoint is used to perform an attributes velocity check to identify users with matching attribute values. <br> You can use this endpoint to help prevent fraudulent activities by monitoring for unusual attribute value changes over time. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL path and the required parameters in the request Body. <br> The endpoint will then compare the provided attribute value with the historical attribute values for the same user and determine if it meets the velocity check criteria.
+    # @param user_token [String] Token representing the user to retrieve attributes for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Array<AttrVelocityRequestInner>] :attr_velocity_request_inner 
+    # @return [Array<Object>]
+    def find_attributes_velocity(user_token, opts = {})
+      data, _status_code, _headers = find_attributes_velocity_with_http_info(user_token, opts)
+      data
+    end
+
+    # Attributes velocity check
+    # This **POST** endpoint is used to perform an attributes velocity check to identify users with matching attribute values. &lt;br&gt; You can use this endpoint to help prevent fraudulent activities by monitoring for unusual attribute value changes over time. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; as a parameter in the URL path and the required parameters in the request Body. &lt;br&gt; The endpoint will then compare the provided attribute value with the historical attribute values for the same user and determine if it meets the velocity check criteria.
+    # @param user_token [String] Token representing the user to retrieve attributes for
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Unique key to prevent duplicate processing
+    # @option opts [Array<AttrVelocityRequestInner>] :attr_velocity_request_inner 
+    # @return [Array<(Array<Object>, Integer, Hash)>] Array<Object> data, response status code and response headers
+    def find_attributes_velocity_with_http_info(user_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KYCApi.find_attributes_velocity ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling KYCApi.find_attributes_velocity"
+      end
+      # resource path
+      local_var_path = '/attribute/{user_token}/velocity'.sub('{' + 'user_token' + '}', CGI.escape(user_token.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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'attr_velocity_request_inner'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Array<Object>'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"KYCApi.find_attributes_velocity",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: KYCApi#find_attributes_velocity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get an Au10tix session link
+    # This **GET** endpoint is used to obtain a link to an Au10tix session for the user with the provided user token. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path. <br> The endpoint will then generate a session link that you can use to initiate an identity verification process for the user through the Au10tix platform. <br> The response will contain the session link as a URL in a JSON format.
+    # @param user_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetUserUserTokenKycAu10tix200Response]
+    def get_user_user_token_kyc_au10tix(user_token, opts = {})
+      data, _status_code, _headers = get_user_user_token_kyc_au10tix_with_http_info(user_token, opts)
+      data
+    end
+
+    # Get an Au10tix session link
+    # This **GET** endpoint is used to obtain a link to an Au10tix session for the user with the provided user token. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; as a parameter in the URL Path. &lt;br&gt; The endpoint will then generate a session link that you can use to initiate an identity verification process for the user through the Au10tix platform. &lt;br&gt; The response will contain the session link as a URL in a JSON format.
+    # @param user_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetUserUserTokenKycAu10tix200Response, Integer, Hash)>] GetUserUserTokenKycAu10tix200Response data, response status code and response headers
+    def get_user_user_token_kyc_au10tix_with_http_info(user_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KYCApi.get_user_user_token_kyc_au10tix ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling KYCApi.get_user_user_token_kyc_au10tix"
+      end
+      # resource path
+      local_var_path = '/user/{user_token}/kyc/au10tix'.sub('{' + 'user_token' + '}', CGI.escape(user_token.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] || 'GetUserUserTokenKycAu10tix200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"KYCApi.get_user_user_token_kyc_au10tix",
+        :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: KYCApi#get_user_user_token_kyc_au10tix\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get a Veriff session link
+    # This **GET** endpoint is used to obtain a link to a Veriff session for the user with the provided user token. <br> The endpoint will then generate a session link that you can use to initiate an identity verification process for the user through the Veriff platform. <br> To use this endpoint, you need to provide the `user_token` as a parameter in the URL Path. <br> The response will contain the session link as a URL in a JSON format.
+    # @param user_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [GetUserUserTokenKycVeriff200Response]
+    def get_user_user_token_kyc_veriff(user_token, opts = {})
+      data, _status_code, _headers = get_user_user_token_kyc_veriff_with_http_info(user_token, opts)
+      data
+    end
+
+    # Get a Veriff session link
+    # This **GET** endpoint is used to obtain a link to a Veriff session for the user with the provided user token. &lt;br&gt; The endpoint will then generate a session link that you can use to initiate an identity verification process for the user through the Veriff platform. &lt;br&gt; To use this endpoint, you need to provide the &#x60;user_token&#x60; as a parameter in the URL Path. &lt;br&gt; The response will contain the session link as a URL in a JSON format.
+    # @param user_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetUserUserTokenKycVeriff200Response, Integer, Hash)>] GetUserUserTokenKycVeriff200Response data, response status code and response headers
+    def get_user_user_token_kyc_veriff_with_http_info(user_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KYCApi.get_user_user_token_kyc_veriff ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling KYCApi.get_user_user_token_kyc_veriff"
+      end
+      # resource path
+      local_var_path = '/user/{user_token}/kyc/veriff'.sub('{' + 'user_token' + '}', CGI.escape(user_token.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] || 'GetUserUserTokenKycVeriff200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"KYCApi.get_user_user_token_kyc_veriff",
+        :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: KYCApi#get_user_user_token_kyc_veriff\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Upload ID Photos
+    # Upload IDs for the provided user. This is an optional endpoint if the images are captured through means other than the link that is generated in the attributes.
+    # @param user_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<IDUpload>] :id_upload 
+    # @return [Object]
+    def upload_id_photos(user_token, opts = {})
+      data, _status_code, _headers = upload_id_photos_with_http_info(user_token, opts)
+      data
+    end
+
+    # Upload ID Photos
+    # Upload IDs for the provided user. This is an optional endpoint if the images are captured through means other than the link that is generated in the attributes.
+    # @param user_token [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<IDUpload>] :id_upload 
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def upload_id_photos_with_http_info(user_token, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: KYCApi.upload_id_photos ...'
+      end
+      # verify the required parameter 'user_token' is set
+      if @api_client.config.client_side_validation && user_token.nil?
+        fail ArgumentError, "Missing the required parameter 'user_token' when calling KYCApi.upload_id_photos"
+      end
+      # resource path
+      local_var_path = '/user/{user_token}/kyc/id'.sub('{' + 'user_token' + '}', CGI.escape(user_token.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'])
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'application/xml'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'id_upload'])
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['AUTHORIZER_NAME']
+
+      new_options = opts.merge(
+        :operation => :"KYCApi.upload_id_photos",
+        :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(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: KYCApi#upload_id_photos\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end