griffnode 1.0.0

data/docs/CryptoSymbol.md

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

data/docs/Cryptocurrency.md

@@ -0,0 +1,26 @@
+# GriffNode::Cryptocurrency
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **symbol** | [**CryptoSymbol**](CryptoSymbol.md) |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **blockchain** | **String** |  | [optional] |
+| **network** | **String** |  | [optional] |
+| **type** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Cryptocurrency.new(
+  symbol: null,
+  name: null,
+  blockchain: null,
+  network: null,
+  type: null
+)
+```
+

data/docs/DefaultApi.md

@@ -0,0 +1,78 @@
+# GriffNode::DefaultApi
+
+All URIs are relative to *https://api.griffnode.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**payment_webhook**](DefaultApi.md#payment_webhook) | **POST** /paymentEvent | Payment lifecycle event delivered to the merchant's webhook URL |
+
+
+## payment_webhook
+
+> payment_webhook(opts)
+
+Payment lifecycle event delivered to the merchant's webhook URL
+
+Signed with HMAC-SHA256 over the RAW request body. Verify by comparing `X-GriffNode-Signature: sha256=<hex>` to `hex(hmac_sha256(webhook_secret, raw_body))` using a constant-time compare. Also sent: `X-GriffNode-Event` (the event type) and `X-Webhook-ID` (unique delivery id — use for idempotency). 
+
+### 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::DefaultApi.new
+opts = {
+  webhook_payload:  # WebhookPayload | 
+}
+
+begin
+  # Payment lifecycle event delivered to the merchant's webhook URL
+  api_instance.payment_webhook(opts)
+rescue GriffNode::ApiError => e
+  puts "Error when calling DefaultApi->payment_webhook: #{e}"
+end
+```
+
+#### Using the payment_webhook_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)> payment_webhook_with_http_info(opts)
+
+```ruby
+begin
+  # Payment lifecycle event delivered to the merchant's webhook URL
+  data, status_code, headers = api_instance.payment_webhook_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue GriffNode::ApiError => e
+  puts "Error when calling DefaultApi->payment_webhook_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **webhook_payload** | [**WebhookPayload**](WebhookPayload.md) |  | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[SecretKey](../README.md#SecretKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+

data/docs/Error.md

@@ -0,0 +1,22 @@
+# GriffNode::Error
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Object** |  |  |
+| **error** | **String** | Machine-readable code. |  |
+| **message** | **String** | Human-readable description. |  |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Error.new(
+  success: null,
+  error: null,
+  message: null
+)
+```
+

data/docs/FiatCurrency.md

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

data/docs/GetAccount200Response.md

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

data/docs/GetHealth200Response.md

@@ -0,0 +1,22 @@
+# GriffNode::GetHealth200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **service** | **String** |  | [optional] |
+| **version** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::GetHealth200Response.new(
+  status: null,
+  service: null,
+  version: null
+)
+```
+

data/docs/GetPrices200Response.md

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

data/docs/GetPrices200ResponseData.md

@@ -0,0 +1,22 @@
+# GriffNode::GetPrices200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **crypto** | **Hash<String, Float>** | USD price per unit, keyed by crypto symbol (active coins only). | [optional] |
+| **fiat** | **Hash<String, Float>** | USD value of one unit of each fiat currency. | [optional] |
+| **fetched_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::GetPrices200ResponseData.new(
+  crypto: null,
+  fiat: null,
+  fetched_at: null
+)
+```
+

data/docs/GetStats200Response.md

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

data/docs/GetStats200ResponseData.md

@@ -0,0 +1,24 @@
+# GriffNode::GetStats200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total_transactions** | **Integer** |  | [optional] |
+| **monthly_transactions** | **Integer** |  | [optional] |
+| **total_volume_fiat** | **Float** |  | [optional] |
+| **unique_customers** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::GetStats200ResponseData.new(
+  total_transactions: null,
+  monthly_transactions: null,
+  total_volume_fiat: null,
+  unique_customers: null
+)
+```
+

data/docs/InlineObject.md

@@ -0,0 +1,24 @@
+# GriffNode::InlineObject
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Object** |  |  |
+| **error** | **String** | Machine-readable code. |  |
+| **message** | **String** | Human-readable description. |  |
+| **existing_transaction** | [**InlineObjectAllOfExistingTransaction**](InlineObjectAllOfExistingTransaction.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::InlineObject.new(
+  success: null,
+  error: null,
+  message: null,
+  existing_transaction: null
+)
+```
+

