blockchyp 2.16.5 → 2.18.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 898acc6744b68f3722a4df56bec008ba7c2f52a4f1e12d3c008b6beeafd1b999
-  data.tar.gz: 1f662e1e7cb54df1f7d22378cea7ec850b6ab64a571f3097b71adaa6d8e56071
+  metadata.gz: 606f3f0b5ef479d745a12529f21e91ecbd57395fd416a616cab672b5638964fe
+  data.tar.gz: 549bcdbd402a5ef557183ae9516136711dc9de365fd191b91c3af54b3f3f9570
 SHA512:
-  metadata.gz: 003d1422ad36e95736d6d43f326754e14a6101840dab3b8354cd5c2e4844c8ded1b1cfe6b082cd97890bc3641b7700534b56262bf8c8a2cccab72422d4e2d6ee
-  data.tar.gz: a068009ac83fc6101d2e8aadf8e3650258946b5e8045a1c3d4118ebc2f1ab1f55af68ed35180670027d806d338a33af3156b52b6596eda53a67187cead9b6473
+  metadata.gz: a7976b8d33c00b70cba06e3c8a15500750c17340c15d0e79f25b2c5f7c00582f08f9cd6fcc594e06a7c1cafce220899737032ab4aa0927dd0a5cb49ce68da85d
+  data.tar.gz: eee7b97e37cc98e8211ad6f192cf3e3ca2d7325abf22a6ec7a1f2f98678f4a34095fe7d88740900bd798e7df72beabb922d840fa6cc15cc7b71a225ff6d1ee6a

data/README.md

