blockchyp 2.1.1 → 2.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c859d520b3822383883c919031cf411229bc09a70b6d31b3712b517968e9100b
-  data.tar.gz: 70583159bc0f7b283ee28c05c0eb7bb8c2f46e5691a71bd00a6fbf19d65d2668
+  metadata.gz: 4569f1fe2455fe98d3e09d7ed59c9d91f81bc366bcfc7b64dfbbaf1026443670
+  data.tar.gz: 6ce270e6356101d6afee6b72462e6c6580dc59e1203e74b288ef0d5db2cb5e2c
 SHA512:
-  metadata.gz: 0f64edb307238b607d00cb2d4708a49368bd17046b8a7b4b8bb8576e15ef642df391880c859ce902cefa49a2d6c899c40cd1f333c860e2794e5cf02ee3f4b1a1
-  data.tar.gz: e800ed14fad77f8df47692c1137b9de294973e08da0515bfcf004a705272a393eecc6bee7ab9e6d39b36833f03b8d0eb51c4948c080c4659ce21fb8cdaddffea
+  metadata.gz: 24fd0fc590987fa3e552ac0ad9ad6574a01c06c9db34007f9db5432deb7db0ca5b83fbf7c5ebc99b46261eae269a15e379de4bd2e43c061a3465b1d98680ec40
+  data.tar.gz: f1df347d1baf97a3275971d0141464dbb980310cfd18ad03196813515fcb2ebc2074b3c9e336804c559b097de111ae01935e850725c9dd6f45da66e8654aa5a1

data/README.md

@@ -25,13 +25,18 @@ to run a basic terminal transaction.
 ```ruby
 require 'blockchyp'
 
-blockchyp = BlockChyp.new("SPBXTSDAQVFFX5MGQMUMIRINVI", "7BXBTBUPSL3BP7I6Z2CFU6H3WQ", "bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e")
+blockchyp = BlockChyp.new(
+  "SPBXTSDAQVFFX5MGQMUMIRINVI",
+  "7BXBTBUPSL3BP7I6Z2CFU6H3WQ",
+  "bcae3708938cb8004ab1278e6c0fcd68f9d815e1c3c86228d028242b147af58e"
+)
 
-# setup request object
-request = Hash.new
-request["test"] = true
-request["terminalName"] = "Test Terminal"
-request["amount"] = "55.00"
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": "Test Terminal",
+  "amount": "55.00"
+}
 
 response = blockchyp.charge(request)
 
@@ -109,11 +114,12 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['amount'] = '55.00'
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "amount": '55.00'
+}
 
 response = blockchyp.charge(request)
 
@@ -138,11 +144,12 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['amount'] = '27.00'
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "amount": '27.00'
+}
 
 response = blockchyp.preauth(request)
 
@@ -167,9 +174,10 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['terminalName'] = 'Test Terminal'
+# Set request parameters
+request = {
+  "terminalName": 'Test Terminal'
+}
 
 response = blockchyp.ping(request)
 
@@ -194,11 +202,12 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['cardType'] = CardType::EBT
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "cardType": CardType::EBT
+}
 
 response = blockchyp.balance(request)
 
@@ -223,10 +232,11 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal'
+}
 
 response = blockchyp.clear(request)
 
@@ -251,16 +261,30 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['tcAlias'] = 'hippa'
-request['tcName'] = 'HIPPA Disclosure'
-request['tcContent'] = 'Full contract text'
-request['sigFormat'] = SignatureFormat::PNG
-request['sigWidth'] = 200
-request['sigRequired'] = true
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+
+  # Alias for a Terms and Conditions template configured in the BlockChyp
+  # dashboard.
+  "tcAlias": 'hippa',
+
+  # Name of the contract or document if not using an alias.
+  "tcName": 'HIPPA Disclosure',
+
+  # Full text of the contract or disclosure if not using an alias.
+  "tcContent": 'Full contract text',
+
+  # File format for the signature image.
+  "sigFormat": SignatureFormat::PNG,
+
+  # Width of the signature image in pixels.
+  "sigWidth": 200,
+
+  # Whether or not a signature is required. Defaults to true.
+  "sigRequired": true
+}
 
 response = blockchyp.termsAndConditions(request)
 
@@ -287,53 +311,34 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['transaction'] = new_transaction_display_transaction
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "transaction": {
+    "subtotal": '60.00',
+    "tax": '5.00',
+    "total": '65.00',
+    "items": [
+      {
+        "description": 'Leki Trekking Poles',
+        "price": '35.00',
+        "quantity": 2,
+        "extended": '70.00',
+        "discounts": [
+          {
+            "description": 'memberDiscount',
+            "amount": '10.00'
+          }
+        ]
+      }
+    ]
+  }
+}
 
 response = blockchyp.updateTransactionDisplay(request)
 
 puts "Response: #{response.inspect}"
-def new_transaction_display_transaction
-  val = {}
-  val['subtotal'] = '60.00'
-  val['tax'] = '5.00'
-  val['total'] = '65.00'
-  val['items'] = new_transaction_display_items
-  val
-end
-
-def new_transaction_display_items
-  val = []
-  val = val.push(new_transaction_display_item_2)
-  val
-end
-
-def new_transaction_display_item_2
-  val = {}
-  val['description'] = 'Leki Trekking Poles'
-  val['price'] = '35.00'
-  val['quantity'] = 2
-  val['extended'] = '70.00'
-  val['discounts'] = new_transaction_display_discounts
-  val
-end
-
-def new_transaction_display_discounts
-  val = []
-  val = val.push(new_transaction_display_discount_2)
-  val
-end
-
-def new_transaction_display_discount_2
-  val = {}
-  val['description'] = 'memberDiscount'
-  val['amount'] = '10.00'
-  val
-end
-
 
 
 ```
