blockchyp 2.9.3 → 2.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec22643781b543109c1ee22be54efbf5ebc23bb3978ca4b3a2a28d0b87acfef
-  data.tar.gz: ff30a6fc2884d6be12e4909a186278115998c158c9e6a26db804e7007057cc63
+  metadata.gz: 7da8a06a2cbe8a774c1d32e9173e6dbb4133983b3d6cc35bc4fd3fb608e66eac
+  data.tar.gz: fe6475f6e7fa6bf8833a060a36442277a572f7e0fb52791c9e269347badf74d6
 SHA512:
-  metadata.gz: f741102b25ab25adaed040dd0aff5b1b620bc1af19ada27358a1077c62ae339a10a5b151b4e2f961b3f6abec1ec3242f649f85cdc40f371f057494710ff66fb7
-  data.tar.gz: 494b8f6c7b8f4acf2c2b5de9ee030401414ee7022997b5a3bbdcb7ba47914d56b13a69e1353d826b1f2e51e621952d7dab283bcb2242bf87c558cfc3d4ab21d8
+  metadata.gz: 3074bb48d5b30437dff33215a9e26b6fe52635569021817be27725fc42bfa0b48c47b54e4fa58884ac8ad0c8f0a342c777bab5e95ae48c0c57af7d53f5cfe1d5
+  data.tar.gz: 1c441ce375500443c98836aea6835cfd8da0347eff185fdbe30d7a6842ac6c2de3787f737efe36a6cc6944afb4df030c028fc17498b7e82bbb35f6f1f1fddf17

data/README.md

