Module: Nombaone

Defined in:
lib/nombaone.rb,
lib/nombaone/client.rb,
lib/nombaone/errors.rb,
lib/nombaone/object.rb,
lib/nombaone/version.rb,
lib/nombaone/webhooks.rb,
lib/nombaone/pagination.rb,
lib/nombaone/internal/util.rb,
lib/nombaone/webhook_event.rb,
lib/nombaone/resources/plans.rb,
lib/nombaone/resources/events.rb,
lib/nombaone/resources/prices.rb,
lib/nombaone/resources/coupons.rb,
lib/nombaone/resources/metrics.rb,
lib/nombaone/resources/sandbox.rb,
lib/nombaone/resources/invoices.rb,
lib/nombaone/resources/mandates.rb,
lib/nombaone/resources/customers.rb,
lib/nombaone/internal/http_client.rb,
lib/nombaone/resources/settlements.rb,
lib/nombaone/resources/organization.rb,
lib/nombaone/resources/base_resource.rb,
lib/nombaone/resources/subscriptions.rb,
lib/nombaone/resources/payment_methods.rb,
lib/nombaone/resources/webhook_endpoints.rb,
sig/nombaone.rbs,
sig/nombaone/client.rbs,
sig/nombaone/errors.rbs,
sig/nombaone/object.rbs,
sig/nombaone/internal.rbs,
sig/nombaone/webhooks.rbs,
sig/nombaone/resources.rbs,
sig/nombaone/pagination.rbs

Overview

NombaOne — recurring billing for Nigeria over card, direct debit, bank transfer, and more, with dunning that recovers and a ledger that never loses a kobo. This module is the SDK's namespace and entrypoint.

Examples:

Construct a client

nombaone = Nombaone.new(ENV["NOMBAONE_API_KEY"])
customer = nombaone.customers.create(email: "ada@example.com", name: "Ada")

Verify a webhook without a client (only the signing secret is needed)

event = Nombaone.webhooks.construct_event(raw_body, signature_header, secret)

Defined Under Namespace

Modules: ErrorCode, Internal, Resources, WebhookEventType Classes: APIError, AuthenticationError, BadRequestError, Client, ConflictError, ConnectionError, Error, NombaObject, NotFoundError, Page, PermissionDeniedError, RateLimitError, ServerError, TimeoutError, ValidationError, WebhookEvent, WebhookVerificationError, Webhooks

Constant Summary collapse

VERSION =

The installed SDK version. Sent on every request as part of the User-Agent (nombaone-ruby/<version>) and used for release tooling.

Returns:

  • (String) 
"0.1.0"

Class Method Summary collapse

Class Method Details

.new(api_key = nil, **options) ⇒ Nombaone::Client

Construct a new API client.

Parameters:

  • api_key (String, nil) (defaults to: nil) —

    your secret key (nbo_sandbox_… / nbo_live_…). Defaults to ENV["NOMBAONE_API_KEY"].

  • options (Hash) —

    see Nombaone::Client#initialize (base_url:, timeout:, max_retries:, http:, default_headers:).

Returns:



46
47
48
 
# File 'lib/nombaone.rb', line 46

def self.new(api_key = nil, **options)
  Client.new(api_key, **options)
end

.webhooks ⇒ Nombaone::Webhooks

A shared, keyless Webhooks helper for verifying inbound deliveries. Webhook verification needs only the endpoint's signing secret, never an API key — so this is usable in a receiver that never constructs a client.

Returns:



55
56
57
 
# File 'lib/nombaone.rb', line 55

def self.webhooks
  @webhooks ||= Webhooks.new
end