blockchyp 2.10.0 → 2.13.0

data/lib/blockchyp/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlockChyp
-  VERSION = '2.10.0'
+  VERSION = '2.13.0'
 end

data/lib/blockchyp.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2022 BlockChyp, Inc. All rights reserved. Use of this code is
 # governed by a license that can be found in the LICENSE file.
 #
-# This file was generated automatically. Changes to this file will be lost
-# every time the code is regenerated.
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
 
 require_relative 'blockchyp_client'
 
@@ -13,6 +13,7 @@ module CardType
   DEBIT = 1
   EBT = 2
   BLOCKCHAIN_GIFT = 3
+  HEALTHCARE = 4
 end
 
 module SignatureFormat
@@ -50,6 +51,14 @@ module CVMType
   NO_CVM = 'No CVM'
 end
 
+module HealthcareType
+  HEALTHCARE = 'healthcare'
+  PRESCRIPTION = 'prescription'
+  VISION = 'vision'
+  CLINIC = 'clinic'
+  DENTAL = 'dental'
+end
+
 module BlockChyp
   # the main autogenerated blockchyp client
   class BlockChyp < BlockChypClient
@@ -149,7 +158,17 @@ module BlockChyp
     def delete_queued_transaction(request)
       route_terminal_request('POST', '/api/queue/delete', '/api/queue/delete', request)
     end
+
+    # Reboot a payment terminal.
+    def reboot(request)
+      route_terminal_request('POST', '/api/reboot', '/api/terminal-reboot', request)
+    end
     
+    # Returns routing and location data for a payment terminal.
+    def locate(request)
+      gateway_request('POST', '/api/terminal-locate', request)
+    end
+
     # Captures a preauthorization.
     def capture(request)
       gateway_request('POST', '/api/capture', request)
@@ -239,10 +258,205 @@ module BlockChyp
       gateway_request('DELETE', '/api/customer/' + request[:customerId], request)
     end
 
+    # Retrieves payment token metadata.
+    def token_metadata(request)
+      gateway_request('GET', '/api/token/' + request[:token], request)
+    end
+
+    # Links a token to a customer record.
+    def link_token(request)
+      gateway_request('POST', '/api/link-token', request)
+    end
+
+    # Removes a link between a customer and a token.
+    def unlink_token(request)
+      gateway_request('POST', '/api/unlink-token', request)
+    end
+
     # Deletes a payment token.
     def delete_token(request)
       gateway_request('DELETE', '/api/token/' + request[:token], request)
     end
 
