@omnibase/core-js 0.8.0 → 0.9.1

package/docs/ModelsPriceLimit.md

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

@@ -0,0 +1,42 @@
+
+# ModelsPriceUI
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`billingPeriod` | string
+`displayName` | string
+`features` | Array<string>
+`limits` | [Array<ModelsPriceLimit>](ModelsPriceLimit.md)
+`priceDisplay` | [ModelsPriceDisplay](ModelsPriceDisplay.md)
+
+## Example
+
+```typescript
+import type { ModelsPriceUI } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "billingPeriod": null,
+  "displayName": null,
+  "features": null,
+  "limits": null,
+  "priceDisplay": null,
+} satisfies ModelsPriceUI
+
+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 ModelsPriceUI
+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/ModelsPriceWithStripeID.md

@@ -0,0 +1,62 @@
+
+# ModelsPriceWithStripeID
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`amount` | number
+`billingScheme` | string
+`currency` | string
+`_default` | boolean
+`id` | string
+`interval` | string
+`intervalCount` | number
+`meter` | string
+`_public` | boolean
+`stripeId` | string
+`taxIncludedInPrice` | boolean
+`tiers` | [Array<ModelsTier>](ModelsTier.md)
+`tiersMode` | string
+`ui` | [ModelsPriceUI](ModelsPriceUI.md)
+`usageType` | string
+
+## Example
+
+```typescript
+import type { ModelsPriceWithStripeID } 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,
+  "stripeId": null,
+  "taxIncludedInPrice": null,
+  "tiers": null,
+  "tiersMode": null,
+  "ui": null,
+  "usageType": null,
+} satisfies ModelsPriceWithStripeID
+
+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 ModelsPriceWithStripeID
+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/ModelsProduct.md

@@ -0,0 +1,44 @@
+
+# ModelsProduct
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`id` | string
+`name` | string
+`prices` | [Array<ModelsPrice>](ModelsPrice.md)
+`type` | string
+`ui` | [ModelsProductUI](ModelsProductUI.md)
+
+## Example
+
+```typescript
+import type { ModelsProduct } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "id": null,
+  "name": null,
+  "prices": null,
+  "type": null,
+  "ui": null,
+} satisfies ModelsProduct
+
+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 ModelsProduct
+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/ModelsProductUI.md

@@ -0,0 +1,46 @@
+
+# ModelsProductUI
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`badge` | string
+`ctaText` | string
+`displayName` | string
+`features` | Array<string>
+`highlighted` | boolean
+`sortOrder` | number
+`tagline` | string
+
+## Example
+
+```typescript
+import type { ModelsProductUI } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "badge": null,
+  "ctaText": null,
+  "displayName": null,
+  "features": null,
+  "highlighted": null,
+  "sortOrder": null,
+  "tagline": null,
+} satisfies ModelsProductUI
+
+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 ModelsProductUI
+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/ModelsProductWithStripeIDs.md

@@ -0,0 +1,46 @@
+
+# ModelsProductWithStripeIDs
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`description` | string
+`id` | string
+`name` | string
+`prices` | [Array<ModelsPriceWithStripeID>](ModelsPriceWithStripeID.md)
+`stripeId` | string
+`type` | string
+`ui` | [ModelsProductUI](ModelsProductUI.md)
+
+## Example
+
+```typescript
+import type { ModelsProductWithStripeIDs } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "description": null,
+  "id": null,
+  "name": null,
+  "prices": null,
+  "stripeId": null,
+  "type": null,
+  "ui": null,
+} satisfies ModelsProductWithStripeIDs
+
+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 ModelsProductWithStripeIDs
+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/ModelsRole.md

@@ -0,0 +1,46 @@
+
+# ModelsRole
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`id` | string
+`permissions` | Array<string>
+`roleName` | string
+`tenantId` | string
+`updatedAt` | string
+`userIds` | Array<string>
+
+## Example
+
+```typescript
+import type { ModelsRole } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "id": null,
+  "permissions": null,
+  "roleName": null,
+  "tenantId": null,
+  "updatedAt": null,
+  "userIds": null,
+} satisfies ModelsRole
+
+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 ModelsRole
+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/ModelsStripeConfiguration.md

@@ -0,0 +1,38 @@
+
+# ModelsStripeConfiguration
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`meters` | [Array<ModelsMeter>](ModelsMeter.md)
+`products` | [Array<ModelsProduct>](ModelsProduct.md)
+`version` | string
+
+## Example
+
+```typescript
+import type { ModelsStripeConfiguration } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "meters": null,
+  "products": null,
+  "version": null,
+} satisfies ModelsStripeConfiguration
+
+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 ModelsStripeConfiguration
+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/ModelsStripeConfigurationWithIDs.md

@@ -0,0 +1,38 @@
+
+# ModelsStripeConfigurationWithIDs
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`meters` | [Array<ModelsMeterWithStripeID>](ModelsMeterWithStripeID.md)
+`products` | [Array<ModelsProductWithStripeIDs>](ModelsProductWithStripeIDs.md)
+`version` | string
+
+## Example
+
+```typescript
+import type { ModelsStripeConfigurationWithIDs } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "meters": null,
+  "products": null,
+  "version": null,
+} satisfies ModelsStripeConfigurationWithIDs
+
+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 ModelsStripeConfigurationWithIDs
+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

@@ -0,0 +1,42 @@
+
+# ModelsSubscriptionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`configPriceId` | string
+`currentPeriodEnd` | number
+`isLegacyPrice` | boolean
+`status` | string
+`subscriptionId` | string
+
+## Example
+
+```typescript
+import type { ModelsSubscriptionResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "configPriceId": null,
+  "currentPeriodEnd": null,
+  "isLegacyPrice": null,
+  "status": null,
+  "subscriptionId": null,
+} satisfies ModelsSubscriptionResponse
+
+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 ModelsSubscriptionResponse
+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/ModelsTenant.md

@@ -0,0 +1,46 @@
+
+# ModelsTenant
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`id` | string
+`name` | string
+`settings` | [ModelsTenantSettings](ModelsTenantSettings.md)
+`stripeCustomerId` | string
+`type` | string
+`updatedAt` | string
+
+## Example
+
+```typescript
+import type { ModelsTenant } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "id": null,
+  "name": null,
+  "settings": null,
+  "stripeCustomerId": null,
+  "type": null,
+  "updatedAt": null,
+} satisfies ModelsTenant
+
+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 ModelsTenant
+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/ModelsTenantInvite.md

@@ -0,0 +1,52 @@
+
+# ModelsTenantInvite
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`createdAt` | string
+`email` | string
+`expiresAt` | string
+`id` | string
+`inviterId` | string
+`role` | string
+`tenant` | [ModelsTenant](ModelsTenant.md)
+`tenantId` | string
+`token` | string
+`usedAt` | string
+
+## Example
+
+```typescript
+import type { ModelsTenantInvite } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "createdAt": null,
+  "email": null,
+  "expiresAt": null,
+  "id": null,
+  "inviterId": null,
+  "role": null,
+  "tenant": null,
+  "tenantId": null,
+  "token": null,
+  "usedAt": null,
+} satisfies ModelsTenantInvite
+
+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 ModelsTenantInvite
+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/ModelsTenantSettings.md

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

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

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

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