Module: GriffNode

Defined in:
lib/griffnode/version.rb,
lib/griffnode.rb,
lib/griffnode/api_error.rb,
lib/griffnode/api_client.rb,
lib/griffnode/models/plan.rb,
lib/griffnode/models/error.rb,
lib/griffnode/configuration.rb,
lib/griffnode/api/system_api.rb,
lib/griffnode/models/account.rb,
lib/griffnode/models/balance.rb,
lib/griffnode/models/invoice.rb,
lib/griffnode/api/account_api.rb,
lib/griffnode/api/billing_api.rb,
lib/griffnode/api/default_api.rb,
lib/griffnode/models/line_item.rb,
lib/griffnode/models/plan_tier.rb,
lib/griffnode/models/pagination.rb,
lib/griffnode/models/transaction.rb,
lib/griffnode/api/market_data_api.rb,
lib/griffnode/models/account_plan.rb,
lib/griffnode/api/transactions_api.rb,
lib/griffnode/models/account_usage.rb,
lib/griffnode/models/crypto_symbol.rb,
lib/griffnode/models/fiat_currency.rb,
lib/griffnode/models/inline_object.rb,
lib/griffnode/models/payment_split.rb,
lib/griffnode/models/account_limits.rb,
lib/griffnode/models/cryptocurrency.rb,
lib/griffnode/models/webhook_payload.rb,
lib/griffnode/models/transaction_status.rb,
lib/griffnode/models/transaction_envelope.rb,
lib/griffnode/models/get_stats200_response.rb,
lib/griffnode/models/get_health200_response.rb,
lib/griffnode/models/get_prices200_response.rb,
lib/griffnode/models/list_plans200_response.rb,
lib/griffnode/models/get_account200_response.rb,
lib/griffnode/models/list_balances200_response.rb,
lib/griffnode/models/list_invoices200_response.rb,
lib/griffnode/models/create_transaction_request.rb,
lib/griffnode/models/get_stats200_response_data.rb,
lib/griffnode/models/get_prices200_response_data.rb,
lib/griffnode/models/list_plans200_response_data.rb,
lib/griffnode/models/list_transactions200_response.rb,
lib/griffnode/models/list_balances200_response_data.rb,
lib/griffnode/models/list_invoices200_response_data.rb,
lib/griffnode/models/create_billing_checkout_request.rb,
lib/griffnode/models/list_cryptocurrencies200_response.rb,
lib/griffnode/models/list_transactions200_response_data.rb,
lib/griffnode/models/create_detailed_transaction_request.rb,
lib/griffnode/models/list_cryptocurrencies200_response_data.rb,
lib/griffnode/models/inline_object_all_of_existing_transaction.rb

Overview

#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

Defined Under Namespace

Classes: Account, AccountApi, AccountLimits, AccountPlan, AccountUsage, ApiClient, ApiError, Balance, BillingApi, Configuration, CreateBillingCheckoutRequest, CreateDetailedTransactionRequest, CreateTransactionRequest, CryptoSymbol, Cryptocurrency, DefaultApi, Error, FiatCurrency, GetAccount200Response, GetHealth200Response, GetPrices200Response, GetPrices200ResponseData, GetStats200Response, GetStats200ResponseData, InlineObject, InlineObjectAllOfExistingTransaction, Invoice, LineItem, ListBalances200Response, ListBalances200ResponseData, ListCryptocurrencies200Response, ListCryptocurrencies200ResponseData, ListInvoices200Response, ListInvoices200ResponseData, ListPlans200Response, ListPlans200ResponseData, ListTransactions200Response, ListTransactions200ResponseData, MarketDataApi, Pagination, PaymentSplit, Plan, PlanTier, SystemApi, Transaction, TransactionEnvelope, TransactionStatus, TransactionsApi, WebhookPayload

Constant Summary collapse

VERSION = 
'1.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block. GriffNode.configure do |config| config.username = "xxx" config.password = "xxx" end If no block given, return the default Configuration object.



76
77
78
79
80
81
82
 
# File 'lib/griffnode.rb', line 76

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end