@@ -3942,6 +3942,310 @@ puts "Response: #{response.inspect}"
 
 ```
 
+### Partner Utilities
+
+
+These partner only APIs give ISV partners advanced reporting and tools for managing their portfolio.
+
+Most of the APIs below are for portfolio reporting and range from basic partner commission statements
+to individual statements with all underlying card brand data.
+
+We also provide a pricing policy API that enables partners to pull down the current pricing rules
+in force for any merchant in their portfolio.
+
+<aside class="info">
+<b>Currency Data</b>
+<p>
+All partner APIs return currency and percentage values in two formats: floating point and formatted strings.
+</p>
+<p>
+It's recommended that all developers use the formatted string as this will ensure the most precise values.
+Floating point numbers are usually not appropriate for currency or fixed point decimal numbers as
+the underlying binary encoding can lead to errors in precision.  We provide floating point values
+only as a convenience for developers want to save development time and can live with approximated
+values in their use case.
+</p>
+</aside>
+
+
+
+#### Retrieve Pricing Policy
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns the current pricing policy for a merchant.  This API is valid for partner scoped API credentials
+and `merchantId` is a required parameter.  By default this API returns the currently in-force pricing policy for a merchant,
+but other inactive policies can be returned by providing the `id` parameter.
+
+Buy rates for interchange plus and fixed rate pricing are always returned, but only the pricing related to the 
+pricing model type (flat rate or interchange plus) are actually used in fee calculation.
+
+Each pricing level returns three values: `buyRate`, `current`, and `limit`.  The actual price the merchant will pay is 
+given in the `current` field.  The other values reflect the contract minimum (`buyRate`) and maximum (`limit`) range
+the partner can use when changing prices.
+
+
+
+
+```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 = {
+}
+
+response = blockchyp.pricingPolicy(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Partner Statements
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns a list of partner residual statements.  By default, all statements are returned with the most recent
+statements listed first.  Optional date parameters (`startDate` and `endDate`) can filter statements to a specific date range.
+
+The list of statements returns basic information about statements like volume, transaction count, and commissions earned.
+
+Use the `id` returned with each statement summary with the *Partner Statement Detail* API to pull down full details.
+
+
+
+
+```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 = {
+}
+
+response = blockchyp.partnerStatements(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Partner Statement Detail
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns detailed information about a specific partner statement.  Aggregate data is returned along with
+line item level data for each underlying merchant statement.
+
+Use the merchant invoice id with the *Merchant Statement Detail* API and the *Partner Commission Breakdown* API 
+to get the merchant statement and the card brand fee cost breakdown respectively.
+
+
+
+
+```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 = {
+}
+
+response = blockchyp.partnerStatementDetail(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Merchant Invoices
+
+
+
+* **API Credential Types:** Partner or Merchant
+* **Required Role:** Partner API Access or Merchant API 
+
+The API returns a list of merchant statements and invoices.  By default, all invoices are returned with the most recent
+statements listed first.  Optional date parameters (`startDate` and `endDate`) can be used to filter statements by date
+range. 
+
+The `invoiceType` parameter can also be used to filter invoices by type.  Invoices could be conventional invoices, such
+as those generated when ordering terminals or gift cards, or invoices could be merchant statements.
+
+
+
+
+```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 = {
+}
+
+response = blockchyp.merchantInvoices(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Merchant Invoice Detail
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+The API returns detailed information about a specific merchant statement or invoice.
+
+All line items are returned a topographically sorted tree modeling the nested line item structure of the 
+invoice.  Details about any payments posted against the invoice are returned.
+
+It the invoice is a merchant statement, details about every merchant deposit that occurred during the statement period
+are also returned.
+
+
+
+
+```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 = {
+}
+
+response = blockchyp.merchantInvoiceDetail(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Partner Commission Breakdown
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+This API allows partners to pull down the low level data used to compute a partner commission for a specific merchant statement.
+
+The `statementId` is required and must be the id of a valid merchant invoice of type `statement`.
+
+
+
+
+```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 = {
+}
+
+response = blockchyp.partnerCommissionBreakdown(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
+#### Merchant Credential Generation
+
+
+
+* **API Credential Types:** Partner
+* **Required Role:** Partner API Access
+
+This API allows partners to generate API credentials for a merchant.
+
+The `merchantId` is required and must be the id of a valid merchant.
+
+Credentials are not delete protected by default. Pass in `deleteProtected` to enable delete protection.
+
+The optional `notes` field will populate the notes in the credentials.
+
+By default no roles will be assigned unless valid, comma-delimited, role codes are passed in the `roles` field.
+
+
+
+
+```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 = {
+}
+
+response = blockchyp.merchantCredentialGeneration(request)
+
+puts "Response: #{response.inspect}"
+
+
+```
+
 
 
 

data/lib/blockchyp/version.rb

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

data/lib/blockchyp.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.
@@ -264,6 +264,37 @@ module BlockChyp
       gateway_request('POST', '/api/tx-history', request)
     end
 
+    # Returns pricing policy for a merchant.
+    def pricing_policy(request)
+      gateway_request('POST', '/api/read-pricing-policy', request)
+    end
+
+    # Returns a list of partner statements.
+    def partner_statements(request)
+      gateway_request('POST', '/api/partner-statement-list', request)
+    end
+
+    # Returns detail for a single partner statement.
+    def partner_statement_detail(request)
+      gateway_request('POST', '/api/partner-statement-detail', request)
+    end
+
+    # Returns a list of merchant invoices.
+    def merchant_invoices(request)
+      gateway_request('POST', '/api/merchant-invoice-list', request)
+    end
+
+    # Returns detail for a single merchant-invoice statement.
+    def merchant_invoice_detail(request)
+      gateway_request('POST', '/api/merchant-invoice-detail', request)
+    end
+
+    # Returns low level details for how partner commissions were calculated
+    # for a specific merchant statement.
+    def partner_commission_breakdown(request)
+      gateway_request('POST', '/api/partner-commission-breakdown', request)
+    end
+
     # Returns profile information for a merchant.
     def merchant_profile(request)
       gateway_request('POST', '/api/public-merchant-profile', request)
@@ -295,6 +326,11 @@ module BlockChyp
     end
 
 
+    # Generates and returns api credentials for a given merchant.
+    def merchant_credential_generation(request)
+      dashboard_request('POST', '/api/generate-merchant-creds', request)
+    end
+
     # Adds a test merchant account.
     def get_merchants(request)
       dashboard_request('POST', '/api/get-merchants', request)

data/test/_test.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# Copyright 2019-2024 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 Test < TestCase
+    def test_
+
+      puts "Running test_..."
+
+      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 = {
+      }
+
+      response = blockchyp.merchant_credential_generation(request)
+      assert_not_nil(response)
+      # response assertions
+    end
+  end
+end

data/test/activate_terminal_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/add_test_merchant_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/batch_history_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/boolean_prompt_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/cancel_payment_link_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.
@@ -60,6 +60,7 @@ module BlockChyp
 
       # Set request parameters
       request = {
+        test: true,
         linkCode: response[:linkCode]
       }
 

data/test/capture_signature_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/deactivate_terminal_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_branding_asset_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_customer_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_media_asset_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_queued_transaction_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_slide_show_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_survey_question_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_test_merchant_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/delete_token_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/empty_branding_asset_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/empty_slide_show_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/gateway_timeout_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/get_customer_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/get_merchants_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/invite_merchant_user_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/link_token_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/list_queued_transactions_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/list_terminals_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/media_asset_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.

data/test/media_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2019-2023 BlockChyp, Inc. All rights reserved. Use of this code is
+# Copyright 2019-2024 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.