bleumi_pay_sdk_ruby 1.0.3 → 1.0.4

data/lib/bleumi_pay_sdk_ruby/api/payouts_api.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
@@ -15,14 +15,16 @@ require 'cgi'
 module BleumiPay
   class PayoutsApi
     attr_accessor :api_client
+    attr_accessor :request_validator
 
-    def initialize(api_client = ApiClient.default)
+    def initialize(api_client = ApiClient.default, request_validator = RequestValidator.default)
       @api_client = api_client
+      @request_validator = request_validator
     end
     # Create a payout.
     # @param create_payout_request [CreatePayoutRequest] Request body - used to specify payout creation parameters.
     # @param [Hash] opts the optional parameters
-    # @option opts [Chain] :chain Ethereum network in which payment is to be created. Please refer documentation for Supported Networks
+    # @option opts [Chain] :chain Network in which payment is to be created. Please refer documentation for Supported Networks
     # @return [CreatePayoutResponse]
     def create_payout(create_payout_request, opts = {})
       data, _status_code, _headers = create_payout_with_http_info(create_payout_request, opts)
@@ -32,7 +34,7 @@ module BleumiPay
     # Create a payout.
     # @param create_payout_request [CreatePayoutRequest] Request body - used to specify payout creation parameters.
     # @param [Hash] opts the optional parameters
-    # @option opts [Chain] :chain Ethereum network in which payment is to be created. Please refer documentation for Supported Networks
+    # @option opts [Chain] :chain Network in which payment is to be created. Please refer documentation for Supported Networks
     # @return [Array<(CreatePayoutResponse, Integer, Hash)>] CreatePayoutResponse data, response status code and response headers
     def create_payout_with_http_info(create_payout_request, opts = {})
       if @api_client.config.debugging
@@ -42,12 +44,18 @@ module BleumiPay
       if @api_client.config.client_side_validation && create_payout_request.nil?
         fail ArgumentError, "Missing the required parameter 'create_payout_request' when calling PayoutsApi.create_payout"
       end
+      # verify the values in the request body are valid
+      chain = opts[:'chain'] if !opts[:'chain'].nil?
+      msg = @request_validator.validate_create_payout_request(create_payout_request, chain)
+      if (@request_validator.is_not_empty(msg))
+        fail ArgumentError, "`#{msg}` when calling PayoutsApi.create_payout"
+      end
       # resource path
       local_var_path = '/v1/payout'
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'chain'] = opts[:'chain'] if !opts[:'chain'].nil?
+      query_params[:'chain'] = chain
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/bleumi_pay_sdk_ruby/api/request_validator.rb

