@omnibase/core-js 0.9.4 → 0.9.7

package/docs/ModelsSessionResponse.md

@@ -0,0 +1,38 @@
+
+# ModelsSessionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identity` | [ClientIdentity](ClientIdentity.md)
+`session` | [ClientSession](ClientSession.md)
+`tenant` | [ModelsTenant](ModelsTenant.md)
+
+## Example
+
+```typescript
+import type { ModelsSessionResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "identity": null,
+  "session": null,
+  "tenant": null,
+} satisfies ModelsSessionResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelsSessionResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ModelsSubscriptionResponse.md

@@ -6,11 +6,16 @@
 
 Name | Type
 ------------ | -------------
+`cancelAtPeriodEnd` | boolean
+`canceledAt` | number
 `configPriceId` | string
 `currentPeriodEnd` | number
+`currentPeriodStart` | number
 `isLegacyPrice` | boolean
 `status` | string
 `subscriptionId` | string
+`trialEnd` | number
+`trialStart` | number
 
 ## Example
 
@@ -19,11 +24,16 @@ import type { ModelsSubscriptionResponse } from '@omnibase/core-js'
 
 // TODO: Update the object below with actual values
 const example = {
+  "cancelAtPeriodEnd": null,
+  "canceledAt": null,
   "configPriceId": null,
   "currentPeriodEnd": null,
+  "currentPeriodStart": null,
   "isLegacyPrice": null,
   "status": null,
   "subscriptionId": null,
+  "trialEnd": null,
+  "trialStart": null,
 } satisfies ModelsSubscriptionResponse
 
 console.log(example)

package/docs/ModelsUserTenantListItem.md

@@ -0,0 +1,36 @@
+
+# ModelsUserTenantListItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`isActive` | boolean
+`tenant` | [ModelsTenant](ModelsTenant.md)
+
+## Example
+
+```typescript
+import type { ModelsUserTenantListItem } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "isActive": true,
+  "tenant": null,
+} satisfies ModelsUserTenantListItem
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelsUserTenantListItem
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/ModelsWhoAmIResponse.md