+
+    # Adds a test merchant account.
+    def get_merchants(request)
+      dashboard_request('POST', '/api/get-merchants', request)
+    end
+
+    # Adds or updates a merchant account. Can be used to create or update test
+    # merchants. Only gateway partners may create new live merchants.
+    def update_merchant(request)
+      dashboard_request('POST', '/api/update-merchant', request)
+    end
+
+    # List all active users and pending invites for a merchant account.
+    def merchant_users(request)
+      dashboard_request('POST', '/api/merchant-users', request)
+    end
+
+    # Invites a user to join a merchant account.
+    def invite_merchant_user(request)
+      dashboard_request('POST', '/api/invite-merchant-user', request)
+    end
+
+    # Adds a test merchant account.
+    def add_test_merchant(request)
+      dashboard_request('POST', '/api/add-test-merchant', request)
+    end
+
+    # Deletes a test merchant account. Supports partner scoped API credentials
+    # only. Live merchant accounts cannot be deleted.
+    def delete_test_merchant(request)
+      dashboard_request('DELETE', '/api/test-merchant/' + request[:merchantId], request)
+    end
+
+    # List all merchant platforms configured for a gateway merchant.
+    def merchant_platforms(request)
+      dashboard_request('GET', '/api/plugin-configs/' + request[:merchantId], request)
+    end
+
+    # List all merchant platforms configured for a gateway merchant.
+    def update_merchant_platforms(request)
+      dashboard_request('POST', '/api/plugin-configs', request)
+    end
+
+    # Deletes a boarding platform configuration.
+    def delete_merchant_platforms(request)
+      dashboard_request('DELETE', '/api/plugin-config/' + request[:platformId], request)
+    end
+
+    # Returns all terminals associated with the merchant account.
+    def terminals(request)
+      dashboard_request('GET', '/api/terminals', request)
+    end
+
+    # Deactivates a terminal.
+    def deactivate_terminal(request)
+      dashboard_request('DELETE', '/api/terminal/' + request[:terminalId], request)
+    end
+
+    # Activates a terminal.
+    def activate_terminal(request)
+      dashboard_request('POST', '/api/terminal-activate', request)
+    end
+
+    # Returns a list of terms and conditions templates associated with a
+    # merchant account.
+    def tc_templates(request)
+      dashboard_request('GET', '/api/tc-templates', request)
+    end
+
+    # Returns a single terms and conditions template.
+    def tc_template(request)
+      dashboard_request('GET', '/api/tc-templates/' + request[:templateId], request)
+    end
+
+    # Updates or creates a terms and conditions template.
+    def tc_update_template(request)
+      dashboard_request('POST', '/api/tc-templates', request)
+    end
+
+    # Deletes a single terms and conditions template.
+    def tc_delete_template(request)
+      dashboard_request('DELETE', '/api/tc-templates/' + request[:templateId], request)
+    end
+
+    # Returns up to 250 entries from the Terms and Conditions log.
+    def tc_log(request)
+      dashboard_request('POST', '/api/tc-log', request)
+    end
+
+    # Returns a single detailed Terms and Conditions entry.
+    def tc_entry(request)
+      dashboard_request('GET', '/api/tc-entry/' + request[:logEntryId], request)
+    end
+
+    # Returns all survey questions for a given merchant.
+    def survey_questions(request)
+      dashboard_request('GET', '/api/survey-questions', request)
+    end
+
+    # Returns a single survey question with response data.
+    def survey_question(request)
+      dashboard_request('GET', '/api/survey-questions/' + request[:questionId], request)
+    end
+
+    # Updates or creates a survey question.
+    def update_survey_question(request)
+      dashboard_request('POST', '/api/survey-questions', request)
+    end
+
+    # Deletes a survey question.
+    def delete_survey_question(request)
+      dashboard_request('DELETE', '/api/survey-questions/' + request[:questionId], request)
+    end
+
+    # Returns results for a single survey question.
+    def survey_results(request)
+      dashboard_request('POST', '/api/survey-results', request)
+    end
+
+    # Returns the media library for a given partner, merchant, or
+    # organization.
+    def media(request)
+      dashboard_request('GET', '/api/media', request)
+    end
+
+    # Uploads a media asset to the media library.
+    def upload_media(request, file)
+      upload_request('/api/upload-media', request, file)
+    end
+
+    # Retrieves the current status of a file upload.
+    def upload_status(request)
+      dashboard_request('GET', '/api/media-upload/' + request[:uploadId], request)
+    end
+
+    # Returns the media details for a single media asset.
+    def media_asset(request)
+      dashboard_request('GET', '/api/media/' + request[:mediaId], request)
+    end
+
+    # Deletes a media asset.
+    def delete_media_asset(request)
+      dashboard_request('DELETE', '/api/media/' + request[:mediaId], request)
+    end
+
+    # Returns a collection of slide shows.
+    def slide_shows(request)
+      dashboard_request('GET', '/api/slide-shows', request)
+    end
+
+    # Returns a single slide show with slides.
+    def slide_show(request)
+      dashboard_request('GET', '/api/slide-shows/' + request[:slideShowId], request)
+    end
+
+    # Updates or creates a slide show.
+    def update_slide_show(request)
+      dashboard_request('POST', '/api/slide-shows', request)
+    end
+
+    # Deletes a single slide show.
+    def delete_slide_show(request)
+      dashboard_request('DELETE', '/api/slide-shows/' + request[:slideShowId], request)
+    end
+
+    # Returns the terminal branding stack for a given set of API credentials.
+    def terminal_branding(request)
+      dashboard_request('GET', '/api/terminal-branding', request)
+    end
+
+    # Updates a branding asset.
+    def update_branding_asset(request)
+      dashboard_request('POST', '/api/terminal-branding', request)
+    end
+
+    # Deletes a branding asset.
+    def delete_branding_asset(request)
+      dashboard_request('DELETE', '/api/terminal-branding/' + request[:assetId], request)
+    end
+
   end
 end

data/lib/blockchyp_client.rb

@@ -21,6 +21,7 @@ module BlockChyp
       @signing_key = signing_key
       @gateway_host = 'https://api.blockchyp.com'
       @test_gateway_host = 'https://test.blockchyp.com'
+      @dashboard_host = 'https://dashboard.blockchyp.com'
       @https = false
       @route_cache_location = File.join(Dir.tmpdir, '.blockchyp_route')
       @route_cache_ttl = 60
