@omnibase/core-js

v0.18.1

Published

7 days ago

OpenAPI client for @omnibase/core-js

0High
0Medium
0Low

phoenixbakervanurk

@omnibase/[email protected]

A TypeScript SDK client for the api.omnibase.tech API.

Usage

First, install the SDK from npm.

npm install @omnibase/core-js --save

Next, try it out.

import {
  Configuration,
  V1AuthApi,
} from '@omnibase/core-js';
import type { CreateUserOperationRequest } from '@omnibase/core-js';

async function example() {
  console.log("🚀 Testing @omnibase/core-js SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: ServiceKeyAuth
    apiKey: "YOUR API KEY",
  });
  const api = new V1AuthApi(config);

  const body = {
    // CreateUserRequest
    createUserRequest: ...,
  } satisfies CreateUserOperationRequest;

  try {
    const data = await api.createUser(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to https://api.omnibase.tech

| Class | Method | HTTP request | Description | ----- | ------ | ------------ | ------------- V1AuthApi | createUser | POST /api/v1/auth/users | Create new user V1AuthApi | getActiveTenant | GET /api/v1/auth/active-tenant | Get active tenant V1AuthApi | getIdentity | GET /api/v1/auth/identity | Get current identity V1AuthApi | getSession | GET /api/v1/auth/session | Get current session V1AuthApi | listTenants | GET /api/v1/auth/tenants | List user's tenants V1AuthApi | logout | POST /api/v1/auth/logout | Logout user V1AuthApi | whoAmI | GET /api/v1/auth/whoami | Check authentication status V1ConfigurationApi | archiveAllStripeConfig | POST /api/v1/stripe/admin/config/archive-all | Archive all Stripe config V1ConfigurationApi | createOrUpdateEmailTemplate | POST /api/v1/email/templates | Create or update email template V1ConfigurationApi | deleteEmailTemplate | DELETE /api/v1/email/templates/{type} | Delete email template V1ConfigurationApi | deployPermissionNamespaces | POST /api/v1/permissions/namespaces | Deploy Keto namespace configurations V1ConfigurationApi | generateDatabaseTypes | GET /api/v1/database/typegen | Generate types from database schema V1ConfigurationApi | getEmailTemplates | GET /api/v1/email/templates | Get all email templates V1ConfigurationApi | getStripeConfigHistory | GET /api/v1/stripe/admin/config/history | Get config history V1ConfigurationApi | getStripeConfigSchema | GET /api/v1/stripe/schema | Get Stripe config schema V1ConfigurationApi | pullStripeConfig | GET /api/v1/stripe/admin/config/pull | Pull config from Stripe V1ConfigurationApi | updateStripeConfig | POST /api/v1/stripe/admin/config | Update Stripe config V1ConfigurationApi | uploadDatabaseMigrations | POST /api/v1/database/migrations | Upload database migrations V1ConfigurationApi | validateStripeConfig | POST /api/v1/stripe/admin/config/validate | Validate Stripe config V1PaymentsApi | addInvoiceLineItem | POST /api/v1/payments/invoices/{invoice_id}/items | Add invoice line item V1PaymentsApi | addInvoiceLineItemWithPriceId | POST /api/v1/payments/invoices/{invoice_id}/items/price | Add invoice line item with price ID V1PaymentsApi | createCheckout | POST /api/v1/payments/checkout | Create checkout session V1PaymentsApi | createCustomerPortal | POST /api/v1/payments/portal | Create customer portal session V1PaymentsApi | createInvoice | POST /api/v1/payments/invoices | Create invoice V1PaymentsApi | finalizeInvoice | POST /api/v1/payments/invoices/{invoice_id}/finalize | Finalize invoice V1PaymentsApi | getInvoice | GET /api/v1/payments/invoices/{invoice_id} | Get invoice V1PaymentsApi | recordUsage | POST /api/v1/payments/usage | Record metered usage V1PaymentsApi | updateInvoice | PATCH /api/v1/payments/invoices/{invoice_id} | Update invoice V1PermissionsApi | checkPermission | POST /api/v1/permissions/check | Check permission V1PermissionsApi | createRelationship | POST /api/v1/permissions/relationships | Create relationship V1PermissionsApi | deleteRelationship | DELETE /api/v1/permissions/relationships | Delete relationship V1StorageApi | deleteObject | DELETE /api/v1/storage/object | Delete file from storage V1StorageApi | downloadFile | POST /api/v1/storage/download | Download file from storage V1StorageApi | uploadFile | POST /api/v1/storage/upload | Upload file to storage V1StripeApi | applyEnterpriseCustom | POST /api/v1/stripe/admin/enterprise/apply-custom | Apply custom enterprise pricing V1StripeApi | applyEnterpriseTemplate | POST /api/v1/stripe/admin/enterprise/apply-template | Apply enterprise template pricing V1StripeApi | calculatePriceCost | POST /api/v1/stripe/config/prices/{price_id}/calculate | Calculate cost for a price V1StripeApi | convertStripeIDToConfigID | GET /api/v1/stripe/convert/stripe-id/{stripe_id} | Convert Stripe ID to config ID V1StripeApi | getEnterprisePricesByID | GET /api/v1/stripe/admin/enterprise/prices/by-id/{enterprise_id} | Get enterprise prices by ID V1StripeApi | getEnterprisePricesByTemplate | GET /api/v1/stripe/admin/enterprise/prices/by-template/{template} | Get enterprise prices by template V1StripeApi | getMeterByID | GET /api/v1/stripe/config/meters/{meter_id} | Get meter by ID V1StripeApi | getPriceByID | GET /api/v1/stripe/config/prices/{price_id} | Get price by ID V1StripeApi | getProductByID | GET /api/v1/stripe/config/products/{product_id} | Get product by ID V1StripeApi | getStripeConfig | GET /api/v1/stripe/config | Get public Stripe config V1StripeApi | getStripeConfigAdmin | GET /api/v1/stripe/admin/config | Get full Stripe config (admin) V1StripeApi | listWebhooks | GET /api/v1/stripe/admin/webhooks | List all webhooks V1TenantsApi | acceptInvite | PUT /api/v1/tenants/invites/accept | Accept tenant invite V1TenantsApi | addSubscription | POST /api/v1/tenants/subscriptions | Add subscription V1TenantsApi | createInvite | POST /api/v1/tenants/invites | Create tenant invite V1TenantsApi | createRole | POST /api/v1/tenants/roles | Create role V1TenantsApi | createTenant | POST /api/v1/tenants | Create tenant V1TenantsApi | deleteRole | DELETE /api/v1/tenants/roles/{role_id} | Delete role V1TenantsApi | deleteTenant | DELETE /api/v1/tenants | Delete tenant V1TenantsApi | getRoleDefinitions | GET /api/v1/tenants/roles/definitions | Get namespace definitions V1TenantsApi | getTenantBillingStatus | GET /api/v1/tenants/billing-status | Get billing status V1TenantsApi | getTenantByID | GET /api/v1/tenants/by-id/{tenant_id} | Get tenant by ID V1TenantsApi | getTenantByStripeCustomerID | GET /api/v1/tenants/by-stripe-customer/{stripe_customer_id} | Get tenant by Stripe customer ID V1TenantsApi | getTenantJWT | GET /api/v1/tenants/jwt | Get PostgREST JWT token V1TenantsApi | getTenantSubscription | GET /api/v1/tenants/subscriptions/{config_price_id} | Get tenant subscription by plan V1TenantsApi | listRoles | GET /api/v1/tenants/roles | List roles V1TenantsApi | listTenantSubscriptions | GET /api/v1/tenants/subscriptions | Get tenant subscriptions V1TenantsApi | listTenantUsers | GET /api/v1/tenants/users | Get tenant users V1TenantsApi | removeSubscription | DELETE /api/v1/tenants/subscriptions | Remove subscription V1TenantsApi | removeTenantUser | DELETE /api/v1/tenants/users | Remove tenant user V1TenantsApi | switchActiveTenant | PUT /api/v1/tenants/switch-active | Switch active tenant V1TenantsApi | updateRole | PUT /api/v1/tenants/roles/{role_id} | Update role V1TenantsApi | updateTenantUserRole | PUT /api/v1/tenants/users | Update user role

Models

Authorization

Authentication schemes defined for the API:

CookieAuth

Type: API key
API key parameter name: ory_kratos_session
Location:

SessionTokenAuth

Type: API key
API key parameter name: X-Session-Token
Location: HTTP header

ServiceKeyAuth

Type: API key
API key parameter name: X-Service-Key
Location: HTTP header

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: 0.18.1
Package version: 0.18.1
Generator version: 7.17.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

For more information, please visit https://omnibase.dev/support

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

MIT