@@ -0,0 +1,36 @@
+
+# ModelsWhoAmIResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`authenticated` | boolean
+`userId` | string
+
+## Example
+
+```typescript
+import type { ModelsWhoAmIResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "authenticated": true,
+  "userId": 550e8400-e29b-41d4-a716-446655440000,
+} satisfies ModelsWhoAmIResponse
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as ModelsWhoAmIResponse
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/V1AuthApi.md

@@ -0,0 +1,400 @@
+# V1AuthApi
+
+All URIs are relative to *http://https://api.omnibase.tech*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getActiveTenant**](V1AuthApi.md#getactivetenant) | **GET** /api/v1/auth/active-tenant | Get active tenant |
+| [**getIdentity**](V1AuthApi.md#getidentity) | **GET** /api/v1/auth/identity | Get current identity |
+| [**getSession**](V1AuthApi.md#getsession) | **GET** /api/v1/auth/session | Get current session |
+| [**listTenants**](V1AuthApi.md#listtenants) | **GET** /api/v1/auth/tenants | List user\'s tenants |
+| [**logout**](V1AuthApi.md#logout) | **POST** /api/v1/auth/logout | Logout user |
+| [**whoAmI**](V1AuthApi.md#whoami) | **GET** /api/v1/auth/whoami | Check authentication status |
+
+
+
+## getActiveTenant
+
+> GetActiveTenant200Response getActiveTenant()
+
+Get active tenant
+
+Returns the full tenant object for the user\'s currently active tenant.  ## Tenant Context Users can be members of multiple tenants but only one is active at a time. The active tenant determines which resources and data the user can access.  ## Use Case Determine which tenant context to use for API calls and data filtering.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1AuthApi,
+} from '@omnibase/core-js';
+import type { GetActiveTenantRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new V1AuthApi(config);
+
+  try {
+    const data = await api.getActiveTenant();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetActiveTenant200Response**](GetActiveTenant200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Active tenant retrieved |  -  |
+| **401** | Not authenticated |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getIdentity
+
+> GetIdentity200Response getIdentity()
+
+Get current identity
+
+Returns the current authenticated user\'s identity information (traits like email, name).  ## Identity Data - User ID (unique identifier) - Traits (email, first name, last name based on identity schema) - Schema ID - Created/updated timestamps  ## Use Case Lighter alternative to full session when you only need user profile data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1AuthApi,
+} from '@omnibase/core-js';
+import type { GetIdentityRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new V1AuthApi(config);
+
+  try {
+    const data = await api.getIdentity();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetIdentity200Response**](GetIdentity200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Identity retrieved successfully |  -  |
+| **401** | Not authenticated or session expired |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getSession
+
+> GetSession200Response getSession()
+
+Get current session
+
+Returns the current authenticated user\'s session including identity and tenant information.  ## Session Data - Session metadata (ID, expiry, authentication methods) - Identity information (user ID, traits like email, name) - Active tenant context (if user has tenant membership)  ## Authentication Requires valid session via Cookie or X-Session-Token header.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1AuthApi,
+} from '@omnibase/core-js';
+import type { GetSessionRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new V1AuthApi(config);
+
+  try {
+    const data = await api.getSession();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetSession200Response**](GetSession200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Session retrieved successfully |  -  |
+| **401** | Not authenticated or session expired |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listTenants
+
+> ListTenants200Response listTenants()
+
+List user\'s tenants
+
+Returns all tenants the user is a member of with their active status.  ## Tenant Memberships Users can be members of multiple tenants. Each membership has: - Active status (only one tenant can be active at a time) - Full tenant information (ID, name, type, etc.)  ## Use Case Display tenant switcher UI or list all organizations the user belongs to.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1AuthApi,
+} from '@omnibase/core-js';
+import type { ListTenantsRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new V1AuthApi(config);
+
+  try {
+    const data = await api.listTenants();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListTenants200Response**](ListTenants200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Tenants retrieved successfully |  -  |
+| **401** | Not authenticated |  -  |
+| **500** | Failed to fetch tenants |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## logout
+
+> Logout200Response logout()
+
+Logout user
+
+Creates a Kratos logout flow and returns the logout URL for browser redirect.  ## Logout Process 1. Request this endpoint to get logout URL 2. Redirect browser to the returned logout_url 3. Session will be invalidated and user logged out  ## Cookie Cleanup The logout URL handles clearing session cookies automatically.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1AuthApi,
+} from '@omnibase/core-js';
+import type { LogoutRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new V1AuthApi(config);
+
+  try {
+    const data = await api.logout();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Logout200Response**](Logout200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Logout flow created successfully |  -  |
+| **401** | Not authenticated |  -  |
+| **500** | Failed to create logout flow |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## whoAmI
+
+> WhoAmI200Response whoAmI()
+
+Check authentication status
+
+Lightweight endpoint to check if the user is authenticated.  ## Response Returns boolean authentication status and user ID if authenticated.  ## Use Case Quick auth checks for route guards without fetching full session data.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  V1AuthApi,
+} from '@omnibase/core-js';
+import type { WhoAmIRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: SessionAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new V1AuthApi(config);
+
+  try {
+    const data = await api.whoAmI();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**WhoAmI200Response**](WhoAmI200Response.md)
+
+### Authorization
+
+[SessionAuth](../README.md#SessionAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Authentication status checked |  -  |
+| **401** | Not authenticated |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/WhoAmI200Response.md

@@ -0,0 +1,36 @@
+
+# WhoAmI200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [ModelsWhoAmIResponse](ModelsWhoAmIResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { WhoAmI200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": null,
+} satisfies WhoAmI200Response
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WhoAmI200Response
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@omnibase/core-js",
-  "version": "0.9.4",
+  "version": "0.9.7",
   "description": "OpenAPI client for @omnibase/core-js",
   "author": "OpenAPI-Generator",
   "repository": {