@@ -112,6 +112,42 @@ response = blockchyp.ping(request)
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### Terminal Locate
+
+
+This endpoint returns routing and location information for a terminal.
+
+The result will indicate whether or not the terminal is in cloud relay mode and will
+return the local IP address if the terminal is in local mode.
+
+The terminal will also return the public key for the terminal.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  terminalName: 'Test Terminal'
+}
+
+response = blockchyp.locate(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 #### Charge
@@ -804,6 +840,38 @@ response = blockchyp.sendPaymentLink(request)
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### Cancel Payment Link
+
+
+
+Cancels a payment link.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  linkCode: 'Payment link code to cancel'
+}
+
+response = blockchyp.cancelPaymentLink(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 #### Transaction Status
@@ -1653,6 +1721,15 @@ None of the above filters are mutually exclusive.  You can combine any of the
 above properties in a single request to restrict transaction results to a
 narrower set of results.
 
+**Searching Transaction History**
+
+You can search transaction history by passing in search criteria with the 
+`query` option.  The search system will match on amount (requested and authorized),
+last four of the card number, cardholder name, and the auth code.
+
+Note that when search queries are used, terminalName or 
+batch id filters are not supported.
+
 
 
 
@@ -1710,6 +1787,247 @@ response = blockchyp.merchantProfile(request)
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### List Queued Transactions
+
+
+
+Returns a list of transaction refs of transactions queued on a terminal.
+Details about the transactions can be retrieved using the Transaction Status
+API.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  terminalName: 'Test Terminal'
+}
+
+response = blockchyp.listQueuedTransactions(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Delete Queued Transaction
+
+
+
+Deletes one or all queued transactions from a terminal. If `*` is passed as
+a transaction ref, then the entire terminal queue will be cleared. An error is
+returned if the passed transaction ref is not queued on the terminal.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  terminalName: 'Test Terminal',
+  transactionRef: '*'
+}
+
+response = blockchyp.deleteQueuedTransaction(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Delete Customer
+
+
+
+Deletes a customer record.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  customerId: 'ID of the customer to delete'
+}
+
+response = blockchyp.deleteCustomer(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Delete Token
+
+
+
+Deletes a payment token from the gateway.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  token: 'Token to delete'
+}
+
+response = blockchyp.deleteToken(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Token Metadata
+
+
+
+Retrieves status and metadata information about a token, 
+including any links to customer records.  
+
+This will also return any customer records related to the card
+behind the token.  If the underlying card has been tokenized
+multiple times, all customers related to the card will be returned,
+even if those customer associations are related to other tokens.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  token: 'Token to retrieve'
+}
+
+response = blockchyp.tokenMetadata(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Link Token
+
+
+
+Links a payment token with a customer record.  Usually this would only be used
+to reverse a previous unlink operation.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  token: 'Token to link',
+  customerId: 'Customer to link'
+}
+
+response = blockchyp.linkToken(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Unlink Token
+
+
+
+Removes a payment token link from a customer record.
+
+This will remove links between the customer record and all tokens
+for the same underlying card.
+
+
+
+
+```ruby
+# frozen_string_literal: true
+
+require 'blockchyp'
+
+blockchyp = BlockChyp::BlockChyp.new(
+  ENV['BC_API_KEY'],
+  ENV['BC_BEARER_TOKEN'],
+  ENV['BC_SIGNING_KEY']
+)
+
+# Set request parameters
+request = {
+  token: 'Token to unlink',
+  customerId: 'Customer to unlink'
+}
+
+response = blockchyp.unlinkToken(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 ## Running Integration Tests

data/lib/blockchyp/version.rb

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

data/lib/blockchyp.rb

@@ -139,7 +139,22 @@ module BlockChyp
     def text_prompt(request)
       route_terminal_request('POST', '/api/text-prompt', '/api/text-prompt', request)
     end
+
+    # Returns a list of queued transactions on a terminal.
+    def list_queued_transactions(request)
+      route_terminal_request('POST', '/api/queue/list', '/api/queue/list', request)
+    end
+
+    # Deletes a queued transaction from the terminal.
+    def delete_queued_transaction(request)
+      route_terminal_request('POST', '/api/queue/delete', '/api/queue/delete', 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)
@@ -174,6 +189,11 @@ module BlockChyp
       gateway_request('POST', '/api/send-payment-link', request)
     end
 
+    # Cancels a payment link.
+    def cancel_payment_link(request)
+      gateway_request('POST', '/api/cancel-payment-link', request)
+    end
+
     # Retrieves the current status of a transaction.
     def transaction_status(request)
       gateway_request('POST', '/api/tx-status', request)
@@ -219,5 +239,30 @@ module BlockChyp
       gateway_request('POST', '/api/public-merchant-profile', request)
     end
 
+    # Deletes a customer record.
+    def delete_customer(request)
+      gateway_request('DELETE', '/api/customer/' + request[:customerId], request)
+    end
+
+    # Deletes a payment token.
+    def delete_token(request)
+      gateway_request('DELETE', '/api/token/' + request[:token], 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
+
   end
 end

data/lib/blockchyp_client.rb

@@ -145,6 +145,8 @@ module BlockChyp
         Net::HTTP::Put.new(uri.request_uri)
       when 'POST'
         Net::HTTP::Post.new(uri.request_uri)
+      when 'DELETE'
+        Net::HTTP::Delete.new(uri.request_uri)
       end
     end
 

data/test/batch_history_test.rb

@@ -21,7 +21,7 @@ module BlockChyp
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
 
-      test_delay(blockchyp, 'batch_history_test')
+      test_delay(blockchyp, 'batch_history_test', config[:defaultTerminalName])
 
       # Set request parameters
       setup_request = {

data/test/boolean_prompt_test.rb

@@ -21,12 +21,12 @@ module BlockChyp
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
 
-      test_delay(blockchyp, 'boolean_prompt_test')
+      test_delay(blockchyp, 'boolean_prompt_test', config[:defaultTerminalName])
 
       # Set request parameters
       request = {
         test: true,
-        terminalName: 'Test Terminal',
+        terminalName: config[:defaultTerminalName],
         prompt: 'Would you like to become a member?',
         yesCaption: 'Yes',
         noCaption: 'No'

data/test/cancel_payment_link_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Copyright 2019 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.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class CancelPaymentLinkTest < TestCase
+    def test_cancel_payment_link
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+
+      test_delay(blockchyp, 'cancel_payment_link_test', config[:defaultTerminalName])
+
+      # Set request parameters
+      setup_request = {
+        amount: '199.99',
+        description: 'Widget',
+        subject: 'Widget invoice',
+        transaction: {
+          subtotal: '195.00',
+          tax: '4.99',
+          total: '199.99',
+          items: [
+            {
+              description: 'Widget',
+              price: '195.00',
+              quantity: 1
+            }
+          ]
+        },
+        autoSend: true,
+        customer: {
+          customerRef: 'Customer reference string',
+          firstName: 'FirstName',
+          lastName: 'LastName',
+          companyName: 'Company Name',
+          emailAddress: 'support@blockchyp.com',
+          smsNumber: '(123) 123-1231'
+        }
+      }
+
+      response = blockchyp.send_payment_link(setup_request)
+
+      # Set request parameters
+      request = {
+        linkCode: response[:linkCode]
+      }
+
+      response = blockchyp.cancel_payment_link(request)
+
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/capture_signature_test.rb

@@ -21,11 +21,11 @@ module BlockChyp
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
 
-      test_delay(blockchyp, 'capture_signature_test')
+      test_delay(blockchyp, 'capture_signature_test', config[:defaultTerminalName])
 
       # Set request parameters
       request = {
-        terminalName: 'Test Terminal',
+        terminalName: config[:defaultTerminalName],
         sigFormat: SignatureFormat::PNG,
         sigWidth: 200
       }

data/test/delete_customer_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2019 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.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class DeleteCustomerTest < TestCase
+    def test_delete_customer
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+
+      test_delay(blockchyp, 'delete_customer_test', config[:defaultTerminalName])
+
+      # Set request parameters
+      setup_request = {
+        customer: {
+          firstName: 'Test',
+          lastName: 'Customer',
+          companyName: 'Test Company',
+          emailAddress: 'support@blockchyp.com',
+          smsNumber: '(123) 123-1234'
+        }
+      }
+
+      response = blockchyp.update_customer(setup_request)
+
+      # Set request parameters
+      request = {
+        customerId: response[:customer][:id]
+      }
+
+      response = blockchyp.delete_customer(request)
+
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/delete_token_test.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+# Copyright 2019 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.
+
+require ::File.expand_path('test_helper', __dir__)
+
+module BlockChyp
+  class DeleteTokenTest < TestCase
+    def test_delete_token
+      config = load_test_config
+
+      blockchyp = BlockChyp.new(
+        config[:apiKey],
+        config[:bearerToken],
+        config[:signingKey]
+      )
+      blockchyp.gateway_host = config[:gatewayHost]
+      blockchyp.test_gateway_host = config[:testGatewayHost]
+
+      test_delay(blockchyp, 'delete_token_test', config[:defaultTerminalName])
+
+      # Set request parameters
+      setup_request = {
+        pan: '4111111111111111',
+        test: true,
+        customer: {
+          customerRef: 'TESTCUSTOMER',
+          firstName: 'Test',
+          lastName: 'Customer'
+        }
+      }
+
+      response = blockchyp.enroll(setup_request)
+
+      # Set request parameters
+      request = {
+        token: response[:token]
+      }
+
+      response = blockchyp.delete_token(request)
+
+      assert_not_nil(response)
+      # response assertions
+      assert(response[:success])
+    end
+  end
+end

data/test/gateway_timeout_test.rb

@@ -21,7 +21,7 @@ module BlockChyp
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
 
-      test_delay(blockchyp, 'gateway_timeout_test')
+      test_delay(blockchyp, 'gateway_timeout_test', config[:defaultTerminalName])
 
       # Set request parameters
       request = {

data/test/get_customer_test.rb

@@ -21,7 +21,7 @@ module BlockChyp
       blockchyp.gateway_host = config[:gatewayHost]
       blockchyp.test_gateway_host = config[:testGatewayHost]
 
-      test_delay(blockchyp, 'get_customer_test')
+      test_delay(blockchyp, 'get_customer_test', config[:defaultTerminalName])
 
       # Set request parameters
       setup_request = {