griffnode 1.0.0

data/docs/MarketDataApi.md

@@ -0,0 +1,202 @@
+# GriffNode::MarketDataApi
+
+All URIs are relative to *https://api.griffnode.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_prices**](MarketDataApi.md#get_prices) | **GET** /prices | Current crypto and fiat exchange rates (USD-denominated) |
+| [**list_cryptocurrencies**](MarketDataApi.md#list_cryptocurrencies) | **GET** /cryptos/list | All supported cryptocurrencies and tokens |
+| [**list_merchant_cryptocurrencies**](MarketDataApi.md#list_merchant_cryptocurrencies) | **GET** /merchant/cryptos | Cryptocurrencies this merchant has wallets configured for |
+
+
+## get_prices
+
+> <GetPrices200Response> get_prices
+
+Current crypto and fiat exchange rates (USD-denominated)
+
+### 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::MarketDataApi.new
+
+begin
+  # Current crypto and fiat exchange rates (USD-denominated)
+  result = api_instance.get_prices
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling MarketDataApi->get_prices: #{e}"
+end
+```
+
+#### Using the get_prices_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPrices200Response>, Integer, Hash)> get_prices_with_http_info
+
+```ruby
+begin
+  # Current crypto and fiat exchange rates (USD-denominated)
+  data, status_code, headers = api_instance.get_prices_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPrices200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling MarketDataApi->get_prices_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetPrices200Response**](GetPrices200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_cryptocurrencies
+
+> <ListCryptocurrencies200Response> list_cryptocurrencies
+
+All supported cryptocurrencies and tokens
+
+### 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::MarketDataApi.new
+
+begin
+  # All supported cryptocurrencies and tokens
+  result = api_instance.list_cryptocurrencies
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling MarketDataApi->list_cryptocurrencies: #{e}"
+end
+```
+
+#### Using the list_cryptocurrencies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCryptocurrencies200Response>, Integer, Hash)> list_cryptocurrencies_with_http_info
+
+```ruby
+begin
+  # All supported cryptocurrencies and tokens
+  data, status_code, headers = api_instance.list_cryptocurrencies_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCryptocurrencies200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling MarketDataApi->list_cryptocurrencies_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListCryptocurrencies200Response**](ListCryptocurrencies200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_merchant_cryptocurrencies
+
+> <ListCryptocurrencies200Response> list_merchant_cryptocurrencies
+
+Cryptocurrencies this merchant has wallets configured for
+
+### 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::MarketDataApi.new
+
+begin
+  # Cryptocurrencies this merchant has wallets configured for
+  result = api_instance.list_merchant_cryptocurrencies
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling MarketDataApi->list_merchant_cryptocurrencies: #{e}"
+end
+```
+
+#### Using the list_merchant_cryptocurrencies_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListCryptocurrencies200Response>, Integer, Hash)> list_merchant_cryptocurrencies_with_http_info
+
+```ruby
+begin
+  # Cryptocurrencies this merchant has wallets configured for
+  data, status_code, headers = api_instance.list_merchant_cryptocurrencies_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListCryptocurrencies200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling MarketDataApi->list_merchant_cryptocurrencies_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListCryptocurrencies200Response**](ListCryptocurrencies200Response.md)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Pagination.md

@@ -0,0 +1,22 @@
+# GriffNode::Pagination
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** |  |  |
+| **offset** | **Integer** |  |  |
+| **total** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Pagination.new(
+  limit: null,
+  offset: null,
+  total: null
+)
+```
+

data/docs/PaymentSplit.md

@@ -0,0 +1,28 @@
+# GriffNode::PaymentSplit
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **txid** | **String** | On-chain transaction hash (blockchain id, NOT the GriffNode transaction_id). | [optional] |
+| **amount_crypto** | **Float** |  | [optional] |
+| **confirmations** | **Integer** |  | [optional] |
+| **status** | **String** |  | [optional] |
+| **detected_at** | **Time** |  | [optional] |
+| **confirmed_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::PaymentSplit.new(
+  txid: null,
+  amount_crypto: null,
+  confirmations: null,
+  status: null,
+  detected_at: null,
+  confirmed_at: null
+)
+```
+

data/docs/Plan.md

@@ -0,0 +1,38 @@
+# GriffNode::Plan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tier** | [**PlanTier**](PlanTier.md) |  | [optional] |
+| **monthly_price_usd** | **Float** |  | [optional] |
+| **yearly_price_usd** | **Float** |  | [optional] |
+| **monthly_transaction_limit** | **Integer** |  | [optional] |
+| **overage_cost_per_tx** | **Float** |  | [optional] |
+| **webhook_support** | **Boolean** |  | [optional] |
+| **webhook_limit** | **Integer** |  | [optional] |
+| **ip_whitelist** | **Boolean** |  | [optional] |
+| **api_rate_limit_per_minute** | **Integer** |  | [optional] |
+| **api_rate_limit_per_hour** | **Integer** |  | [optional] |
+| **custom_pricing** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Plan.new(
+  tier: null,
+  monthly_price_usd: null,
+  yearly_price_usd: null,
+  monthly_transaction_limit: null,
+  overage_cost_per_tx: null,
+  webhook_support: null,
+  webhook_limit: null,
+  ip_whitelist: null,
+  api_rate_limit_per_minute: null,
+  api_rate_limit_per_hour: null,
+  custom_pricing: null
+)
+```
+

data/docs/PlanTier.md

@@ -0,0 +1,15 @@
+# GriffNode::PlanTier
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::PlanTier.new()
+```
+

data/docs/SystemApi.md

@@ -0,0 +1,139 @@
+# GriffNode::SystemApi
+
+All URIs are relative to *https://api.griffnode.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_health**](SystemApi.md#get_health) | **GET** /health | API health check |
+| [**hosted_checkout_redirect**](SystemApi.md#hosted_checkout_redirect) | **GET** /pay | Hosted-checkout redirect (browser flow, publishable key) |
+
+
+## get_health
+
+> <GetHealth200Response> get_health
+
+API health check
+
+### Examples
+
+```ruby
+require 'time'
+require 'griffnode'
+
+api_instance = GriffNode::SystemApi.new
+
+begin
+  # API health check
+  result = api_instance.get_health
+  p result
+rescue GriffNode::ApiError => e
+  puts "Error when calling SystemApi->get_health: #{e}"
+end
+```
+
+#### Using the get_health_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetHealth200Response>, Integer, Hash)> get_health_with_http_info
+
+```ruby
+begin
+  # API health check
+  data, status_code, headers = api_instance.get_health_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetHealth200Response>
+rescue GriffNode::ApiError => e
+  puts "Error when calling SystemApi->get_health_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetHealth200Response**](GetHealth200Response.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## hosted_checkout_redirect
+
+> hosted_checkout_redirect(pk, amount, crypto, opts)
+
+Hosted-checkout redirect (browser flow, publishable key)
+
+Browser-facing redirect to the hosted payment page, authenticated by a **publishable** key in the query string (safe to expose client-side). Not used by the server-side SDKs — included for completeness. 
+
+### Examples
+
+```ruby
+require 'time'
+require 'griffnode'
+
+api_instance = GriffNode::SystemApi.new
+pk = 'pk_example' # String | Publishable key, pk_live_… / pk_test_…
+amount = 'amount_example' # String | Fiat amount (≥ 1.00 USD equivalent).
+crypto = GriffNode::CryptoSymbol::BTC # CryptoSymbol | 
+opts = {
+  link: 'link_example' # String | Payment-link slug for attribution.
+}
+
+begin
+  # Hosted-checkout redirect (browser flow, publishable key)
+  api_instance.hosted_checkout_redirect(pk, amount, crypto, opts)
+rescue GriffNode::ApiError => e
+  puts "Error when calling SystemApi->hosted_checkout_redirect: #{e}"
+end
+```
+
+#### Using the hosted_checkout_redirect_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> hosted_checkout_redirect_with_http_info(pk, amount, crypto, opts)
+
+```ruby
+begin
+  # Hosted-checkout redirect (browser flow, publishable key)
+  data, status_code, headers = api_instance.hosted_checkout_redirect_with_http_info(pk, amount, crypto, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue GriffNode::ApiError => e
+  puts "Error when calling SystemApi->hosted_checkout_redirect_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pk** | **String** | Publishable key, pk_live_… / pk_test_… |  |
+| **amount** | **String** | Fiat amount (≥ 1.00 USD equivalent). |  |
+| **crypto** | [**CryptoSymbol**](.md) |  |  |
+| **link** | **String** | Payment-link slug for attribution. | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Transaction.md

@@ -0,0 +1,66 @@
+# GriffNode::Transaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** |  |  |
+| **status** | [**TransactionStatus**](TransactionStatus.md) |  |  |
+| **type** | **String** |  | [optional] |
+| **crypto** | [**CryptoSymbol**](CryptoSymbol.md) |  |  |
+| **deposit_address** | **String** |  | [optional] |
+| **amount_crypto** | **Float** |  | [optional] |
+| **amount_fiat** | **Float** |  |  |
+| **amount_usd** | **Float** |  |  |
+| **amount_paid** | **Float** |  | [optional] |
+| **amount_remaining** | **Float** |  | [optional] |
+| **currency_fiat** | [**FiatCurrency**](FiatCurrency.md) |  | [default to 'USD'] |
+| **fiat_to_usd_rate** | **Float** |  | [optional] |
+| **exchange_rate** | **Float** | USD per unit of crypto, locked at creation. | [optional] |
+| **confirmations_required** | **Integer** |  | [optional] |
+| **payment_url** | **String** |  | [optional] |
+| **order_id** | **String** |  | [optional] |
+| **customer_email** | **String** |  | [optional] |
+| **items** | [**Array<LineItem>**](LineItem.md) |  | [optional] |
+| **payments** | [**Array<PaymentSplit>**](PaymentSplit.md) | On-chain payments detected toward this transaction. | [optional] |
+| **metadata** | **Hash<String, String>** | Free-form key/value (≤20 keys, string values ≤500 chars, ≤4 KB total). | [optional] |
+| **success_url** | **String** |  | [optional] |
+| **cancel_url** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  | [optional] |
+| **expires_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Transaction.new(
+  transaction_id: null,
+  status: null,
+  type: null,
+  crypto: null,
+  deposit_address: null,
+  amount_crypto: null,
+  amount_fiat: null,
+  amount_usd: null,
+  amount_paid: null,
+  amount_remaining: null,
+  currency_fiat: null,
+  fiat_to_usd_rate: null,
+  exchange_rate: null,
+  confirmations_required: null,
+  payment_url: null,
+  order_id: null,
+  customer_email: null,
+  items: null,
+  payments: null,
+  metadata: null,
+  success_url: null,
+  cancel_url: null,
+  created_at: null,
+  updated_at: null,
+  expires_at: null
+)
+```
+

data/docs/TransactionEnvelope.md

@@ -0,0 +1,20 @@
+# GriffNode::TransactionEnvelope
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Object** |  |  |
+| **data** | [**Transaction**](Transaction.md) |  |  |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::TransactionEnvelope.new(
+  success: null,
+  data: null
+)
+```
+

data/docs/TransactionStatus.md

@@ -0,0 +1,15 @@
+# GriffNode::TransactionStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::TransactionStatus.new()
+```
+