blockchyp 2.3.7 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84600e7a021f154105d836a1de1e8b91d61b938b29bfc56d61301ca6c03abff6
-  data.tar.gz: ba8d5e4fffb814af4171aae03ad55f204ee9abd0d9d8fbc49681b91bd71aba39
+  metadata.gz: 49dc32372aabccb3d15971f69deb80b427934ddc9c810fa5e9132c6856b12b90
+  data.tar.gz: 21ad4be26072a746a7db7494ae60c624f0aab00f17dd6c49e60a3a442578251e
 SHA512:
-  metadata.gz: d3d544fecac3fe221cb8a3afa65d7a835999385c48782be5e6cbd7c62821781b52b4b6c3bb5c63a373096ae083be2f451f70e8fef0f7670ae4bef19d621dd989
-  data.tar.gz: 9c5b14f4bf92c016da7ea7d901d5fabd8afb5f668449ab92fb6813e1979caf849bff0d37368c893f801b83f534c014a7eda9c4b7e8c115a270b7deab2303da63
+  metadata.gz: b9871571c1d25f338af7a5419ef5c369ab41428d373fa7fabed9d5e94aafea9e5cefa06350bcc65c20d13bcbedd8ef0fe25682c8f1a58e58b70ec6763ff938a8
+  data.tar.gz: b899f32df715af449cd2a00e8d1c3f0e2d88118259a7d27ccd3708f792da3f04e23dcefd8da27f9a85c6b142e84a2c92a75cdb0e4bd5547cb42374a298499d56

data/README.md

@@ -104,7 +104,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal'
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.ping(request)
@@ -166,9 +166,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '55.00'
+  test: true,
+  terminalName: 'Test Terminal',
+  amount: '55.00'
 }
 
 response = blockchyp.charge(request)
@@ -230,9 +230,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '27.00'
+  test: true,
+  terminalName: 'Test Terminal',
+  amount: '27.00'
 }
 
 response = blockchyp.preauth(request)
@@ -270,8 +270,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "transactionId": '<PREAUTH TRANSACTION ID>'
+  test: true,
+  transactionId: '<PREAUTH TRANSACTION ID>'
 }
 
 response = blockchyp.capture(request)
@@ -346,10 +346,10 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "transactionId": '<PREVIOUS TRANSACTION ID>',
+  transactionId: '<PREVIOUS TRANSACTION ID>',
 
   # Optional amount for partial refunds.
-  "amount": '5.00'
+  amount: '5.00'
 }
 
 response = blockchyp.refund(request)
@@ -394,8 +394,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal'
+  test: true,
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.enroll(request)
@@ -431,8 +431,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "transactionId": '<PREVIOUS TRANSACTION ID>'
+  test: true,
+  transactionId: '<PREVIOUS TRANSACTION ID>'
 }
 
 response = blockchyp.void(request)
@@ -479,7 +479,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "transactionRef": '<LAST TRANSACTION REF>'
+  transactionRef: '<LAST TRANSACTION REF>'
 }
 
 response = blockchyp.reverse(request)
@@ -559,9 +559,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "amount": '50.00'
+  test: true,
+  terminalName: 'Test Terminal',
+  amount: '50.00'
 }
 
 response = blockchyp.giftActivate(request)
@@ -617,9 +617,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "cardType": CardType::EBT
+  test: true,
+  terminalName: 'Test Terminal',
+  cardType: CardType::EBT
 }
 
 response = blockchyp.balance(request)
@@ -656,7 +656,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true
+  test: true
 }
 
 response = blockchyp.closeBatch(request)
@@ -717,6 +717,11 @@ a safeguard to prevent real emails from going out when you may not expect it.
 If you want BlockChyp to send the email for you, just add the `autoSend` flag with
 all requests.
 
+**Tokenization**
+
+Add the `enroll` flag to a send link request to enroll the payment method
+in the token vault.
+
 **Cashier Facing Card Entry**
 
 BlockChyp can be used to generate internal/cashier facing card entry pages as well.  This is
@@ -768,29 +773,29 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "amount": '199.99',
-  "description": 'Widget',
-  "subject": 'Widget invoice',
-  "transaction": {
-    "subtotal": '195.00',
-    "tax": '4.99',
-    "total": '199.99',
-    "items": [
+  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
+        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'
+  autoSend: true,
+  customer: {
+    customerRef: 'Customer reference string',
+    firstName: 'FirstName',
+    lastName: 'LastName',
+    companyName: 'Company Name',
+    emailAddress: 'support@blockchyp.com',
+    smsNumber: '(123) 123-1231'
   }
 }
 
@@ -828,7 +833,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "transactionId": 'ID of transaction to retrieve'
+  transactionId: 'ID of transaction to retrieve'
 }
 
 response = blockchyp.transactionStatus(request)