data/docs/InlineObjectAllOfExistingTransaction.md

@@ -0,0 +1,22 @@
+# GriffNode::InlineObjectAllOfExistingTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** |  | [optional] |
+| **status** | [**TransactionStatus**](TransactionStatus.md) |  | [optional] |
+| **payment_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::InlineObjectAllOfExistingTransaction.new(
+  transaction_id: null,
+  status: null,
+  payment_url: null
+)
+```
+

data/docs/Invoice.md

@@ -0,0 +1,34 @@
+# GriffNode::Invoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transaction_id** | **String** |  | [optional] |
+| **purchase_type** | **String** |  | [optional] |
+| **amount_fiat** | **Float** |  | [optional] |
+| **currency_fiat** | [**FiatCurrency**](FiatCurrency.md) |  | [optional][default to 'USD'] |
+| **status** | **String** |  | [optional] |
+| **crypto_symbol** | [**CryptoSymbol**](CryptoSymbol.md) |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **confirmed_at** | **Time** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::Invoice.new(
+  transaction_id: null,
+  purchase_type: null,
+  amount_fiat: null,
+  currency_fiat: null,
+  status: null,
+  crypto_symbol: null,
+  created_at: null,
+  confirmed_at: null,
+  expires_at: null
+)
+```
+

data/docs/LineItem.md

@@ -0,0 +1,22 @@
+# GriffNode::LineItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **quantity** | **Integer** |  | [optional][default to 1] |
+| **price** | **Float** |  |  |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::LineItem.new(
+  name: null,
+  quantity: null,
+  price: null
+)
+```
+

data/docs/ListBalances200Response.md

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

data/docs/ListBalances200ResponseData.md

@@ -0,0 +1,18 @@
+# GriffNode::ListBalances200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **balances** | [**Array<Balance>**](Balance.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::ListBalances200ResponseData.new(
+  balances: null
+)
+```
+

data/docs/ListCryptocurrencies200Response.md

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

data/docs/ListCryptocurrencies200ResponseData.md

@@ -0,0 +1,20 @@
+# GriffNode::ListCryptocurrencies200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cryptocurrencies** | [**Array<Cryptocurrency>**](Cryptocurrency.md) |  | [optional] |
+| **total** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::ListCryptocurrencies200ResponseData.new(
+  cryptocurrencies: null,
+  total: null
+)
+```
+

data/docs/ListInvoices200Response.md

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

data/docs/ListInvoices200ResponseData.md

@@ -0,0 +1,20 @@
+# GriffNode::ListInvoices200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoices** | [**Array<Invoice>**](Invoice.md) |  | [optional] |
+| **pagination** | [**Pagination**](Pagination.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::ListInvoices200ResponseData.new(
+  invoices: null,
+  pagination: null
+)
+```
+

data/docs/ListPlans200Response.md

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

data/docs/ListPlans200ResponseData.md

@@ -0,0 +1,20 @@
+# GriffNode::ListPlans200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **plans** | [**Array<Plan>**](Plan.md) |  | [optional] |
+| **billing_cycles** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::ListPlans200ResponseData.new(
+  plans: null,
+  billing_cycles: null
+)
+```
+

data/docs/ListTransactions200Response.md

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

data/docs/ListTransactions200ResponseData.md

@@ -0,0 +1,20 @@
+# GriffNode::ListTransactions200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **transactions** | [**Array<Transaction>**](Transaction.md) |  |  |
+| **pagination** | [**Pagination**](Pagination.md) |  |  |
+
+## Example
+
+```ruby
+require 'griffnode'
+
+instance = GriffNode::ListTransactions200ResponseData.new(
+  transactions: null,
+  pagination: null
+)
+```
+