solifyn 1.0.5 → 1.0.7

data/lib/solifyn/api/payouts_api.rb

@@ -0,0 +1,520 @@
+=begin
+#Solifyn API
+
+#Welcome to the Solifyn API Reference. Leverage our secure endpoints to manage products and issue, validate, and manage software license keys programmatically.
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'cgi'
+
+module Solifyn
+  class PayoutsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create Withdrawal
+    # Initiate a balance withdrawal transfer request.
+    # @param withdrawal_create [WithdrawalCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Withdrawal]
+    def payouts_create_withdrawal(withdrawal_create, opts = {})
+      data, _status_code, _headers = payouts_create_withdrawal_with_http_info(withdrawal_create, opts)
+      data
+    end
+
+    # Create Withdrawal
+    # Initiate a balance withdrawal transfer request.
+    # @param withdrawal_create [WithdrawalCreate] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Withdrawal, Integer, Hash)>] Withdrawal data, response status code and response headers
+    def payouts_create_withdrawal_with_http_info(withdrawal_create, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_create_withdrawal ...'
+      end
+      # verify the required parameter 'withdrawal_create' is set
+      if @api_client.config.client_side_validation && withdrawal_create.nil?
+        fail ArgumentError, "Missing the required parameter 'withdrawal_create' when calling PayoutsApi.payouts_create_withdrawal"
+      end
+      # resource path
+      local_var_path = '/v1/payouts/withdrawals'
+
+      # 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']) unless header_params['Accept']
+      # 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
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(withdrawal_create)
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Withdrawal'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_create_withdrawal",
+        :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: PayoutsApi#payouts_create_withdrawal\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve Payout Account
+    # Retrieve general status and information of onboarding payout accounts.
+    # @param [Hash] opts the optional parameters
+    # @return [PayoutAccount]
+    def payouts_get_account(opts = {})
+      data, _status_code, _headers = payouts_get_account_with_http_info(opts)
+      data
+    end
+
+    # Retrieve Payout Account
+    # Retrieve general status and information of onboarding payout accounts.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayoutAccount, Integer, Hash)>] PayoutAccount data, response status code and response headers
+    def payouts_get_account_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_get_account ...'
+      end
+      # resource path
+      local_var_path = '/v1/payouts/account'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutAccount'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_get_account",
+        :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: PayoutsApi#payouts_get_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create Account Link
+    # Generate temporary links for onboarding or viewing portals.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :use_case Onboarding link type context
+    # @return [PayoutAccountLink]
+    def payouts_get_account_link(opts = {})
+      data, _status_code, _headers = payouts_get_account_link_with_http_info(opts)
+      data
+    end
+
+    # Create Account Link
+    # Generate temporary links for onboarding or viewing portals.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :use_case Onboarding link type context
+    # @return [Array<(PayoutAccountLink, Integer, Hash)>] PayoutAccountLink data, response status code and response headers
+    def payouts_get_account_link_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_get_account_link ...'
+      end
+      allowable_values = ["account_onboarding", "payouts_portal"]
+      if @api_client.config.client_side_validation && opts[:'use_case'] && !allowable_values.include?(opts[:'use_case'])
+        fail ArgumentError, "invalid value for \"use_case\", must be one of #{allowable_values}"
+      end
+      # resource path
+      local_var_path = '/v1/payouts/account-link'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'use_case'] = opts[:'use_case'] if !opts[:'use_case'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutAccountLink'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_get_account_link",
+        :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: PayoutsApi#payouts_get_account_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Generate Portal Access Token
+    # Generate temporary credentials to access the embed portal.
+    # @param [Hash] opts the optional parameters
+    # @return [PayoutAccessToken]
+    def payouts_get_token(opts = {})
+      data, _status_code, _headers = payouts_get_token_with_http_info(opts)
+      data
+    end
+
+    # Generate Portal Access Token
+    # Generate temporary credentials to access the embed portal.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayoutAccessToken, Integer, Hash)>] PayoutAccessToken data, response status code and response headers
+    def payouts_get_token_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_get_token ...'
+      end
+      # resource path
+      local_var_path = '/v1/payouts/token'
+
+      # 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']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutAccessToken'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_get_token",
+        :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: PayoutsApi#payouts_get_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Withdrawals List
+    # Retrieve withdrawal records for the active business.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Page size limit
+    # @option opts [Float] :page Page number
+    # @return [WithdrawalList]
+    def payouts_get_withdrawals(opts = {})
+      data, _status_code, _headers = payouts_get_withdrawals_with_http_info(opts)
+      data
+    end
+
+    # Get Withdrawals List
+    # Retrieve withdrawal records for the active business.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Page size limit
+    # @option opts [Float] :page Page number
+    # @return [Array<(WithdrawalList, Integer, Hash)>] WithdrawalList data, response status code and response headers
+    def payouts_get_withdrawals_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_get_withdrawals ...'
+      end
+      # resource path
+      local_var_path = '/v1/payouts/withdrawals'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WithdrawalList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_get_withdrawals",
+        :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: PayoutsApi#payouts_get_withdrawals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Payout Methods
+    # List saved payout destinations (bank accounts, cards).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit 
+    # @option opts [Float] :page 
+    # @return [PayoutMethodList]
+    def payouts_list_methods(opts = {})
+      data, _status_code, _headers = payouts_list_methods_with_http_info(opts)
+      data
+    end
+
+    # List Payout Methods
+    # List saved payout destinations (bank accounts, cards).
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit 
+    # @option opts [Float] :page 
+    # @return [Array<(PayoutMethodList, Integer, Hash)>] PayoutMethodList data, response status code and response headers
+    def payouts_list_methods_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_list_methods ...'
+      end
+      # resource path
+      local_var_path = '/v1/payouts/methods'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutMethodList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_list_methods",
+        :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: PayoutsApi#payouts_list_methods\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Verifications
+    # Retrieve pending or completed KYC verification checks.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit 
+    # @option opts [Float] :page 
+    # @return [PayoutVerificationList]
+    def payouts_list_verifications(opts = {})
+      data, _status_code, _headers = payouts_list_verifications_with_http_info(opts)
+      data
+    end
+
+    # List Verifications
+    # Retrieve pending or completed KYC verification checks.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit 
+    # @option opts [Float] :page 
+    # @return [Array<(PayoutVerificationList, Integer, Hash)>] PayoutVerificationList data, response status code and response headers
+    def payouts_list_verifications_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_list_verifications ...'
+      end
+      # resource path
+      local_var_path = '/v1/payouts/verifications'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutVerificationList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_list_verifications",
+        :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: PayoutsApi#payouts_list_verifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Withdrawals
+    # Retrieve a list of past withdrawal history.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Page size limit
+    # @option opts [Float] :page Page number
+    # @return [WithdrawalList]
+    def payouts_list_withdrawals(opts = {})
+      data, _status_code, _headers = payouts_list_withdrawals_with_http_info(opts)
+      data
+    end
+
+    # List Withdrawals
+    # Retrieve a list of past withdrawal history.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :limit Page size limit
+    # @option opts [Float] :page Page number
+    # @return [Array<(WithdrawalList, Integer, Hash)>] WithdrawalList data, response status code and response headers
+    def payouts_list_withdrawals_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutsApi.payouts_list_withdrawals ...'
+      end
+      # resource path
+      local_var_path = '/v1/payouts'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'WithdrawalList'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
+
+      new_options = opts.merge(
+        :operation => :"PayoutsApi.payouts_list_withdrawals",
+        :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: PayoutsApi#payouts_list_withdrawals\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end