@omnibase/core-js 0.9.14 → 0.9.16

package/docs/UploadResponse.md

@@ -0,0 +1,36 @@
+
+# UploadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`uploadUrl` | string
+`path` | string
+
+## Example
+
+```typescript
+import type { UploadResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "uploadUrl": https://storage.test.example.com/bucket/path?signature=...,
+  "path": avatars/user-123.png,
+} satisfies UploadResponse
+
+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 UploadResponse
+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/UsageType.md

@@ -0,0 +1,33 @@
+
+# UsageType
+
+Usage type for recurring prices
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { UsageType } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies UsageType
+
+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 UsageType
+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/UserTenantListItem.md

@@ -0,0 +1,37 @@
+
+# UserTenantListItem
+
+Simplified tenant info for user\'s tenant list
+
+## Properties
+
+Name | Type
+------------ | -------------
+`tenant` | [Tenant](Tenant.md)
+`isActive` | boolean
+
+## Example
+
+```typescript
+import type { UserTenantListItem } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "tenant": null,
+  "isActive": true,
+} satisfies UserTenantListItem
+
+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 UserTenantListItem
+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

@@ -1,9 +1,10 @@
 # V1AuthApi
 
-All URIs are relative to *http://api.omnibase.tech*
+All URIs are relative to *https://api.omnibase.tech*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**createUser**](V1AuthApi.md#createuseroperation) | **POST** /api/v1/auth/users | Create new user |
 | [**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 |
@@ -13,13 +14,88 @@ All URIs are relative to *http://api.omnibase.tech*
 
 
 
+## createUser
+
+> CreateUser200Response createUser(createUserRequest)
+
+Create new user
+
+Creates a new user identity via Kratos admin API with email/password credentials.  ## User Creation - Creates Kratos identity with provided traits (email, name) - Sets up password authentication credentials - Returns the created identity information  ## Use Case Administrative user creation endpoint for onboarding flows or user management.  ## Authentication This is an admin endpoint that requires service key authentication. 
+
+### Example
+
+```ts
+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);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **createUserRequest** | [CreateUserRequest](CreateUserRequest.md) |  | |
+
+### Return type
+
+[**CreateUser200Response**](CreateUser200Response.md)
+
+### Authorization
+
+[ServiceKeyAuth](../README.md#ServiceKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | User created successfully |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **409** | Conflict - Resource already exists or conflicts with current state |  -  |
+| **500** | Internal Server Error - Server encountered an error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## 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.
+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
 
@@ -33,7 +109,9 @@ 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
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1AuthApi(config);
@@ -60,19 +138,20 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Active tenant retrieved |  -  |
-| **401** | Not authenticated |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -83,7 +162,7 @@ This endpoint does not need any parameter.
 
 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.
+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
 
@@ -97,7 +176,9 @@ 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
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1AuthApi(config);
@@ -124,19 +205,20 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Identity retrieved successfully |  -  |
-| **401** | Not authenticated or session expired |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -147,7 +229,7 @@ This endpoint does not need any parameter.
 
 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.
+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
 
@@ -161,7 +243,9 @@ 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
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1AuthApi(config);
@@ -188,30 +272,31 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Session retrieved successfully |  -  |
-| **401** | Not authenticated or session expired |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
 
 [[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()
+> ListTenants200Response listTenants(xUserId)
 
 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.
+Returns all tenants the user is a member of with their active status.  ## Authentication - **Session Auth**: Requires JWT token / Cookie Session - **Service Key Auth**: Requires X-Service-Key + X-User-ID header  ## 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
 
@@ -225,13 +310,22 @@ 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
+    // To configure API key authorization: ServiceKeyAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1AuthApi(config);
 
+  const body = {
+    // string | User ID (UUID) - Required when using X-Service-Key header (optional)
+    xUserId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies ListTenantsRequest;
+
   try {
-    const data = await api.listTenants();
+    const data = await api.listTenants(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -244,7 +338,10 @@ example().catch(console.error);
 
 ### Parameters
 
-This endpoint does not need any parameter.
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xUserId** | `string` | User ID (UUID) - Required when using X-Service-Key header | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
@@ -252,20 +349,21 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[ServiceKeyAuth](../README.md#ServiceKeyAuth), [CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Tenants retrieved successfully |  -  |
-| **401** | Not authenticated |  -  |
-| **500** | Failed to fetch tenants |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **500** | Internal Server Error - Server encountered an error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -276,7 +374,7 @@ This endpoint does not need any parameter.
 
 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.
+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
 
@@ -290,7 +388,9 @@ 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
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1AuthApi(config);
@@ -317,20 +417,21 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Logout flow created successfully |  -  |
-| **401** | Not authenticated |  -  |
-| **500** | Failed to create logout flow |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
+| **500** | Internal Server Error - Server encountered an error |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -341,7 +442,7 @@ This endpoint does not need any parameter.
 
 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.
+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
 
@@ -355,7 +456,9 @@ 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
+    // To configure API key authorization: CookieAuth
+    apiKey: "YOUR API KEY",
+    // To configure API key authorization: SessionTokenAuth
     apiKey: "YOUR API KEY",
   });
   const api = new V1AuthApi(config);
@@ -382,19 +485,20 @@ This endpoint does not need any parameter.
 
 ### Authorization
 
-[SessionAuth](../README.md#SessionAuth)
+[CookieAuth](../README.md#CookieAuth), [SessionTokenAuth](../README.md#SessionTokenAuth)
 
 ### HTTP request headers
 
 - **Content-Type**: Not defined
-- **Accept**: `application/json`
+- **Accept**: `application/json`, `text/plain`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | Authentication status checked |  -  |
-| **401** | Not authenticated |  -  |
+| **400** | Bad Request - Invalid request parameters |  -  |
+| **401** | Unauthorized - Authentication required |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)