@omnibase/core-js 0.8.0 → 0.9.1

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)
+
+

package/docs/ListTenantUsers200Response.md

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

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

@@ -0,0 +1,34 @@
+
+# ModelsDeleteObjectRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+
+## Example
+
+```typescript
+import type { ModelsDeleteObjectRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": public/avatars/user-123.png,
+} satisfies ModelsDeleteObjectRequest
+
+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 ModelsDeleteObjectRequest
+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/ModelsDownloadRequest.md

@@ -0,0 +1,34 @@
+
+# ModelsDownloadRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+
+## Example
+
+```typescript
+import type { ModelsDownloadRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": public/avatars/user-123.png,
+} satisfies ModelsDownloadRequest
+
+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 ModelsDownloadRequest
+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/ModelsDownloadResponse.md

@@ -0,0 +1,34 @@
+
+# ModelsDownloadResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`downloadUrl` | string
+
+## Example
+
+```typescript
+import type { ModelsDownloadResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "downloadUrl": https://storage.omnibase.dev/bucket/path?signature=...,
+} satisfies ModelsDownloadResponse
+
+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 ModelsDownloadResponse
+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/ModelsMessageResponse.md

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

@@ -0,0 +1,44 @@
+
+# ModelsMeter
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customerMapping` | [ModelsMeterCustomerMapping](ModelsMeterCustomerMapping.md)
+`defaultAggregation` | [ModelsMeterDefaultAggregation](ModelsMeterDefaultAggregation.md)
+`displayName` | string
+`eventName` | string
+`id` | string
+`valueSettings` | [ModelsMeterValueSettings](ModelsMeterValueSettings.md)
+
+## Example
+
+```typescript
+import type { ModelsMeter } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "customerMapping": null,
+  "defaultAggregation": null,
+  "displayName": null,
+  "eventName": null,
+  "id": null,
+  "valueSettings": null,
+} satisfies ModelsMeter
+
+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 ModelsMeter
+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/ModelsMeterCustomerMapping.md

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

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

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

@@ -0,0 +1,46 @@
+
+# ModelsMeterWithStripeID
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customerMapping` | [ModelsMeterCustomerMapping](ModelsMeterCustomerMapping.md)
+`defaultAggregation` | [ModelsMeterDefaultAggregation](ModelsMeterDefaultAggregation.md)
+`displayName` | string
+`eventName` | string
+`id` | string
+`stripeId` | string
+`valueSettings` | [ModelsMeterValueSettings](ModelsMeterValueSettings.md)
+
+## Example
+
+```typescript
+import type { ModelsMeterWithStripeID } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "customerMapping": null,
+  "defaultAggregation": null,
+  "displayName": null,
+  "eventName": null,
+  "id": null,
+  "stripeId": null,
+  "valueSettings": null,
+} satisfies ModelsMeterWithStripeID
+
+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 ModelsMeterWithStripeID
+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/ModelsNamespaceDefinition.md

@@ -0,0 +1,40 @@
+
+# ModelsNamespaceDefinition
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`namespace` | string
+`relations` | Array<string>
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { ModelsNamespaceDefinition } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "namespace": null,
+  "relations": null,
+  "updatedAt": null,
+} satisfies ModelsNamespaceDefinition
+
+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 ModelsNamespaceDefinition
+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/ModelsPrice.md

@@ -0,0 +1,60 @@
+
+# ModelsPrice
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`amount` | number
+`billingScheme` | string
+`currency` | string
+`_default` | boolean
+`id` | string
+`interval` | string
+`intervalCount` | number
+`meter` | string
+`_public` | boolean
+`taxIncludedInPrice` | boolean
+`tiers` | [Array<ModelsTier>](ModelsTier.md)
+`tiersMode` | string
+`ui` | [ModelsPriceUI](ModelsPriceUI.md)
+`usageType` | string
+
+## Example
+
+```typescript
+import type { ModelsPrice } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "amount": null,
+  "billingScheme": null,
+  "currency": null,
+  "_default": null,
+  "id": null,
+  "interval": null,
+  "intervalCount": null,
+  "meter": null,
+  "_public": null,
+  "taxIncludedInPrice": null,
+  "tiers": null,
+  "tiersMode": null,
+  "ui": null,
+  "usageType": null,
+} satisfies ModelsPrice
+
+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 ModelsPrice
+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/ModelsPriceDisplay.md

@@ -0,0 +1,38 @@
+
+# ModelsPriceDisplay
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`customText` | string
+`showCurrency` | boolean
+`suffix` | string
+
+## Example
+
+```typescript
+import type { ModelsPriceDisplay } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "customText": null,
+  "showCurrency": null,
+  "suffix": null,
+} satisfies ModelsPriceDisplay
+
+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 ModelsPriceDisplay
+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)
+
+