@@ -862,8 +867,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal'
+  test: true,
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.clear(request)
@@ -904,7 +909,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal'
+  terminalName: 'Test Terminal'
 }
 
 response = blockchyp.terminalStatus(request)
@@ -972,27 +977,27 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
+  test: true,
+  terminalName: 'Test Terminal',
 
   # Alias for a Terms and Conditions template configured in the BlockChyp
   # dashboard.
-  "tcAlias": 'hippa',
+  tcAlias: 'hippa',
 
   # Name of the contract or document if not using an alias.
-  "tcName": 'HIPPA Disclosure',
+  tcName: 'HIPPA Disclosure',
 
   # Full text of the contract or disclosure if not using an alias.
-  "tcContent": 'Full contract text',
+  tcContent: 'Full contract text',
 
   # File format for the signature image.
-  "sigFormat": SignatureFormat::PNG,
+  sigFormat: SignatureFormat::PNG,
 
   # Width of the signature image in pixels.
-  "sigWidth": 200,
+  sigWidth: 200,
 
   # Whether or not a signature is required. Defaults to true.
-  "sigRequired": true
+  sigRequired: true
 }
 
 response = blockchyp.termsAndConditions(request)
@@ -1041,13 +1046,13 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "terminalName": 'Test Terminal',
+  terminalName: 'Test Terminal',
 
   # File format for the signature image.
-  "sigFormat": SignatureFormat::PNG,
+  sigFormat: SignatureFormat::PNG,
 
   # Width of the signature image in pixels.
-  "sigWidth": 200
+  sigWidth: 200
 }
 
 response = blockchyp.captureSignature(request)
@@ -1097,22 +1102,22 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "transaction": {
-    "subtotal": '60.00',
-    "tax": '5.00',
-    "total": '65.00',
-    "items": [
+  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: 'Leki Trekking Poles',
+        price: '35.00',
+        quantity: 2,
+        extended: '70.00',
+        discounts: [
           {
-            "description": 'memberDiscount',
-            "amount": '10.00'
+            description: 'memberDiscount',
+            amount: '10.00'
           }
         ]
       }
@@ -1175,22 +1180,22 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "transaction": {
-    "subtotal": '60.00',
-    "tax": '5.00',
-    "total": '65.00',
-    "items": [
+  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: 'Leki Trekking Poles',
+        price: '35.00',
+        quantity: 2,
+        extended: '70.00',
+        discounts: [
           {
-            "description": 'memberDiscount',
-            "amount": '10.00'
+            description: 'memberDiscount',
+            amount: '10.00'
           }
         ]
       }
@@ -1229,9 +1234,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "message": 'Thank you for your business.'
+  test: true,
+  terminalName: 'Test Terminal',
+  message: 'Thank you for your business.'
 }
 
 response = blockchyp.message(request)
@@ -1274,11 +1279,11 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
-  "prompt": 'Would you like to become a member?',
-  "yesCaption": 'Yes',
-  "noCaption": 'No'
+  test: true,
+  terminalName: 'Test Terminal',
+  prompt: 'Would you like to become a member?',
+  yesCaption: 'Yes',
+  noCaption: 'No'
 }
 
 response = blockchyp.booleanPrompt(request)
@@ -1330,12 +1335,12 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "test": true,
-  "terminalName": 'Test Terminal',
+  test: true,
+  terminalName: 'Test Terminal',
 
   # Type of prompt. Can be 'email', 'phone', 'customer-number', or
   # 'rewards-number'.
-  "promptType": PromptType::EMAIL
+  promptType: PromptType::EMAIL
 }
 
 response = blockchyp.textPrompt(request)
@@ -1389,14 +1394,14 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # 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'
+  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'
   }
 }
 
@@ -1432,7 +1437,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "customerId": 'ID of the customer to retrieve'
+  customerId: 'ID of the customer to retrieve'
 }
 
 response = blockchyp.customer(request)
@@ -1467,7 +1472,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "query": '(123) 123-1234'
+  query: '(123) 123-1234'
 }
 
 response = blockchyp.customerSearch(request)
@@ -1503,9 +1508,9 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "amount": '100.00',
-  "cashDiscount": true,
-  "surcharge": true
+  amount: '100.00',
+  cashDiscount: true,
+  surcharge: true
 }
 
 response = blockchyp.cashDiscount(request)
@@ -1557,8 +1562,8 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "maxResults": 250,
-  "startIndex": 1
+  maxResults: 250,
+  startIndex: 1
 }
 
 response = blockchyp.batchHistory(request)
@@ -1596,7 +1601,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "batchId": 'BATCHID'
+  batchId: 'BATCHID'
 }
 
 response = blockchyp.batchDetails(request)
@@ -1664,7 +1669,7 @@ blockchyp = BlockChyp::BlockChyp.new(
 
 # Set request parameters
 request = {
-  "maxResults": 10
+  maxResults: 10
 }
 
 response = blockchyp.transactionHistory(request)