Build with Ruba in TypeScript

Installing

npm
yarn
pnpm

Terminal

npm install @getruba/sdk

Terminal

yarn add @getruba/sdk

Terminal

pnpm add @getruba/sdk

Make the first connection

index.js

import { Ruba } from '@getruba/sdk'

const ruba = new Ruba({
  accessToken: process.env.RUBA_ACCESS_TOKEN,
  server: 'sandbox'
})

async function run() {
  const result = await ruba.benefits.list({ page: 1, limit: 10 })
  for await (const page of result) {
    // Handle the page
    console.log(page)
  }
}

run()

camelCase vs. snake_caseOur API (and docs) is built around snake_case. Still, our TS SDK currently converts this into camelCase to match JS/TS conventions. Modern IDEs will suggest the camelCase parameters automatically thanks to strong typing, but keep in mind the difference when flipping between code & docs.We plan to add a toggle for this down the road, letting you opt into snake_case even in TypeScript so it maps more directly onto our documentation and the API’s own design.

Framework Adapters

Build Checkout & Webhook handlers in just a handful of lines.

Build with Ruba in GoSDK for Golang

⌘I

Launch Path

Shape the Offer

Run the Revenue Model

Deliver Customer Access

Build the Integration

Operate the Business

Implementation Playbooks

Build with Ruba in TypeScript

Installing

Make the first connection

Framework Adapters

​Installing

​Make the first connection

​Framework Adapters

Installing

Make the first connection

Framework Adapters