@@ -38,6 +39,7 @@ module BlockChyp
     attr_reader :offline_fixed_key
     attr_accessor :gateway_host
     attr_accessor :test_gateway_host
+    attr_accessor :dashboard_host
     attr_accessor :https
     attr_accessor :route_cache_ttl
     attr_accessor :gateway_timeout
@@ -72,6 +74,10 @@ module BlockChyp
       URI.parse(path.nil? ? url : url + path)
     end
 
+    def resolve_dashboard_uri(path, request)
+      URI.parse(dashboard_host + path)
+    end
+
     def generate_error_response(msg)
       {
         success: false,
@@ -165,6 +171,78 @@ module BlockChyp
       URI.parse(url + port + path)
     end
 
+    def dashboard_request(method, path, request = nil)
+      uri = resolve_dashboard_uri(path, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.instance_of?(URI::HTTPS)
+      timeout = get_timeout(request, gateway_timeout)
+      http.open_timeout = timeout
+      http.read_timeout = timeout
+
+      req = get_http_request(method, uri)
+
+      req['User-Agent'] = user_agent
+      unless request.nil?
+        json = request.to_json
+        req['Content-Type'] = 'application/json'
+        req['Content-Length'] = json.length
+        req.body = json
+      end
+
+      headers = generate_gateway_headers
+      headers.each do |key, value|
+        req[key] = value
+      end
+
+      response = http.request(req)
+
+      if response.is_a?(Net::HTTPSuccess)
+        JSON.parse(response.body, symbolize_names: true)
+      else
+        raise response.message
+      end
+    end
+
+    def upload_request(path, request, content)
+      uri = resolve_dashboard_uri(path, request)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = uri.instance_of?(URI::HTTPS)
+      timeout = get_timeout(request, gateway_timeout)
+      http.open_timeout = timeout
+      http.read_timeout = timeout
+
+      req = get_http_request("POST", uri)
+      req.body = content
+      req['User-Agent'] = user_agent
+      req['Content-Type'] = 'application/octet-stream'
+
+      if request[:fileName]
+        req['X-Upload-File-Name'] = request[:fileName]
+      end
+
+      if request[:uploadId]
+        req['X-Upload-ID'] = request[:uploadId]
+      end
+
+      if request[:fileSize]
+        req['X-File-Size'] = request[:fileSize]
+        req['Content-Length'] = request[:fileSize]
+      end
+
+      headers = generate_gateway_headers
+      headers.each do |key, value|
+        req[key] = value
+      end
+
+      response = http.request(req)
+
+      if response.is_a?(Net::HTTPSuccess)
+        JSON.parse(response.body, symbolize_names: true)
+      else
+        raise response.message
+      end
+    end
+
     def gateway_request(method, path, request = nil, relay = false)
       uri = resolve_gateway_uri(path, request)
       http = Net::HTTP.new(uri.host, uri.port)

data/test/activate_terminal_test.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2022 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class ActivateTerminalTest < TestCase
+    def test_activate_terminal
+
+      puts "Running test_activate_terminal..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+
+
+      # Set request parameters
+      request = {
+        terminalName: 'Bad Terminal Code',
+        activationCode: 'XXXXXX'
+      }
+
+      response = blockchyp.activate_terminal(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(!response[:success])
+      assert_equal('Invalid Activation Code', response[:error])
+    end
+  end
+end

data/test/add_test_merchant_test.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2022 BlockChyp, Inc. All rights reserved. Use of this code is
+# governed by a license that can be found in the LICENSE file.
+#
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class AddTestMerchantTest < TestCase
+    def test_add_test_merchant
+
+      puts "Running test_add_test_merchant..."
+
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+      profile = config[:profiles][:partner]
+      blockchyp = BlockChyp.new(
+        profile[:apiKey],
+        profile[:bearerToken],
+        profile[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
+      # Set request parameters
+      request = {
+        dbaName: 'Test Merchant',
+        companyName: 'Test Merchant'
+      }
+
+      response = blockchyp.add_test_merchant(request)
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+      assert_equal('Test Merchant', response[:dbaName])
+      assert_equal('Test Merchant', response[:companyName])
+      assert(response[:visa])
+    end
+  end
+end

data/test/batch_history_test.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2022 BlockChyp, Inc. All rights reserved. Use of this code is
 # governed by a license that can be found in the LICENSE file.
 #
-# This file was generated automatically. Changes to this file will be lost
-# every time the code is regenerated.
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
 
 require ::File.expand_path('test_helper', __dir__)
 
 module BlockChyp
   class BatchHistoryTest < TestCase
     def test_batch_history
+
+      puts "Running test_batch_history..."
+
       config = load_test_config
 
       blockchyp = BlockChyp.new(
@@ -20,8 +23,11 @@ module BlockChyp
       )
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
 
-      test_delay(blockchyp, 'batch_history_test', config[:defaultTerminalName])
 
       # Set request parameters
       setup_request = {
@@ -32,7 +38,6 @@ module BlockChyp
         test: true,
         transactionRef: uuid
       }
-
       response = blockchyp.charge(setup_request)
 
       # Set request parameters
@@ -41,7 +46,6 @@ module BlockChyp
       }
 
       response = blockchyp.batch_history(request)
-
       assert_not_nil(response)
       # response assertions
       assert(response[:success])

data/test/boolean_prompt_test.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2022 BlockChyp, Inc. All rights reserved. Use of this code is
 # governed by a license that can be found in the LICENSE file.
 #
-# This file was generated automatically. Changes to this file will be lost
-# every time the code is regenerated.
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
 
 require ::File.expand_path('test_helper', __dir__)
 
 module BlockChyp
   class BooleanPromptTest < TestCase
     def test_boolean_prompt
+
+      puts "Running test_boolean_prompt..."
+
       config = load_test_config
 
       blockchyp = BlockChyp.new(
@@ -20,9 +23,13 @@ module BlockChyp
       )
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
 
       test_delay(blockchyp, 'boolean_prompt_test', config[:defaultTerminalName])
 
+
+
+
       # Set request parameters
       request = {
         test: true,
@@ -33,7 +40,6 @@ module BlockChyp
       }
 
       response = blockchyp.boolean_prompt(request)
-
       assert_not_nil(response)
       # response assertions
       assert(response[:success])

data/test/cancel_payment_link_test.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2022 BlockChyp, Inc. All rights reserved. Use of this code is
 # governed by a license that can be found in the LICENSE file.
 #
-# This file was generated automatically. Changes to this file will be lost
-# every time the code is regenerated.
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
 
 require ::File.expand_path('test_helper', __dir__)
 
 module BlockChyp
   class CancelPaymentLinkTest < TestCase
     def test_cancel_payment_link
+
+      puts "Running test_cancel_payment_link..."
+
       config = load_test_config
 
       blockchyp = BlockChyp.new(
@@ -20,8 +23,11 @@ module BlockChyp
       )
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
+
+
+
 
-      test_delay(blockchyp, 'cancel_payment_link_test', config[:defaultTerminalName])
 
       # Set request parameters
       setup_request = {
@@ -50,7 +56,6 @@ module BlockChyp
           smsNumber: '(123) 123-1231'
         }
       }
-
       response = blockchyp.send_payment_link(setup_request)
 
       # Set request parameters
@@ -59,7 +64,6 @@ module BlockChyp
       }
 
       response = blockchyp.cancel_payment_link(request)
-
       assert_not_nil(response)
       # response assertions
       assert(response[:success])

data/test/capture_signature_test.rb

@@ -1,16 +1,19 @@
 # frozen_string_literal: true
 
-# Copyright 2019 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2022 BlockChyp, Inc. All rights reserved. Use of this code is
 # governed by a license that can be found in the LICENSE file.
 #
-# This file was generated automatically. Changes to this file will be lost
-# every time the code is regenerated.
+# This file was generated automatically by the BlockChyp SDK Generator.
+# Changes to this file will be lost every time the code is regenerated.
 
 require ::File.expand_path('test_helper', __dir__)
 
 module BlockChyp
   class CaptureSignatureTest < TestCase
     def test_capture_signature
+
+      puts "Running test_capture_signature..."
+
       config = load_test_config
 
       blockchyp = BlockChyp.new(
@@ -20,9 +23,13 @@ module BlockChyp
       )
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
+      blockchyp.dashboard_host = config[:dashboardHost]
 
       test_delay(blockchyp, 'capture_signature_test', config[:defaultTerminalName])
 
+
+
+
       # Set request parameters
       request = {
         terminalName: config[:defaultTerminalName],
@@ -31,7 +38,6 @@ module BlockChyp
       }
 
       response = blockchyp.capture_signature(request)
-
       assert_not_nil(response)
       # response assertions
       assert(response[:success])