@omnibase/core-js 0.9.4 → 0.9.5

package/docs/ClientIdentity.md

@@ -0,0 +1,62 @@
+
+# ClientIdentity
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`additionalProperties` | { [key: string]: any; }
+`createdAt` | string
+`credentials` | [{ [key: string]: ClientIdentityCredentials; }](ClientIdentityCredentials.md)
+`id` | string
+`metadataAdmin` | object
+`metadataPublic` | object
+`organizationId` | object
+`recoveryAddresses` | [Array<ClientRecoveryIdentityAddress>](ClientRecoveryIdentityAddress.md)
+`schemaId` | string
+`schemaUrl` | string
+`state` | string
+`stateChangedAt` | string
+`traits` | object
+`updatedAt` | string
+`verifiableAddresses` | [Array<ClientVerifiableIdentityAddress>](ClientVerifiableIdentityAddress.md)
+
+## Example
+
+```typescript
+import type { ClientIdentity } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "additionalProperties": null,
+  "createdAt": null,
+  "credentials": null,
+  "id": null,
+  "metadataAdmin": null,
+  "metadataPublic": null,
+  "organizationId": null,
+  "recoveryAddresses": null,
+  "schemaId": null,
+  "schemaUrl": null,
+  "state": null,
+  "stateChangedAt": null,
+  "traits": null,
+  "updatedAt": null,
+  "verifiableAddresses": null,
+} satisfies ClientIdentity
+
+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 ClientIdentity
+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/ClientIdentityCredentials.md

@@ -0,0 +1,46 @@
+
+# ClientIdentityCredentials
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`additionalProperties` | { [key: string]: any; }
+`config` | { [key: string]: any; }
+`createdAt` | string
+`identifiers` | Array<string>
+`type` | string
+`updatedAt` | string
+`version` | number
+
+## Example
+
+```typescript
+import type { ClientIdentityCredentials } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "additionalProperties": null,
+  "config": null,
+  "createdAt": null,
+  "identifiers": null,
+  "type": null,
+  "updatedAt": null,
+  "version": null,
+} satisfies ClientIdentityCredentials
+
+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 ClientIdentityCredentials
+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/ClientRecoveryIdentityAddress.md

@@ -0,0 +1,44 @@
+
+# ClientRecoveryIdentityAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`additionalProperties` | { [key: string]: any; }
+`createdAt` | string
+`id` | string
+`updatedAt` | string
+`value` | string
+`via` | string
+
+## Example
+
+```typescript
+import type { ClientRecoveryIdentityAddress } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "additionalProperties": null,
+  "createdAt": null,
+  "id": null,
+  "updatedAt": null,
+  "value": null,
+  "via": null,
+} satisfies ClientRecoveryIdentityAddress
+
+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 ClientRecoveryIdentityAddress
+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/ClientSession.md

@@ -0,0 +1,54 @@
+
+# ClientSession
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`active` | boolean
+`additionalProperties` | { [key: string]: any; }
+`authenticatedAt` | string
+`authenticationMethods` | [Array<ClientSessionAuthenticationMethod>](ClientSessionAuthenticationMethod.md)
+`authenticatorAssuranceLevel` | [ClientAuthenticatorAssuranceLevel](ClientAuthenticatorAssuranceLevel.md)
+`devices` | [Array<ClientSessionDevice>](ClientSessionDevice.md)
+`expiresAt` | string
+`id` | string
+`identity` | [ClientIdentity](ClientIdentity.md)
+`issuedAt` | string
+`tokenized` | string
+
+## Example
+
+```typescript
+import type { ClientSession } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "active": null,
+  "additionalProperties": null,
+  "authenticatedAt": null,
+  "authenticationMethods": null,
+  "authenticatorAssuranceLevel": null,
+  "devices": null,
+  "expiresAt": null,
+  "id": null,
+  "identity": null,
+  "issuedAt": null,
+  "tokenized": null,
+} satisfies ClientSession
+
+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 ClientSession
+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/ClientSessionAuthenticationMethod.md

@@ -0,0 +1,44 @@
+
+# ClientSessionAuthenticationMethod
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`aal` | [ClientAuthenticatorAssuranceLevel](ClientAuthenticatorAssuranceLevel.md)
+`additionalProperties` | { [key: string]: any; }
+`completedAt` | string
+`method` | string
+`organization` | string
+`provider` | string
+
+## Example
+
+```typescript
+import type { ClientSessionAuthenticationMethod } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "aal": null,
+  "additionalProperties": null,
+  "completedAt": null,
+  "method": null,
+  "organization": null,
+  "provider": null,
+} satisfies ClientSessionAuthenticationMethod
+
+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 ClientSessionAuthenticationMethod
+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/ClientSessionDevice.md

@@ -0,0 +1,42 @@
+
+# ClientSessionDevice
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`additionalProperties` | { [key: string]: any; }
+`id` | string
+`ipAddress` | string
+`location` | string
+`userAgent` | string
+
+## Example
+
+```typescript
+import type { ClientSessionDevice } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "additionalProperties": null,
+  "id": null,
+  "ipAddress": null,
+  "location": null,
+  "userAgent": null,
+} satisfies ClientSessionDevice
+
+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 ClientSessionDevice
+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/ClientVerifiableIdentityAddress.md

@@ -0,0 +1,50 @@
+
+# ClientVerifiableIdentityAddress
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`additionalProperties` | { [key: string]: any; }
+`createdAt` | string
+`id` | string
+`status` | string
+`updatedAt` | string
+`value` | string
+`verified` | boolean
+`verifiedAt` | string
+`via` | string
+
+## Example
+
+```typescript
+import type { ClientVerifiableIdentityAddress } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "additionalProperties": null,
+  "createdAt": null,
+  "id": null,
+  "status": null,
+  "updatedAt": null,
+  "value": null,
+  "verified": null,
+  "verifiedAt": null,
+  "via": null,
+} satisfies ClientVerifiableIdentityAddress
+
+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 ClientVerifiableIdentityAddress
+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/ModelsActiveTenantResponse.md

@@ -0,0 +1,36 @@
+
+# ModelsActiveTenantResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`hasTenant` | boolean
+`tenant` | [ModelsTenant](ModelsTenant.md)
+
+## Example
+
+```typescript
+import type { ModelsActiveTenantResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "hasTenant": true,
+  "tenant": null,
+} satisfies ModelsActiveTenantResponse
+
+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 ModelsActiveTenantResponse
+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/ModelsLogoutResponse.md

@@ -0,0 +1,36 @@
+
+# ModelsLogoutResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`logoutToken` | string
+`logoutUrl` | string
+
+## Example
+
+```typescript
+import type { ModelsLogoutResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "logoutToken": abc123,
+  "logoutUrl": http://auth.example.com/self-service/logout?token=abc123,
+} satisfies ModelsLogoutResponse
+
+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 ModelsLogoutResponse
+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/ModelsSessionResponse.md

@@ -0,0 +1,38 @@
+
+# ModelsSessionResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`identity` | [ClientIdentity](ClientIdentity.md)
+`session` | [ClientSession](ClientSession.md)
+`tenant` | [ModelsTenant](ModelsTenant.md)
+
+## Example
+
+```typescript
+import type { ModelsSessionResponse } from '@omnibase/core-js'
+
+// TODO: Update the object below with actual values
+const example = {
+  "identity": null,
+  "session": null,
+  "tenant": null,
+} satisfies ModelsSessionResponse
+
+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 ModelsSessionResponse
+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/ModelsWhoAmIResponse.md

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