This repository is auto-generated by the Revenexx SDK Generator. Do not submit changes directly — they will be overwritten on the next generation run.

Revenexx API — revenexx Revenexx Node SDK

Revenexx Node.js SDK for server-side applications.

Installation

To install via NPM:

npm install @revenexx/node --save

Getting Started

Init your SDK

Initialize your SDK with your Revenexx API endpoint and your credentials. Use setTenant() to scope your requests to a tenant, sent as the X-Revenexx-Tenant header on every request. The client supports two authentication methods:

• API key — a gateway-managed scoped key (rvxk_…), set via setApiKeyAuth(). Intended for server-side or trusted environments; never embed an API key in code shipped to the browser.
• Bearer token — a Zitadel-issued JWT for interactive callers, set via setBearerAuth(). The value is sent as the Authorization header verbatim, so include the Bearer prefix.

const { Client } = require('@revenexx/node');

const client = new Client();

client
    .setEndpoint('https://api.revenexx.com') // Your Revenexx API endpoint
    .setTenant('<TENANT_SLUG>')              // The tenant your requests are scoped to
    .setApiKeyAuth('rvxk_...')               // Your scoped API key
;

Or, with a user JWT:

client
    .setEndpoint('https://api.revenexx.com')
    .setTenant('<TENANT_SLUG>')
    .setBearerAuth(`Bearer ${jwt}`)
;

Make Your First Request

Once your client is set up, instantiate any of the Revenexx services with it and send a request. All service methods accept a single params object and return a promise. Full documentation for every service method can be found in the API References.

const { Client, Products } = require('@revenexx/node');

const products = new Products(client);

const result = await products.productsList();

Full Example

const { Client, Products } = require('@revenexx/node');

const client = new Client();

client
    .setEndpoint('https://api.revenexx.com')
    .setTenant('<TENANT_SLUG>')
    .setApiKeyAuth('rvxk_...')
;

const products = new Products(client);

const result = await products.productsList();

const product = await products.productsGet({ id: '<PRODUCT_ID>' });
console.log(product);

Type Safety with Models

The SDK ships with full TypeScript definitions. Response types live in the Models namespace, and every service method is typed against them — including nullable fields, which are typed as | null.

import { Client, Customers, type Models } from "@revenexx/node";

const customers = new Customers(client);

const address: Models.Address = await customers.customersAddressesGet({
    id: '<ADDRESS_ID>',
});

console.log(address.street, address.city);
console.log(address.company); // string | null

Error Handling

The Revenexx Node SDK raises a RevenexxAPIRevenexxException object with message, code and response properties. You can handle any errors by catching the exception and present the message to the user or handle it yourself based on the provided error information.

const { RevenexxAPIRevenexxException, Products } = require('@revenexx/node');

const products = new Products(client);

try {
    const product = await products.productsGet({ id: '<PRODUCT_ID>' });
    console.log(product);
} catch (error) {
    if (error instanceof RevenexxAPIRevenexxException) {
        console.error(error.code, error.message);
    }
}

Learn more

You can use the following resources to learn more and get help

• 📜 Revenexx Docs
• 💬 Discord Community

Contribution

This library is auto-generated by the Revenexx custom SDK Generator. To learn more about how you can help us improve this SDK, please check the contribution guide before sending a pull-request.

License

Please see the license file for more information.