blockchyp 2.1.1 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c859d520b3822383883c919031cf411229bc09a70b6d31b3712b517968e9100b
-  data.tar.gz: 70583159bc0f7b283ee28c05c0eb7bb8c2f46e5691a71bd00a6fbf19d65d2668
+  metadata.gz: bafab639c7c49cc19c9dd99e655f9f3d3f1243722c545dc6c1151bc8e33cdb11
+  data.tar.gz: a71a85cf2cb5c656154a6903e4e8b80fba5488b69b8db34b7dd027a0796a5c6f
 SHA512:
-  metadata.gz: 0f64edb307238b607d00cb2d4708a49368bd17046b8a7b4b8bb8576e15ef642df391880c859ce902cefa49a2d6c899c40cd1f333c860e2794e5cf02ee3f4b1a1
-  data.tar.gz: e800ed14fad77f8df47692c1137b9de294973e08da0515bfcf004a705272a393eecc6bee7ab9e6d39b36833f03b8d0eb51c4948c080c4659ce21fb8cdaddffea
+  metadata.gz: 6dfb3743c7c1a0b887b53fe06240af3ff003867bd255c3e5726bc261cc1a79715198ff2140057126291a8d61822116d97e80740d9cabb23670c602909f2a4380
+  data.tar.gz: 22dcd330545930b9f26c6620616f1cc2e4a613a0cc8359dc429398b87a5fd2dea749bfe5b080bea7d160b54fff9905ca781346dd7f4a8a08cc0008c1ed231551

data/README.md

@@ -753,6 +753,192 @@ 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']
+)
+
+# setup request object
+request = {}
+request['customer'] = new_customer
+
+response = blockchyp.updateCustomer(request)
+
+puts "Response: #{response.inspect}"
+def new_customer
+  val = {}
+  val['id'] = 'ID of the customer to update'
+  val['customerRef'] = 'Customer reference string'
+  val['firstName'] = 'FirstName'
+  val['lastName'] = 'LastName'
+  val['companyName'] = 'Company Name'
+  val['emailAddress'] = 'support@blockchyp.com'
+  val['smsNumber'] = '(123) 123-1231'
+  val
+end
+
+
+
+```
+
+#### 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']
+)
+
+# setup request object
+request = {}
+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']
+)
+
+# setup request object
+request = {}
+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']
+)
+
+# setup request object
+request = {}
+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']
+)
+
+# setup request object
+request = {}
+request['amount'] = '199.99'
+request['description'] = 'Widget'
+request['subject'] = 'Widget invoice'
+request['transaction'] = new_transaction_display_transaction
+request['autoSend'] = true
+request['customer'] = new_customer
+
+response = blockchyp.sendPaymentLink(request)
+
+puts "Response: #{response.inspect}"
+def new_transaction_display_transaction
+  val = {}
+  val['subtotal'] = '195.00'
+  val['tax'] = '4.99'
+  val['total'] = '199.99'
+  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'] = 'Widget'
+  val['price'] = '195.00'
+  val['quantity'] = 1
+  val
+end
+
+def new_customer
+  val = {}
+  val['customerRef'] = 'Customer reference string'
+  val['firstName'] = 'FirstName'
+  val['lastName'] = 'LastName'
+  val['companyName'] = 'Company Name'
+  val['emailAddress'] = 'support@blockchyp.com'
+  val['smsNumber'] = '(123) 123-1231'
+  val
+end
+
+
+
 ```
 
 ## Running Integration Tests

data/lib/blockchyp.rb

@@ -161,5 +161,30 @@ module BlockChyp
       gateway_request('POST', '/api/void', request)
     end
 
+    # Updates or creates a customer record.
+    def update_customer(request)
+      gateway_request('POST', '/api/update-customer', request)
+    end
+
+    # Retrieves a customer by id.
+    def customer(request)
+      gateway_request('POST', '/api/customer', request)
+    end
+
+    # Searches the customer database.
+    def customer_search(request)
+      gateway_request('POST', '/api/customer-search', request)
+    end
+
+    # Retrieves the current status of a transaction.
+    def transaction_status(request)
+      gateway_request('POST', '/api/tx-status', request)
+    end
+
+    # Creates and send a payment link to a customer.
+    def send_payment_link(request)
+      gateway_request('POST', '/api/send-payment-link', request)
+    end
+
   end
 end

data/lib/blockchyp/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blockchyp
 version: !ruby/object:Gem::Version
-  version: 2.1.1
+  version: 2.2.0
 platform: ruby
 authors:
 - BlockChyp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2020-03-25 00:00:00.000000000 Z
 dependencies: []
 description: 
 email: