transferzero-sdk 1.0.0

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://openapi-generator.tech
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-pestore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="transferzero"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="transferzero-ruby-sdk"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/transferzero-sdk.rb

@@ -0,0 +1,146 @@
+=begin
+#TransferZero API
+
+#Reference documentation for the TransferZero API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+# Common files
+require 'transferzero-sdk/api_client'
+require 'transferzero-sdk/api_error'
+require 'transferzero-sdk/version'
+require 'transferzero-sdk/configuration'
+
+# Models
+require 'transferzero-sdk/models/account'
+require 'transferzero-sdk/models/account_list_response'
+require 'transferzero-sdk/models/account_meta'
+require 'transferzero-sdk/models/account_response'
+require 'transferzero-sdk/models/account_validation_error'
+require 'transferzero-sdk/models/account_validation_request'
+require 'transferzero-sdk/models/account_validation_response'
+require 'transferzero-sdk/models/account_validation_result'
+require 'transferzero-sdk/models/api_log'
+require 'transferzero-sdk/models/api_log_list_response'
+require 'transferzero-sdk/models/api_log_response'
+require 'transferzero-sdk/models/currency'
+require 'transferzero-sdk/models/currency_exchange'
+require 'transferzero-sdk/models/currency_exchange_list_response'
+require 'transferzero-sdk/models/currency_list_response'
+require 'transferzero-sdk/models/currency_opposite'
+require 'transferzero-sdk/models/debit'
+require 'transferzero-sdk/models/debit_list_request'
+require 'transferzero-sdk/models/debit_list_response'
+require 'transferzero-sdk/models/debit_request'
+require 'transferzero-sdk/models/debit_request_wrapper'
+require 'transferzero-sdk/models/debit_response'
+require 'transferzero-sdk/models/document'
+require 'transferzero-sdk/models/document_list_response'
+require 'transferzero-sdk/models/document_request'
+require 'transferzero-sdk/models/document_response'
+require 'transferzero-sdk/models/document_webhook'
+require 'transferzero-sdk/models/error_status'
+require 'transferzero-sdk/models/field_description'
+require 'transferzero-sdk/models/field_select_validation'
+require 'transferzero-sdk/models/field_validation'
+require 'transferzero-sdk/models/pagination'
+require 'transferzero-sdk/models/pagination_meta'
+require 'transferzero-sdk/models/payin_method'
+require 'transferzero-sdk/models/payin_method_details'
+require 'transferzero-sdk/models/payin_method_details_mobile'
+require 'transferzero-sdk/models/payin_method_details_ngn_bank'
+require 'transferzero-sdk/models/payin_method_request'
+require 'transferzero-sdk/models/payment_method'
+require 'transferzero-sdk/models/payment_method_list_response'
+require 'transferzero-sdk/models/payment_method_opposite'
+require 'transferzero-sdk/models/payout_method'
+require 'transferzero-sdk/models/payout_method_bank_account_type_enum'
+require 'transferzero-sdk/models/payout_method_details'
+require 'transferzero-sdk/models/payout_method_details_balance'
+require 'transferzero-sdk/models/payout_method_details_ghs_bank'
+require 'transferzero-sdk/models/payout_method_details_iban'
+require 'transferzero-sdk/models/payout_method_details_mad_cash'
+require 'transferzero-sdk/models/payout_method_details_mobile'
+require 'transferzero-sdk/models/payout_method_details_ngn_bank'
+require 'transferzero-sdk/models/payout_method_details_xof_mobile'
+require 'transferzero-sdk/models/payout_method_gender_enum'
+require 'transferzero-sdk/models/payout_method_identity_card_type_enum'
+require 'transferzero-sdk/models/payout_method_list_response'
+require 'transferzero-sdk/models/payout_method_mobile_provider_enum'
+require 'transferzero-sdk/models/payout_method_request'
+require 'transferzero-sdk/models/payout_method_response'
+require 'transferzero-sdk/models/payout_method_webhook'
+require 'transferzero-sdk/models/recipient'
+require 'transferzero-sdk/models/recipient_list_response'
+require 'transferzero-sdk/models/recipient_request'
+require 'transferzero-sdk/models/recipient_response'
+require 'transferzero-sdk/models/recipient_state'
+require 'transferzero-sdk/models/recipient_webhook'
+require 'transferzero-sdk/models/sender'
+require 'transferzero-sdk/models/sender_list_response'
+require 'transferzero-sdk/models/sender_request'
+require 'transferzero-sdk/models/sender_response'
+require 'transferzero-sdk/models/sender_response_existing'
+require 'transferzero-sdk/models/sender_response_meta'
+require 'transferzero-sdk/models/sender_state'
+require 'transferzero-sdk/models/sender_webhook'
+require 'transferzero-sdk/models/transaction'
+require 'transferzero-sdk/models/transaction_list_response'
+require 'transferzero-sdk/models/transaction_request'
+require 'transferzero-sdk/models/transaction_response'
+require 'transferzero-sdk/models/transaction_response_existing'
+require 'transferzero-sdk/models/transaction_response_meta'
+require 'transferzero-sdk/models/transaction_state'
+require 'transferzero-sdk/models/transaction_traits'
+require 'transferzero-sdk/models/transaction_webhook'
+require 'transferzero-sdk/models/validation_error_description'
+require 'transferzero-sdk/models/webhook'
+require 'transferzero-sdk/models/webhook_definition'
+require 'transferzero-sdk/models/webhook_definition_event_list_response'
+require 'transferzero-sdk/models/webhook_definition_list_response'
+require 'transferzero-sdk/models/webhook_definition_request'
+require 'transferzero-sdk/models/webhook_definition_response'
+require 'transferzero-sdk/models/webhook_log'
+require 'transferzero-sdk/models/webhook_log_list_response'
+require 'transferzero-sdk/models/webhook_log_metadata'
+require 'transferzero-sdk/models/webhook_log_metadata_request'
+require 'transferzero-sdk/models/webhook_log_metadata_response'
+require 'transferzero-sdk/models/webhook_log_response'
+
+# APIs
+require 'transferzero-sdk/api/api_logs_api'
+require 'transferzero-sdk/api/account_debits_api'
+require 'transferzero-sdk/api/account_validation_api'
+require 'transferzero-sdk/api/accounts_api'
+require 'transferzero-sdk/api/currency_info_api'
+require 'transferzero-sdk/api/documents_api'
+require 'transferzero-sdk/api/logs_api'
+require 'transferzero-sdk/api/payment_methods_api'
+require 'transferzero-sdk/api/payout_methods_api'
+require 'transferzero-sdk/api/recipients_api'
+require 'transferzero-sdk/api/senders_api'
+require 'transferzero-sdk/api/transactions_api'
+require 'transferzero-sdk/api/webhooks_api'
+
+module TransferZero
+  class << self
+    # Customize default settings for the SDK using block.
+    #   TransferZero.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/lib/transferzero-sdk/api/account_debits_api.rb

