@omnibase/core-js 0.8.0 → 0.9.0

package/docs/UpdateTenantUserRole200Response.md

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

@@ -0,0 +1,44 @@
+
+# V1ArchiveAllResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`archiveErrors` | Array<string>
+`archivedItems` | Array<string>
+`message` | string
+`totalArchived` | number
+`totalErrors` | number
+`warning` | string
+
+## Example
+
+```typescript
+import type { V1ArchiveAllResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "archiveErrors": null,
+  "archivedItems": null,
+  "message": Successfully archived all Stripe resources and cleared local config,
+  "totalArchived": 15,
+  "totalErrors": 0,
+  "warning": Some items failed to archive - see archive_errors for details,
+} satisfies V1ArchiveAllResponse
+
+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 V1ArchiveAllResponse
+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/V1CheckPermissionRequest.md

@@ -0,0 +1,42 @@
+
+# V1CheckPermissionRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`namespace` | string
+`object` | string
+`relation` | string
+`subjectId` | string
+`subjectSet` | [V1SubjectSetRequest](V1SubjectSetRequest.md)
+
+## Example
+
+```typescript
+import type { V1CheckPermissionRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "namespace": Tenant,
+  "object": tenant-123,
+  "relation": view_db_secret_key,
+  "subjectId": user-456,
+  "subjectSet": null,
+} satisfies V1CheckPermissionRequest
+
+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 V1CheckPermissionRequest
+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/V1CheckPermissionResponse.md

@@ -0,0 +1,34 @@
+
+# V1CheckPermissionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allowed` | boolean
+
+## Example
+
+```typescript
+import type { V1CheckPermissionResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "allowed": true,
+} satisfies V1CheckPermissionResponse
+
+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 V1CheckPermissionResponse
+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/V1ConfigHistoryItem.md

@@ -0,0 +1,44 @@
+
+# V1ConfigHistoryItem
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`config` | [ModelsStripeConfigurationWithIDs](ModelsStripeConfigurationWithIDs.md)
+`createdAt` | string
+`id` | string
+`parseError` | string
+`updatedAt` | string
+`version` | string
+
+## Example
+
+```typescript
+import type { V1ConfigHistoryItem } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "config": null,
+  "createdAt": null,
+  "id": null,
+  "parseError": null,
+  "updatedAt": null,
+  "version": null,
+} satisfies V1ConfigHistoryItem
+
+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 V1ConfigHistoryItem
+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/V1ConfigHistoryPagination.md

@@ -0,0 +1,44 @@
+
+# V1ConfigHistoryPagination
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`hasNext` | boolean
+`hasPrev` | boolean
+`page` | number
+`perPage` | number
+`total` | number
+`totalPages` | number
+
+## Example
+
+```typescript
+import type { V1ConfigHistoryPagination } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "hasNext": true,
+  "hasPrev": false,
+  "page": 1,
+  "perPage": 10,
+  "total": 50,
+  "totalPages": 5,
+} satisfies V1ConfigHistoryPagination
+
+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 V1ConfigHistoryPagination
+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/V1ConfigHistoryResponse.md

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

@@ -0,0 +1,44 @@
+
+# V1CreateCheckoutRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`allowPromotionCodes` | boolean
+`cancelUrl` | string
+`priceId` | string
+`promotionCode` | string
+`successUrl` | string
+`trialPeriodDays` | number
+
+## Example
+
+```typescript
+import type { V1CreateCheckoutRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "allowPromotionCodes": true,
+  "cancelUrl": https://example.com/cancel,
+  "priceId": price_basic_monthly,
+  "promotionCode": SUMMER2024,
+  "successUrl": https://example.com/success,
+  "trialPeriodDays": 14,
+} satisfies V1CreateCheckoutRequest
+
+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 V1CreateCheckoutRequest
+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/V1CreateCheckoutResponse.md

@@ -0,0 +1,36 @@
+
+# V1CreateCheckoutResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`sessionId` | string
+`url` | string
+
+## Example
+
+```typescript
+import type { V1CreateCheckoutResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "sessionId": cs_test_a1b2c3d4e5f6,
+  "url": https://checkout.stripe.com/pay/cs_test_...,
+} satisfies V1CreateCheckoutResponse
+
+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 V1CreateCheckoutResponse
+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/V1CreatePortalRequest.md

@@ -0,0 +1,34 @@
+
+# V1CreatePortalRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`returnUrl` | string
+
+## Example
+
+```typescript
+import type { V1CreatePortalRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "returnUrl": https://example.com/dashboard,
+} satisfies V1CreatePortalRequest
+
+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 V1CreatePortalRequest
+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/V1CreatePortalResponse.md

@@ -0,0 +1,34 @@
+
+# V1CreatePortalResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+
+## Example
+
+```typescript
+import type { V1CreatePortalResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": https://billing.stripe.com/session/live_...,
+} satisfies V1CreatePortalResponse
+
+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 V1CreatePortalResponse
+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/V1CreateRelationshipRequest.md

@@ -0,0 +1,42 @@
+
+# V1CreateRelationshipRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`namespace` | string
+`object` | string
+`relation` | string
+`subjectId` | string
+`subjectSet` | [V1SubjectSetRequest](V1SubjectSetRequest.md)
+
+## Example
+
+```typescript
+import type { V1CreateRelationshipRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "namespace": Project,
+  "object": project-123,
+  "relation": tenant,
+  "subjectId": user-456,
+  "subjectSet": null,
+} satisfies V1CreateRelationshipRequest
+
+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 V1CreateRelationshipRequest
+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/V1CreateRelationshipResponse.md

@@ -0,0 +1,36 @@
+
+# V1CreateRelationshipResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`relationship` | [ClientRelationship](ClientRelationship.md)
+
+## Example
+
+```typescript
+import type { V1CreateRelationshipResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Relationship created successfully,
+  "relationship": null,
+} satisfies V1CreateRelationshipResponse
+
+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 V1CreateRelationshipResponse
+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/V1MigrationErrorResponse.md

@@ -0,0 +1,36 @@
+
+# V1MigrationErrorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`status` | number
+
+## Example
+
+```typescript
+import type { V1MigrationErrorResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": No migrations zip file provided,
+  "status": 400,
+} satisfies V1MigrationErrorResponse
+
+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 V1MigrationErrorResponse
+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/V1MigrationSuccessResponse.md

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

@@ -0,0 +1,42 @@
+
+# V1NamespaceDeploymentResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`managedMode` | boolean
+`message` | string
+`path` | string
+`rolesSynced` | number
+`tenantId` | string
+
+## Example
+
+```typescript
+import type { V1NamespaceDeploymentResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "managedMode": true,
+  "message": Namespaces deployed successfully,
+  "path": tenant-123/latest.zip,
+  "rolesSynced": 5,
+  "tenantId": tenant-123,
+} satisfies V1NamespaceDeploymentResponse
+
+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 V1NamespaceDeploymentResponse
+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/V1RecordUsageRequest.md

@@ -0,0 +1,36 @@
+
+# V1RecordUsageRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`meterEventName` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { V1RecordUsageRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "meterEventName": api_requests,
+  "value": 100,
+} satisfies V1RecordUsageRequest
+
+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 V1RecordUsageRequest
+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)
+
+