@omnibase/core-js 0.8.0 → 0.9.0

package/docs/CreateRole200Response.md

@@ -0,0 +1,36 @@
+
+# CreateRole200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [ModelsRole](ModelsRole.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { CreateRole200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies CreateRole200Response
+
+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 CreateRole200Response
+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/CreateTenant200Response.md

@@ -0,0 +1,36 @@
+
+# CreateTenant200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [TenantsCreateTenantResponse](TenantsCreateTenantResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { CreateTenant200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies CreateTenant200Response
+
+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 CreateTenant200Response
+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/DatabaseApi.md

@@ -0,0 +1,83 @@
+# DatabaseApi
+
+All URIs are relative to *http://https://api.omnibase.tech/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**uploadDatabaseMigrations**](DatabaseApi.md#uploaddatabasemigrations) | **POST** /database/migrations | Upload database migrations |
+
+
+
+## uploadDatabaseMigrations
+
+> V1MigrationSuccessResponse uploadDatabaseMigrations(migrations)
+
+Upload database migrations
+
+Uploads SQL migration files and applies them to the user\'s PostgreSQL database.  ## Authentication Requires JWT token (typically used by CLI tools, not browser sessions).  ## Migration Format Upload a zip file containing SQL files named like: `001-seed.sql`, `002-rls.sql`, etc. Files are automatically renamed to golang-migrate format: `001_seed.up.sql`, `002_rls.up.sql`.  ## Use Cases - CLI migration uploads via `omnibase db migration push` - CI/CD pipeline integrations - Programmatic schema management
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatabaseApi,
+} from '@omnibase/core-js';
+import type { UploadDatabaseMigrationsRequest } from '@omnibase/core-js';
+
+async function example() {
+  console.log("🚀 Testing @omnibase/core-js SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: BearerAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new DatabaseApi(config);
+
+  const body = {
+    // Blob | Zip file containing SQL migration files
+    migrations: BINARY_DATA_HERE,
+  } satisfies UploadDatabaseMigrationsRequest;
+
+  try {
+    const data = await api.uploadDatabaseMigrations(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **migrations** | `Blob` | Zip file containing SQL migration files | [Defaults to `undefined`] |
+
+### Return type
+
+[**V1MigrationSuccessResponse**](V1MigrationSuccessResponse.md)
+
+### Authorization
+
+[BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Migrations applied successfully |  -  |
+| **400** | No migrations zip file provided |  -  |
+| **401** | Invalid or missing JWT token |  -  |
+| **500** | Migration execution failed |  -  |
+
+[[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/DeleteRole200Response.md

@@ -0,0 +1,36 @@
+
+# DeleteRole200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [TenantsDeleteRoleResponse](TenantsDeleteRoleResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { DeleteRole200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies DeleteRole200Response
+
+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 DeleteRole200Response
+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/DeleteTenant200Response.md

@@ -0,0 +1,36 @@
+
+# DeleteTenant200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [TenantsDeleteTenantResponse](TenantsDeleteTenantResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { DeleteTenant200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies DeleteTenant200Response
+
+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 DeleteTenant200Response
+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/DeployPermissionNamespaces200Response.md

@@ -0,0 +1,36 @@
+
+# DeployPermissionNamespaces200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [V1NamespaceDeploymentResponse](V1NamespaceDeploymentResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { DeployPermissionNamespaces200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies DeployPermissionNamespaces200Response
+
+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 DeployPermissionNamespaces200Response
+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/GetRoleDefinitions200Response.md

@@ -0,0 +1,36 @@
+
+# GetRoleDefinitions200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [TenantsNamespaceDefinitionsResponse](TenantsNamespaceDefinitionsResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { GetRoleDefinitions200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies GetRoleDefinitions200Response
+
+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 GetRoleDefinitions200Response
+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/GetTenantBillingStatus200Response.md

@@ -0,0 +1,36 @@
+
+# GetTenantBillingStatus200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [ModelsBillingStatusResponse](ModelsBillingStatusResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { GetTenantBillingStatus200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies GetTenantBillingStatus200Response
+
+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 GetTenantBillingStatus200Response
+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/GetTenantJWT200Response.md

@@ -0,0 +1,36 @@
+
+# GetTenantJWT200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [TenantsJWTTokenResponse](TenantsJWTTokenResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { GetTenantJWT200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies GetTenantJWT200Response
+
+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 GetTenantJWT200Response
+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/HandlersBadRequestResponse.md

@@ -0,0 +1,36 @@
+
+# HandlersBadRequestResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`status` | number
+
+## Example
+
+```typescript
+import type { HandlersBadRequestResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": Invalid request parameters,
+  "status": 400,
+} satisfies HandlersBadRequestResponse
+
+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 HandlersBadRequestResponse
+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/HandlersForbiddenResponse.md

@@ -0,0 +1,36 @@
+
+# HandlersForbiddenResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`status` | number
+
+## Example
+
+```typescript
+import type { HandlersForbiddenResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": Forbidden,
+  "status": 403,
+} satisfies HandlersForbiddenResponse
+
+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 HandlersForbiddenResponse
+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/HandlersInternalServerErrorResponse.md

@@ -0,0 +1,36 @@
+
+# HandlersInternalServerErrorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`status` | number
+
+## Example
+
+```typescript
+import type { HandlersInternalServerErrorResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": Internal Server Error,
+  "status": 500,
+} satisfies HandlersInternalServerErrorResponse
+
+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 HandlersInternalServerErrorResponse
+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/HandlersNotFoundErrorResponse.md

@@ -0,0 +1,36 @@
+
+# HandlersNotFoundErrorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`status` | number
+
+## Example
+
+```typescript
+import type { HandlersNotFoundErrorResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": Not Found,
+  "status": 404,
+} satisfies HandlersNotFoundErrorResponse
+
+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 HandlersNotFoundErrorResponse
+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/HandlersSuccessResponse.md

@@ -0,0 +1,36 @@
+
+# HandlersSuccessResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | object
+`status` | number
+
+## Example
+
+```typescript
+import type { HandlersSuccessResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies HandlersSuccessResponse
+
+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 HandlersSuccessResponse
+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/HandlersUnauthorizedResponse.md

@@ -0,0 +1,36 @@
+
+# HandlersUnauthorizedResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`status` | number
+
+## Example
+
+```typescript
+import type { HandlersUnauthorizedResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": Unauthorized,
+  "status": 401,
+} satisfies HandlersUnauthorizedResponse
+
+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 HandlersUnauthorizedResponse
+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/ListRoles200Response.md

@@ -0,0 +1,36 @@
+
+# ListRoles200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [TenantsRolesListResponse](TenantsRolesListResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { ListRoles200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies ListRoles200Response
+
+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 ListRoles200Response
+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/ListTenantSubscriptions200Response.md

@@ -0,0 +1,36 @@
+
+# ListTenantSubscriptions200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`data` | [Array<ModelsSubscriptionResponse>](ModelsSubscriptionResponse.md)
+`status` | number
+
+## Example
+
+```typescript
+import type { ListTenantSubscriptions200Response } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "data": null,
+  "status": 200,
+} satisfies ListTenantSubscriptions200Response
+
+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 ListTenantSubscriptions200Response
+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)
+
+