@omnibase/core-js 0.8.0 → 0.9.0

package/docs/TenantsAssignRoleRequest.md

@@ -0,0 +1,36 @@
+
+# TenantsAssignRoleRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`roleId` | string
+`roleName` | string
+
+## Example
+
+```typescript
+import type { TenantsAssignRoleRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "roleId": 123e4567-e89b-12d3-a456-426614174000,
+  "roleName": admin,
+} satisfies TenantsAssignRoleRequest
+
+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 TenantsAssignRoleRequest
+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/TenantsAssignRoleResponse.md

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

@@ -0,0 +1,36 @@
+
+# TenantsCreateRoleRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`permissions` | Array<string>
+`roleName` | string
+
+## Example
+
+```typescript
+import type { TenantsCreateRoleRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "permissions": [project:*#view, tenant#read],
+  "roleName": project_viewer,
+} satisfies TenantsCreateRoleRequest
+
+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 TenantsCreateRoleRequest
+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/TenantsCreateTenantRequest.md

@@ -0,0 +1,38 @@
+
+# TenantsCreateTenantRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`billingEmail` | string
+`name` | string
+`userId` | string
+
+## Example
+
+```typescript
+import type { TenantsCreateTenantRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "billingEmail": billing@acme.com,
+  "name": Acme Corp,
+  "userId": 550e8400-e29b-41d4-a716-446655440000,
+} satisfies TenantsCreateTenantRequest
+
+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 TenantsCreateTenantRequest
+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/TenantsCreateTenantResponse.md

@@ -0,0 +1,38 @@
+
+# TenantsCreateTenantResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`tenant` | [ModelsTenant](ModelsTenant.md)
+`token` | string
+
+## Example
+
+```typescript
+import type { TenantsCreateTenantResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": Tenant created successfully,
+  "tenant": null,
+  "token": eyJhbGciOiJIUzI1NiIs...,
+} satisfies TenantsCreateTenantResponse
+
+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 TenantsCreateTenantResponse
+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/TenantsCreateTenantUserInviteRequest.md

@@ -0,0 +1,38 @@
+
+# TenantsCreateTenantUserInviteRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`inviteUrl` | string
+`role` | string
+
+## Example
+
+```typescript
+import type { TenantsCreateTenantUserInviteRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": user@example.com,
+  "inviteUrl": https://app.example.com/accept-invite,
+  "role": member,
+} satisfies TenantsCreateTenantUserInviteRequest
+
+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 TenantsCreateTenantUserInviteRequest
+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/TenantsCreateTenantUserInviteResponse.md

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

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

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

@@ -0,0 +1,34 @@
+
+# TenantsDeleteTenantUserRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+
+## Example
+
+```typescript
+import type { TenantsDeleteTenantUserRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": 550e8400-e29b-41d4-a716-446655440000,
+} satisfies TenantsDeleteTenantUserRequest
+
+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 TenantsDeleteTenantUserRequest
+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/TenantsJWTTokenResponse.md

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

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

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

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

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

@@ -0,0 +1,42 @@
+
+# TenantsTenantUserResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`email` | string
+`firstName` | string
+`lastName` | string
+`role` | string
+`userId` | string
+
+## Example
+
+```typescript
+import type { TenantsTenantUserResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "email": john.doe@example.com,
+  "firstName": John,
+  "lastName": Doe,
+  "role": member,
+  "userId": 550e8400-e29b-41d4-a716-446655440000,
+} satisfies TenantsTenantUserResponse
+
+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 TenantsTenantUserResponse
+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/TenantsUpdateRoleRequest.md

@@ -0,0 +1,34 @@
+
+# TenantsUpdateRoleRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`permissions` | Array<string>
+
+## Example
+
+```typescript
+import type { TenantsUpdateRoleRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "permissions": [project:*#view, project:*#edit],
+} satisfies TenantsUpdateRoleRequest
+
+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 TenantsUpdateRoleRequest
+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/TenantsUpdateTenantUserRoleRequest.md

@@ -0,0 +1,36 @@
+
+# TenantsUpdateTenantUserRoleRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`role` | string
+`userId` | string
+
+## Example
+
+```typescript
+import type { TenantsUpdateTenantUserRoleRequest } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "role": admin,
+  "userId": 550e8400-e29b-41d4-a716-446655440000,
+} satisfies TenantsUpdateTenantUserRoleRequest
+
+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 TenantsUpdateTenantUserRoleRequest
+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/TenantsUpdateTenantUserRoleResponse.md

@@ -0,0 +1,34 @@
+
+# TenantsUpdateTenantUserRoleResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { TenantsUpdateTenantUserRoleResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": User role updated successfully,
+} satisfies TenantsUpdateTenantUserRoleResponse
+
+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 TenantsUpdateTenantUserRoleResponse
+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)
+
+