@@ -354,53 +359,34 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['transaction'] = new_transaction_display_transaction
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "transaction": {
+    "subtotal": '60.00',
+    "tax": '5.00',
+    "total": '65.00',
+    "items": [
+      {
+        "description": 'Leki Trekking Poles',
+        "price": '35.00',
+        "quantity": 2,
+        "extended": '70.00',
+        "discounts": [
+          {
+            "description": 'memberDiscount',
+            "amount": '10.00'
+          }
+        ]
+      }
+    ]
+  }
+}
 
 response = blockchyp.newTransactionDisplay(request)
 
 puts "Response: #{response.inspect}"
-def new_transaction_display_transaction
-  val = {}
-  val['subtotal'] = '60.00'
-  val['tax'] = '5.00'
-  val['total'] = '65.00'
-  val['items'] = new_transaction_display_items
-  val
-end
-
-def new_transaction_display_items
-  val = []
-  val = val.push(new_transaction_display_item_2)
-  val
-end
-
-def new_transaction_display_item_2
-  val = {}
-  val['description'] = 'Leki Trekking Poles'
-  val['price'] = '35.00'
-  val['quantity'] = 2
-  val['extended'] = '70.00'
-  val['discounts'] = new_transaction_display_discounts
-  val
-end
-
-def new_transaction_display_discounts
-  val = []
-  val = val.push(new_transaction_display_discount_2)
-  val
-end
-
-def new_transaction_display_discount_2
-  val = {}
-  val['description'] = 'memberDiscount'
-  val['amount'] = '10.00'
-  val
-end
-
 
 
 ```
@@ -421,11 +407,15 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['promptType'] = PromptType::EMAIL
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+
+  # Type of prompt. Can be 'email', 'phone', 'customer-number', or
+  # 'rewards-number'.
+  "promptType": PromptType::EMAIL
+}
 
 response = blockchyp.textPrompt(request)
 
@@ -450,13 +440,14 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['prompt'] = 'Would you like to become a member?'
-request['yesCaption'] = 'Yes'
-request['noCaption'] = 'No'
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "prompt": 'Would you like to become a member?',
+  "yesCaption": 'Yes',
+  "noCaption": 'No'
+}
 
 response = blockchyp.booleanPrompt(request)
 
@@ -481,11 +472,12 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['message'] = 'Thank you for your business.'
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "message": 'Thank you for your business.'
+}
 
 response = blockchyp.message(request)
 
@@ -510,11 +502,14 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['terminalName'] = 'Test Terminal'
-request['transactionId'] = '<PREVIOUS TRANSACTION ID>'
-request['amount'] = '5.00'
+# Set request parameters
+request = {
+  "terminalName": 'Test Terminal',
+  "transactionId": '<PREVIOUS TRANSACTION ID>',
+
+  # Optional amount for partial refunds.
+  "amount": '5.00'
+}
 
 response = blockchyp.refund(request)
 
@@ -539,10 +534,11 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal'
+}
 
 response = blockchyp.enroll(request)
 
@@ -567,11 +563,12 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['terminalName'] = 'Test Terminal'
-request['amount'] = '50.00'
+# Set request parameters
+request = {
+  "test": true,
+  "terminalName": 'Test Terminal',
+  "amount": '50.00'
+}
 
 response = blockchyp.giftActivate(request)
 
@@ -604,10 +601,11 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['terminalName'] = 'Test Terminal'
-request['transactionRef'] = '<LAST TRANSACTION REF>'
+# Set request parameters
+request = {
+  "terminalName": 'Test Terminal',
+  "transactionRef": '<LAST TRANSACTION REF>'
+}
 
 response = blockchyp.reverse(request)
 
@@ -632,10 +630,11 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['transactionId'] = '<PREAUTH TRANSACTION ID>'
+# Set request parameters
+request = {
+  "test": true,
+  "transactionId": '<PREAUTH TRANSACTION ID>'
+}
 
 response = blockchyp.capture(request)
 
@@ -660,9 +659,10 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
+# Set request parameters
+request = {
+  "test": true
+}
 
 response = blockchyp.closeBatch(request)
 
@@ -687,10 +687,11 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['test'] = true
-request['transactionId'] = '<PREVIOUS TRANSACTION ID>'
+# Set request parameters
+request = {
+  "test": true,
+  "transactionId": '<PREVIOUS TRANSACTION ID>'
+}
 
 response = blockchyp.void(request)
 
@@ -715,9 +716,10 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['terminalName'] = 'Test Terminal'
+# Set request parameters
+request = {
+  "terminalName": 'Test Terminal'
+}
 
 response = blockchyp.terminalStatus(request)
 
@@ -742,17 +744,193 @@ blockchyp = BlockChyp::BlockChyp.new(
   ENV['BC_SIGNING_KEY']
 )
 
-# setup request object
-request = {}
-request['terminalName'] = 'Test Terminal'
-request['sigFormat'] = SignatureFormat::PNG
-request['sigWidth'] = 200
+# Set request parameters
+request = {
+  "terminalName": 'Test Terminal',
+
+  # File format for the signature image.
+  "sigFormat": SignatureFormat::PNG,
+
+  # Width of the signature image in pixels.
+  "sigWidth": 200
+}
 
 response = blockchyp.captureSignature(request)
 
 puts "Response: #{response.inspect}"
 
 
+```
+
+#### Update Customer
+
+Updates or creates 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 = {
+  "customer": {
+    "id": 'ID of the customer to update',
+    "customerRef": 'Customer reference string',
+    "firstName": 'FirstName',
+    "lastName": 'LastName',
+    "companyName": 'Company Name',
+    "emailAddress": 'support@blockchyp.com',
+    "smsNumber": '(123) 123-1231'
+  }
+}
+
+response = blockchyp.updateCustomer(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Retrieve Customer
+
+Retrieves a customer by id.
+
+
+```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 retrieve'
+}
+
+response = blockchyp.customer(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Search Customer
+
+Searches the customer database.
+
+
+```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 = {
+  "query": '(123) 123-1234'
+}
+
+response = blockchyp.customerSearch(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Transaction Status
+
+Retrieves the current status of a transaction.
+
+
+```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 = {
+  "transactionId": 'ID of transaction to retrieve'
+}
+
+response = blockchyp.transactionStatus(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Send Payment Link
+
+Creates and send a payment link to a customer.
+
+
+```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 = {
+  "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.sendPaymentLink(request)
+
+puts "Response: #{response.inspect}"
+
+
 ```
 
 ## Running Integration Tests