griffnode 1.0.0

data/docs/TransactionsApi.md

@@ -0,0 +1,295 @@
+# GriffNode::TransactionsApi
+
+All URIs are relative to *https://api.griffnode.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_detailed_transaction**](TransactionsApi.md#create_detailed_transaction) | **POST** /transactions/create-detailed | Create an itemized transaction (Professional/Enterprise plans) |
+| [**create_transaction**](TransactionsApi.md#create_transaction) | **POST** /transactions/create | Create a payment transaction |
+| [**get_transaction**](TransactionsApi.md#get_transaction) | **GET** /transactions/{transaction_id} | Retrieve a single transaction |
+| [**list_transactions**](TransactionsApi.md#list_transactions) | **GET** /transactions/list | List the merchant's transactions (newest first) |
+
+
+## create_detailed_transaction
+
+> <TransactionEnvelope> create_detailed_transaction(create_detailed_transaction_request, opts)
+
+Create an itemized transaction (Professional/Enterprise plans)
+
+### Examples
+
+```ruby
+require 'time'
+require 'griffnode'
+# setup authorization
+GriffNode.configure do |config|
+  # Configure Bearer authorization: SecretKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = GriffNode::TransactionsApi.new
+create_detailed_transaction_request = GriffNode::CreateDetailedTransactionRequest.new({crypto: GriffNode::CryptoSymbol::BTC, items: [GriffNode::LineItem.new({name: 'name_example', price: 3.56})], order_id: 'order_id_example'}) # CreateDetailedTransactionRequest | 
+opts = {
+  x_idempotency_key: 'x_idempotency_key_example' # String | Optional unique key for a create request (e.g. a UUID). A retried create with the same key returns the original transaction instead of creating a duplicate — send it on every create so a network retry can't double-charge the customer. 
+}
+
+begin
+  # Create an itemized transaction (Professional/Enterprise plans)
+  result = api_instance.create_detailed_transaction(create_detailed_transaction_request, opts)
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->create_detailed_transaction: #{e}"
+end
+```
+
+#### Using the create_detailed_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionEnvelope>, Integer, Hash)> create_detailed_transaction_with_http_info(create_detailed_transaction_request, opts)
+
+```ruby
+begin
+  # Create an itemized transaction (Professional/Enterprise plans)
+  data, status_code, headers = api_instance.create_detailed_transaction_with_http_info(create_detailed_transaction_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionEnvelope>
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->create_detailed_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_detailed_transaction_request** | [**CreateDetailedTransactionRequest**](CreateDetailedTransactionRequest.md) |  |  |
+| **x_idempotency_key** | **String** | Optional unique key for a create request (e.g. a UUID). A retried create with the same key returns the original transaction instead of creating a duplicate — send it on every create so a network retry can&#39;t double-charge the customer.  | [optional] |
+
+### Return type
+
+[**TransactionEnvelope**](TransactionEnvelope.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_transaction
+
+> <TransactionEnvelope> create_transaction(create_transaction_request, opts)
+
+Create a payment transaction
+
+### Examples
+
+```ruby
+require 'time'
+require 'griffnode'
+# setup authorization
+GriffNode.configure do |config|
+  # Configure Bearer authorization: SecretKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = GriffNode::TransactionsApi.new
+create_transaction_request = GriffNode::CreateTransactionRequest.new({crypto: GriffNode::CryptoSymbol::BTC, amount: 3.56}) # CreateTransactionRequest | 
+opts = {
+  x_idempotency_key: 'x_idempotency_key_example' # String | Optional unique key for a create request (e.g. a UUID). A retried create with the same key returns the original transaction instead of creating a duplicate — send it on every create so a network retry can't double-charge the customer. 
+}
+
+begin
+  # Create a payment transaction
+  result = api_instance.create_transaction(create_transaction_request, opts)
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->create_transaction: #{e}"
+end
+```
+
+#### Using the create_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionEnvelope>, Integer, Hash)> create_transaction_with_http_info(create_transaction_request, opts)
+
+```ruby
+begin
+  # Create a payment transaction
+  data, status_code, headers = api_instance.create_transaction_with_http_info(create_transaction_request, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionEnvelope>
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->create_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_transaction_request** | [**CreateTransactionRequest**](CreateTransactionRequest.md) |  |  |
+| **x_idempotency_key** | **String** | Optional unique key for a create request (e.g. a UUID). A retried create with the same key returns the original transaction instead of creating a duplicate — send it on every create so a network retry can&#39;t double-charge the customer.  | [optional] |
+
+### Return type
+
+[**TransactionEnvelope**](TransactionEnvelope.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_transaction
+
+> <TransactionEnvelope> get_transaction(transaction_id)
+
+Retrieve a single transaction
+
+### Examples
+
+```ruby
+require 'time'
+require 'griffnode'
+# setup authorization
+GriffNode.configure do |config|
+  # Configure Bearer authorization: SecretKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = GriffNode::TransactionsApi.new
+transaction_id = 'transaction_id_example' # String | 
+
+begin
+  # Retrieve a single transaction
+  result = api_instance.get_transaction(transaction_id)
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction: #{e}"
+end
+```
+
+#### Using the get_transaction_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionEnvelope>, Integer, Hash)> get_transaction_with_http_info(transaction_id)
+
+```ruby
+begin
+  # Retrieve a single transaction
+  data, status_code, headers = api_instance.get_transaction_with_http_info(transaction_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionEnvelope>
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->get_transaction_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** |  |  |
+
+### Return type
+
+[**TransactionEnvelope**](TransactionEnvelope.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_transactions
+
+> <ListTransactions200Response> list_transactions(opts)
+
+List the merchant's transactions (newest first)
+
+### Examples
+
+```ruby
+require 'time'
+require 'griffnode'
+# setup authorization
+GriffNode.configure do |config|
+  # Configure Bearer authorization: SecretKey
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = GriffNode::TransactionsApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56, # Integer | 
+  status: GriffNode::TransactionStatus::PENDING, # TransactionStatus | 
+  crypto: GriffNode::CryptoSymbol::BTC # CryptoSymbol | 
+}
+
+begin
+  # List the merchant's transactions (newest first)
+  result = api_instance.list_transactions(opts)
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->list_transactions: #{e}"
+end
+```
+
+#### Using the list_transactions_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListTransactions200Response>, Integer, Hash)> list_transactions_with_http_info(opts)
+
+```ruby
+begin
+  # List the merchant's transactions (newest first)
+  data, status_code, headers = api_instance.list_transactions_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListTransactions200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling TransactionsApi->list_transactions_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional][default to 20] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+| **status** | [**TransactionStatus**](.md) |  | [optional] |
+| **crypto** | [**CryptoSymbol**](.md) |  | [optional] |
+
+### Return type
+
+[**ListTransactions200Response**](ListTransactions200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/WebhookPayload.md

@@ -0,0 +1,40 @@
+# GriffNode::WebhookPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | **String** |  |  |
+| **timestamp** | **Time** |  |  |
+| **transaction_id** | **String** |  |  |
+| **status** | [**TransactionStatus**](TransactionStatus.md) |  |  |
+| **currency_crypto** | [**CryptoSymbol**](CryptoSymbol.md) |  | [optional] |
+| **currency_fiat** | [**FiatCurrency**](FiatCurrency.md) |  | [optional][default to 'USD'] |
+| **amount_fiat** | **String** | Decimal string. | [optional] |
+| **amount_usd** | **String** | Decimal string. | [optional] |
+| **amount_crypto** | **String** | Decimal string. | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **receipt_url** | **String** | Present on completed/overpaid. | [optional] |
+| **metadata** | **Hash<String, String>** | Free-form key/value (≤20 keys, string values ≤500 chars, ≤4 KB total). | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::WebhookPayload.new(
+  event: null,
+  timestamp: null,
+  transaction_id: null,
+  status: null,
+  currency_crypto: null,
+  currency_fiat: null,
+  amount_fiat: null,
+  amount_usd: null,
+  amount_crypto: null,
+  order_id: null,
+  receipt_url: null,
+  metadata: null
+)
+```
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'

data/griffnode.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#GriffNode API
+
+#Accept Bitcoin, Litecoin, Dogecoin, Dash, Ethereum and ERC-20 tokens. Server-to-server, authenticated with a secret API key (`Authorization: Bearer sk_live_…` for live, or `sk_test_…` for test mode — same base URL). All monetary amounts in API responses are JSON numbers; **webhook** amounts are strings to preserve decimal precision (see the `webhooks` section).  **Rate limits.** Every request is rate-limited per API key in two windows — per minute and per hour — by plan tier (min/hour): starter 30/500, business 100/2000, professional 300/5000, enterprise 1000/20000. Every response carries `X-RateLimit-Limit`, `X-RateLimit-Remaining` and `X-RateLimit-Reset` (Unix seconds) for the per-minute window. On `429` the body is `error: \"RATE_LIMIT_EXCEEDED\"` (either window) with a `Retry-After` header (seconds) — clients should retry after it. A separate `429` with `error: \"MONTHLY_LIMIT_REACHED\"` means the plan's monthly transaction quota (not the request rate). 
+
+The version of the OpenAPI document: 1.0.1
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "griffnode/version"
+
+Gem::Specification.new do |s|
+  s.name        = "griffnode"
+  s.version     = GriffNode::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["GriffNode"]
+  s.email       = ["dev@griffnode.com"]
+  s.homepage    = "https://griffnode.com"
+  s.summary     = "GriffNode API Ruby Gem"
+  s.description = "Official GriffNode SDK. Non-custodial crypto payment gateway: accept BTC, ETH, LTC, DOGE, DASH and ERC-20 tokens straight to your own wallet."
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {
+    "homepage_uri"      => "https://griffnode.com",
+    "source_code_uri"   => "https://github.com/GriffNode/ruby-sdk",
+    "documentation_uri" => "https://docs.griffnode.com/reference",
+  }
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end