@@ -0,0 +1,264 @@
+=begin
+#Bleumi Pay REST API
+
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
+
+Contact: info@bleumi.com
+
+=end
+module BleumiPay
+    class RequestValidator
+
+        def self.default
+            @@default ||= RequestValidator.new
+        end
+
+        def eth_address?(str)
+            # We use !! to convert the return value to a boolean
+            !!(str =~ /^0x[a-fA-F0-9]{40}$/)
+        end
+
+        def algo_address?(str)
+            # We use !! to convert the return value to a boolean
+            !!(str =~ /^[A-Z2-7+=*]{58}$/)
+        end
+
+        def is_not_empty(str)
+            if (str == nil || str == "") then
+                return false
+            end    
+            return true
+        end    
+
+        def check_eth_addr(name, input)
+            if !((eth_address?(input))||(input == "ETH")||(input == "XDAI")||(input == "XDAIT")) then
+                return "`#{name}` is not a valid Ethereum address"
+            end
+            return nil
+        end
+
+        def check_alg_addr(name, input)
+            if !((algo_address?(input))||(input == "ALGO")) then
+                return "`#{name}` is not a valid Algorand address"
+            end
+            return nil
+        end
+
+        def is_algo_network(chain)
+            return ((chain == "alg_mainnet")||(chain == "alg_testnet")) 
+        end
+
+        def check_req_param(name, input)
+            if (input == nil || input == "")
+                return "Missing required parameter `#{name}`"
+            end
+            return nil
+        end
+
+        def check_network_addr(name, input, chain, mandatory)
+            if mandatory then
+                msg = check_req_param(name, input)
+                if is_not_empty(msg) then
+                    return msg 
+                end    
+            end
+            if is_not_empty(input) then
+                msg = nil
+                if is_algo_network(chain) then
+                    msg =  check_alg_addr(name, input)
+                else
+                    msg =  check_eth_addr(name, input)
+                end    
+                if is_not_empty(msg) then
+                    return msg 
+                end
+            end   
+            return nil
+        end
+
+        def validate_create_payment_request(params, chain)
+            # check if chain is provided 
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if buyer_address is valid address in the network  
+            msg = check_network_addr("BuyerAddress", params.buyer_address, chain, mandatory=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if transfer_address is valid address in the network  
+            msg = check_network_addr("TransferAddress", params.transfer_address, chain, mandatory=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+
+            # check if token is valid address in the network (if provided) 
+            if is_not_empty(params.token) then
+                msg = check_network_addr("Token", params.token, chain, mandatory=false)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+            end    
+            return nil
+        end
+        
+        def validate_refund_payment_request(params, chain)
+            # check if chain is provided 
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if token is valid address in the network 
+            msg = check_network_addr("Token", params.token, chain, mandatory=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            return nil
+        end
+        
+        def validate_settle_payment_request(params, chain)
+            # check if chain is provided 
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if token is valid address in the network 
+            msg = check_network_addr("Token", params.token, chain, mandatory=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if amount to settle is provided
+            msg = check_req_param("Amount", params.amount)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            return nil
+        end
+        
+        def validate_create_checkout_url_request(params)
+            # check if id is provided while creating checkout url
+            msg = check_req_param("Id", params.id)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if currency is provided while creating checkout url
+            msg = check_req_param("Currency", params.currency)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if amount is provided while creating checkout url
+            msg = check_req_param("Amount", params.amount)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if cancel_url is provided while creating checkout url
+            msg = check_req_param("CancelUrl", params.cancel_url)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if success_url is provided while creating checkout url
+            msg = check_req_param("SuccessUrl", params.success_url)
+            if is_not_empty(msg) then
+                return msg 
+            end
+
+            # check if token is valid address in the network (if provided) 
+            if is_not_empty(params.token) then
+                
+                # check if chain is provided in the request, when token is provided, this is required 
+                msg = check_req_param("Chain", params.chain)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+
+                # check if token is valid address in the network (if provided) 
+                msg = check_network_addr("Token", params.token, params.chain, mandatory=false)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+
+                # check if buyer_address is valid address in the network (if provided) 
+                if is_not_empty(params.buyer_address) then
+                    msg = check_network_addr("BuyerAddress", params.buyer_address, params.chain, mandatory=false)
+                    if is_not_empty(msg) then
+                        return msg 
+                    end
+                end    
+            end   
+            return nil
+        end
+        
+        def validate_checkout_payment_params(params)
+            
+            # check if hmac_alg is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacAlg", params.hmac_alg)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if hmac_input is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacInput", params.hmac_input)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if hmac_key_id is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacKeyId", params.hmac_key_id)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            
+            # check if hmac_value is provided while creating checkout payment parameters request
+            msg = check_req_param("HmacValue", params.hmac_value)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            return nil
+        end
+        
+        def validate_create_payout_request(params, chain)
+            msg = check_req_param("Chain", chain)
+            if is_not_empty(msg) then
+                return msg 
+            end
+            # check if token is valid address in the network 
+            msg = check_network_addr("Token", params.token, chain, mandatory=true)
+            if is_not_empty(msg) then
+                return msg 
+            end
+
+            payouts = params.payouts
+            if payouts.length == 0 then 
+                return "Payouts not defined."
+            end
+
+            for payout in payouts
+                # check if payout.transfer_address is valid address in the network  
+                msg = check_network_addr("TransferAddress", payout.transfer_address, chain, mandatory=true)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+
+                # check if payout.amount is provided for payout
+                msg = check_req_param("Amount", payout.amount)
+                if is_not_empty(msg) then
+                    return msg 
+                end
+
+                if is_algo_network(chain) then
+                    # check if payout.authorization is provided for Algorand payout
+                    msg = check_req_param("Authorization", payout.authorization)
+                    if is_not_empty(msg) then
+                        return msg 
+                    end
+                end 
+            end
+            return nil
+        end
+    end
+end

data/lib/bleumi_pay_sdk_ruby/api_client.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
@@ -30,7 +30,7 @@ module BleumiPay
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
     def initialize(config = Configuration.default)
       @config = config
-      @user_agent = "BleumiPay/#{VERSION}/ruby"
+      @user_agent = "bleumi_pay_sdk_ruby/#{VERSION}/ruby"
       @default_headers = {
         'Content-Type' => 'application/json',
         'User-Agent' => @user_agent

data/lib/bleumi_pay_sdk_ruby/api_error.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com

data/lib/bleumi_pay_sdk_ruby/configuration.rb

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
@@ -208,7 +208,7 @@ module BleumiPay
       [
         {
           url: "https://api.pay.bleumi.com/",
-          description: "Bleumi Pay API",
+          description: "Bleumi Pay REST API",
         }
       ]
     end

data/lib/bleumi_pay_sdk_ruby/models/{token.rb → algorand_balance.rb}

@@ -1,7 +1,7 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai payments and/or payouts into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts into your business or application
 
 The version of the OpenAPI document: 1.0.0
 Contact: info@bleumi.com
@@ -13,21 +13,24 @@ OpenAPI Generator version: 4.2.2
 require 'date'
 
 module BleumiPay
-  class Token
-    # ETH - for Ethereum ; XDAI - for xDai ; XDAIT - for xDai Testnet ; <contract address of ERC-20 token> - for ERC-20 Tokens;
-    attr_accessor :addr
+  class AlgorandBalance
+    attr_accessor :alg_mainnet
+
+    attr_accessor :alg_testnet
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'addr' => :'addr'
+        :'alg_mainnet' => :'alg_mainnet',
+        :'alg_testnet' => :'alg_testnet'
       }
     end
 
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'addr' => :'String'
+        :'alg_mainnet' => :'Hash<String, WalletBalance>',
+        :'alg_testnet' => :'Hash<String, WalletBalance>'
       }
     end
 
@@ -37,46 +40,44 @@ module BleumiPay
       ])
     end
 
-    def eth_address?(str)
-      # We use !! to convert the return value to a boolean
-      !!(str =~ /^0x[a-fA-F0-9]{40}$/)
-    end
-
     # Initializes the object
     # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(value)
-      
-      if (!eth_address?(value)) 
-        fail ArgumentError, "`#{value}` The input argument must be valid Ethereum Address `BleumiPay::EthAddress` initialize method"
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `BleumiPay::AlgorandBalance` initialize method"
       end
 
-      self.addr = value
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `BleumiPay::AlgorandBalance`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
 
-    end
+      if attributes.key?(:'alg_mainnet')
+        if (value = attributes[:'alg_mainnet']).is_a?(Hash)
+          self.alg_mainnet = value
+        end
+      end
 
-    # validation for updating addr using setter of addr
-    def addr=(new_addr)
-      if ((eth_address?(new_addr))||(new_addr == "ETH")||(new_addr == "XDAI")||(new_addr == "XDAIT")) 
-        fail ArgumentError, "`#{new_addr}` The input argument must be valid Token `BleumiPay::Token` initialize method"
+      if attributes.key?(:'alg_testnet')
+        if (value = attributes[:'alg_testnet']).is_a?(Hash)
+          self.alg_testnet = value
+        end
       end
-      @addr = new_addr
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @addr.nil?
-        invalid_properties.push('invalid value for "addr", addr cannot be nil.')
-      end
-
       invalid_properties
     end
 
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @addr.nil?
       true
     end
 
@@ -85,7 +86,8 @@ module BleumiPay
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          addr == o.addr
+          alg_mainnet == o.alg_mainnet &&
+          alg_testnet == o.alg_testnet
     end
 
     # @see the `==` method
@@ -97,7 +99,7 @@ module BleumiPay
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [addr].hash
+      [alg_mainnet, alg_testnet].hash
     end
 
     # Builds the object from hash
@@ -183,14 +185,17 @@ module BleumiPay
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
     def to_hash
-      # hash = {}
-      # self.class.attribute_map.each_pair do |attr, param|
-      #   value = self.send(attr)
-      #   next if value.nil?
-      #   hash[param] = _to_hash(value)
-      # end
-      # hash
-      addr
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
     end
 
     # Outputs non-array value in the form of hash