griffnode 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a2effc4f3788be304b922f78fb95a402d6beea4dca45bf900b5fce06724eb9e
+  data.tar.gz: 0c8181ef4923951c437627ce545406fa0313916dd03f76ddc01587efedc3bbf5
+SHA512:
+  metadata.gz: 32a18f31bddb8c042fdecf4aacd19e86d09dca770880b81dadaa31b077af3a20a63a208a190141a4064135dd116f2c0cec78b223a7a428d640e307fe1040d6b5
+  data.tar.gz: 34fcc6a8db1251af36c3d0e61a3dda1418ed0c55d0e7a45ad1279fee16626f892785b43ec32e87ee927db1a21a37d7ad1113fc30445687d46de8ad217d08857e

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 13.0.1'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/LICENSE

@@ -0,0 +1,17 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   Copyright 2026 GriffNode
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,24 @@
+# GriffNode SDK (ruby-sdk)
+
+Official SDK for the [GriffNode](https://griffnode.com) crypto-payments API —
+accept Bitcoin, Ethereum, Litecoin, Dogecoin, Dash and ERC-20 tokens straight to your
+own wallet.
+
+```
+gem install griffnode
+```
+
+- **API reference:** https://docs.griffnode.com/reference
+- **OpenAPI spec:** https://docs.griffnode.com/openapi.yaml
+- **Generated from** `openapi.yaml` with [OpenAPI Generator](https://openapi-generator.tech)
+  (`ruby`) — see `.github/workflows/generate.yml`. Do not hand-edit generated files.
+
+## Quick start
+
+Authenticate with a secret key (`Authorization: Bearer sk_live_…`, or `sk_test_…` for
+sandbox), then create a payment. Send an `X-Idempotency-Key` on every create so a retried
+request can't double-charge. Full, language-specific examples are generated below by CI.
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Account.md

@@ -0,0 +1,22 @@
+# GriffNode::Account
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plan** | [**AccountPlan**](AccountPlan.md) |  | [optional] |
+| **usage** | [**AccountUsage**](AccountUsage.md) |  | [optional] |
+| **limits** | [**AccountLimits**](AccountLimits.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Account.new(
+  plan: null,
+  usage: null,
+  limits: null
+)
+```
+

data/docs/AccountApi.md

@@ -0,0 +1,339 @@
+# GriffNode::AccountApi
+
+All URIs are relative to *https://api.griffnode.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_account**](AccountApi.md#get_account) | **GET** /account | Merchant plan, usage and limits |
+| [**get_stats**](AccountApi.md#get_stats) | **GET** /stats | Merchant transaction analytics |
+| [**list_balances**](AccountApi.md#list_balances) | **GET** /balances | On-platform balances (for overage/top-up; NOT crypto settlement) |
+| [**list_invoices**](AccountApi.md#list_invoices) | **GET** /invoices | GriffNode billing invoices (platform ↔ merchant) |
+| [**list_plans**](AccountApi.md#list_plans) | **GET** /plans | Plan catalogue and pricing |
+
+
+## get_account
+
+> <GetAccount200Response> get_account
+
+Merchant plan, usage and limits
+
+### 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::AccountApi.new
+
+begin
+  # Merchant plan, usage and limits
+  result = api_instance.get_account
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->get_account: #{e}"
+end
+```
+
+#### Using the get_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAccount200Response>, Integer, Hash)> get_account_with_http_info
+
+```ruby
+begin
+  # Merchant plan, usage and limits
+  data, status_code, headers = api_instance.get_account_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAccount200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->get_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetAccount200Response**](GetAccount200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_stats
+
+> <GetStats200Response> get_stats
+
+Merchant transaction analytics
+
+### 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::AccountApi.new
+
+begin
+  # Merchant transaction analytics
+  result = api_instance.get_stats
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->get_stats: #{e}"
+end
+```
+
+#### Using the get_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetStats200Response>, Integer, Hash)> get_stats_with_http_info
+
+```ruby
+begin
+  # Merchant transaction analytics
+  data, status_code, headers = api_instance.get_stats_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetStats200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->get_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetStats200Response**](GetStats200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_balances
+
+> <ListBalances200Response> list_balances
+
+On-platform balances (for overage/top-up; NOT crypto settlement)
+
+### 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::AccountApi.new
+
+begin
+  # On-platform balances (for overage/top-up; NOT crypto settlement)
+  result = api_instance.list_balances
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->list_balances: #{e}"
+end
+```
+
+#### Using the list_balances_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListBalances200Response>, Integer, Hash)> list_balances_with_http_info
+
+```ruby
+begin
+  # On-platform balances (for overage/top-up; NOT crypto settlement)
+  data, status_code, headers = api_instance.list_balances_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListBalances200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->list_balances_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListBalances200Response**](ListBalances200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_invoices
+
+> <ListInvoices200Response> list_invoices(opts)
+
+GriffNode billing invoices (platform ↔ merchant)
+
+### 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::AccountApi.new
+opts = {
+  limit: 56, # Integer | 
+  offset: 56 # Integer | 
+}
+
+begin
+  # GriffNode billing invoices (platform ↔ merchant)
+  result = api_instance.list_invoices(opts)
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->list_invoices: #{e}"
+end
+```
+
+#### Using the list_invoices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListInvoices200Response>, Integer, Hash)> list_invoices_with_http_info(opts)
+
+```ruby
+begin
+  # GriffNode billing invoices (platform ↔ merchant)
+  data, status_code, headers = api_instance.list_invoices_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListInvoices200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->list_invoices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  | [optional][default to 20] |
+| **offset** | **Integer** |  | [optional][default to 0] |
+
+### Return type
+
+[**ListInvoices200Response**](ListInvoices200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_plans
+
+> <ListPlans200Response> list_plans
+
+Plan catalogue and pricing
+
+### 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::AccountApi.new
+
+begin
+  # Plan catalogue and pricing
+  result = api_instance.list_plans
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->list_plans: #{e}"
+end
+```
+
+#### Using the list_plans_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListPlans200Response>, Integer, Hash)> list_plans_with_http_info
+
+```ruby
+begin
+  # Plan catalogue and pricing
+  data, status_code, headers = api_instance.list_plans_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListPlans200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling AccountApi->list_plans_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListPlans200Response**](ListPlans200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/AccountLimits.md

@@ -0,0 +1,22 @@
+# GriffNode::AccountLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **api_rate_limit_per_minute** | **Integer** |  | [optional] |
+| **api_rate_limit_per_hour** | **Integer** |  | [optional] |
+| **webhook_support** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::AccountLimits.new(
+  api_rate_limit_per_minute: null,
+  api_rate_limit_per_hour: null,
+  webhook_support: null
+)
+```
+

data/docs/AccountPlan.md

@@ -0,0 +1,24 @@
+# GriffNode::AccountPlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tier** | [**PlanTier**](PlanTier.md) |  | [optional] |
+| **billing_cycle** | **String** |  | [optional] |
+| **auto_renewal** | **Boolean** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::AccountPlan.new(
+  tier: null,
+  billing_cycle: null,
+  auto_renewal: null,
+  expires_at: null
+)
+```
+

data/docs/AccountUsage.md

@@ -0,0 +1,22 @@
+# GriffNode::AccountUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **monthly_transactions_used** | **Integer** |  | [optional] |
+| **monthly_transaction_limit** | **Integer** | null = unlimited. | [optional] |
+| **overage_cost_per_tx** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::AccountUsage.new(
+  monthly_transactions_used: null,
+  monthly_transaction_limit: null,
+  overage_cost_per_tx: null
+)
+```
+

data/docs/Balance.md

@@ -0,0 +1,24 @@
+# GriffNode::Balance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **currency** | **String** |  | [optional] |
+| **available_balance** | **Float** |  | [optional] |
+| **pending_balance** | **Float** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Balance.new(
+  currency: null,
+  available_balance: null,
+  pending_balance: null,
+  updated_at: null
+)
+```
+

data/docs/BillingApi.md

@@ -0,0 +1,75 @@
+# GriffNode::BillingApi
+
+All URIs are relative to *https://api.griffnode.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_billing_checkout**](BillingApi.md#create_billing_checkout) | **POST** /billing/checkout | Start a plan upgrade or account top-up |
+
+
+## create_billing_checkout
+
+> <TransactionEnvelope> create_billing_checkout(create_billing_checkout_request)
+
+Start a plan upgrade or account top-up
+
+### 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::BillingApi.new
+create_billing_checkout_request = GriffNode::CreateBillingCheckoutRequest.new({tier: GriffNode::PlanTier::STARTER}) # CreateBillingCheckoutRequest | 
+
+begin
+  # Start a plan upgrade or account top-up
+  result = api_instance.create_billing_checkout(create_billing_checkout_request)
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling BillingApi->create_billing_checkout: #{e}"
+end
+```
+
+#### Using the create_billing_checkout_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<TransactionEnvelope>, Integer, Hash)> create_billing_checkout_with_http_info(create_billing_checkout_request)
+
+```ruby
+begin
+  # Start a plan upgrade or account top-up
+  data, status_code, headers = api_instance.create_billing_checkout_with_http_info(create_billing_checkout_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <TransactionEnvelope>
+rescue GriffNode::ApiError => e
+  puts "Error when calling BillingApi->create_billing_checkout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_billing_checkout_request** | [**CreateBillingCheckoutRequest**](CreateBillingCheckoutRequest.md) |  |  |
+
+### Return type
+
+[**TransactionEnvelope**](TransactionEnvelope.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CreateBillingCheckoutRequest.md

@@ -0,0 +1,22 @@
+# GriffNode::CreateBillingCheckoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tier** | [**PlanTier**](PlanTier.md) |  |  |
+| **billing_months** | **Integer** |  | [optional][default to 1] |
+| **payment_method** | **String** |  | [optional][default to 'crypto'] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::CreateBillingCheckoutRequest.new(
+  tier: null,
+  billing_months: null,
+  payment_method: null
+)
+```
+

data/docs/CreateDetailedTransactionRequest.md

@@ -0,0 +1,32 @@
+# GriffNode::CreateDetailedTransactionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crypto** | [**CryptoSymbol**](CryptoSymbol.md) |  |  |
+| **currency_fiat** | [**FiatCurrency**](FiatCurrency.md) |  | [optional][default to 'USD'] |
+| **items** | [**Array<LineItem>**](LineItem.md) |  |  |
+| **order_id** | **String** |  |  |
+| **metadata** | **Hash<String, String>** | Free-form key/value (≤20 keys, string values ≤500 chars, ≤4 KB total). | [optional] |
+| **customer_email** | **String** |  | [optional] |
+| **success_url** | **String** |  | [optional] |
+| **cancel_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::CreateDetailedTransactionRequest.new(
+  crypto: null,
+  currency_fiat: null,
+  items: null,
+  order_id: null,
+  metadata: null,
+  customer_email: null,
+  success_url: null,
+  cancel_url: null
+)
+```
+

data/docs/CreateTransactionRequest.md

@@ -0,0 +1,30 @@
+# GriffNode::CreateTransactionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crypto** | [**CryptoSymbol**](CryptoSymbol.md) |  |  |
+| **amount** | **Float** | Fiat amount (≥ 1.00 USD equivalent). |  |
+| **currency_fiat** | [**FiatCurrency**](FiatCurrency.md) |  | [optional][default to 'USD'] |
+| **metadata** | **Hash<String, String>** | Free-form key/value (≤20 keys, string values ≤500 chars, ≤4 KB total). | [optional] |
+| **customer_email** | **String** |  | [optional] |
+| **success_url** | **String** |  | [optional] |
+| **cancel_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::CreateTransactionRequest.new(
+  crypto: null,
+  amount: null,
+  currency_fiat: null,
+  metadata: null,
+  customer_email: null,
+  success_url: null,
+  cancel_url: null
+)
+```
+