@@ -0,0 +1,187 @@
+=begin
+#TransferZero API
+
+#Reference documentation for the TransferZero API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+require 'uri'
+
+module TransferZero
+  class AccountDebitsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Fetching an account debit
+    # Returns a single account debit by the account debit ID
+    # @param account_debit_id ID of the account debit to get.  Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d`
+    # @param [Hash] opts the optional parameters
+    # @return [DebitResponse]
+    def get_accounts_debit(account_debit_id, opts = {})
+      data, _status_code, _headers = get_accounts_debit_with_http_info(account_debit_id, opts)
+      data
+    end
+
+    # Fetching an account debit
+    # Returns a single account debit by the account debit ID
+    # @param account_debit_id ID of the account debit to get.  Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d`
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DebitResponse, Fixnum, Hash)>] DebitResponse data, response status code and response headers
+    def get_accounts_debit_with_http_info(account_debit_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debit ...'
+      end
+      # verify the required parameter 'account_debit_id' is set
+      if @api_client.config.client_side_validation && account_debit_id.nil?
+        fail ArgumentError, "Missing the required parameter 'account_debit_id' when calling AccountDebitsApi.get_accounts_debit"
+      end
+      # resource path
+      local_var_path = '/accounts/debits/{Account Debit ID}'.sub('{' + 'Account Debit ID' + '}', account_debit_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DebitResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Listing Accounts debits
+    # Get a list of accounts debits
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page number to request (defaults to 1)
+    # @option opts [Integer] :per The number of results to load per page (defaults to 10)
+    # @return [DebitListResponse]
+    def get_accounts_debits(opts = {})
+      data, _status_code, _headers = get_accounts_debits_with_http_info(opts)
+      data
+    end
+
+    # Listing Accounts debits
+    # Get a list of accounts debits
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page The page number to request (defaults to 1)
+    # @option opts [Integer] :per The number of results to load per page (defaults to 10)
+    # @return [Array<(DebitListResponse, Fixnum, Hash)>] DebitListResponse data, response status code and response headers
+    def get_accounts_debits_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debits ...'
+      end
+      # resource path
+      local_var_path = '/accounts/debits'
+
+      # query parameters
+      query_params = {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DebitListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+
+    # Creating an account debit
+    # Creates a new account debit finding transaction through the internal balance  To successfully fund a transaction - - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet  Once the transaction is funded, we will immediately start trying to pay out the recipient(s).  It is also possible to create multiple account debits by supplying an array of debit objects 
+    # @param debit_request_wrapper 
+    # @param [Hash] opts the optional parameters
+    # @return [DebitListResponse]
+    def post_accounts_debits(debit_request_wrapper, opts = {})
+      data, _status_code, _headers = post_accounts_debits_with_http_info(debit_request_wrapper, opts)
+      data
+    end
+
+    # Creating an account debit
+    # Creates a new account debit finding transaction through the internal balance  To successfully fund a transaction - - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet  Once the transaction is funded, we will immediately start trying to pay out the recipient(s).  It is also possible to create multiple account debits by supplying an array of debit objects 
+    # @param debit_request_wrapper 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DebitListResponse, Fixnum, Hash)>] DebitListResponse data, response status code and response headers
+    def post_accounts_debits_with_http_info(debit_request_wrapper, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountDebitsApi.post_accounts_debits ...'
+      end
+      # verify the required parameter 'debit_request_wrapper' is set
+      if @api_client.config.client_side_validation && debit_request_wrapper.nil?
+        fail ArgumentError, "Missing the required parameter 'debit_request_wrapper' when calling AccountDebitsApi.post_accounts_debits"
+      end
+      # resource path
+      local_var_path = '/accounts/debits'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(debit_request_wrapper)
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DebitListResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountDebitsApi#post_accounts_debits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/transferzero-sdk/api/account_validation_api.rb

@@ -0,0 +1,79 @@
+=begin
+#TransferZero API
+
+#Reference documentation for the TransferZero API V1
+
+OpenAPI spec version: 1.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-beta3
+
+=end
+
+require 'uri'
+
+module TransferZero
+  class AccountValidationApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+
+    # Validates the existence of a bank account
+    # Validates the existence of a bank account and returns the associated customer name
+    # @param account_validation_request 
+    # @param [Hash] opts the optional parameters
+    # @return [AccountValidationResponse]
+    def post_account_validations(account_validation_request, opts = {})
+      data, _status_code, _headers = post_account_validations_with_http_info(account_validation_request, opts)
+      data
+    end
+
+    # Validates the existence of a bank account
+    # Validates the existence of a bank account and returns the associated customer name
+    # @param account_validation_request 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(AccountValidationResponse, Fixnum, Hash)>] AccountValidationResponse data, response status code and response headers
+    def post_account_validations_with_http_info(account_validation_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountValidationApi.post_account_validations ...'
+      end
+      # verify the required parameter 'account_validation_request' is set
+      if @api_client.config.client_side_validation && account_validation_request.nil?
+        fail ArgumentError, "Missing the required parameter 'account_validation_request' when calling AccountValidationApi.post_account_validations"
+      end
+      # resource path
+      local_var_path = '/account_validations'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(account_validation_request)
+      auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'AccountValidationResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountValidationApi#post_account_validations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end