@sfxcode/nuxt-mongocamp-server 1.2.8 → 1.3.0

package/dist/runtime/api/docs/LoginResult.md

@@ -0,0 +1,38 @@
+
+# LoginResult
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`authToken` | string
+`userProfile` | [UserProfile](UserProfile.md)
+`expirationDate` | Date
+
+## Example
+
+```typescript
+import type { LoginResult } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "authToken": null,
+  "userProfile": null,
+  "expirationDate": null,
+} satisfies LoginResult
+
+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 LoginResult
+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/dist/runtime/api/docs/MongoAggregateRequest.md

@@ -0,0 +1,36 @@
+
+# MongoAggregateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`pipeline` | [Array<PipelineStage>](PipelineStage.md)
+`allowDiskUse` | boolean
+
+## Example
+
+```typescript
+import type { MongoAggregateRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "pipeline": null,
+  "allowDiskUse": null,
+} satisfies MongoAggregateRequest
+
+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 MongoAggregateRequest
+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/dist/runtime/api/docs/MongoCampConfiguration.md

@@ -0,0 +1,42 @@
+
+# MongoCampConfiguration
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`key` | string
+`value` | string
+`configType` | string
+`comment` | string
+`needsRestartForActivation` | boolean
+
+## Example
+
+```typescript
+import type { MongoCampConfiguration } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "key": null,
+  "value": null,
+  "configType": null,
+  "comment": null,
+  "needsRestartForActivation": null,
+} satisfies MongoCampConfiguration
+
+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 MongoCampConfiguration
+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/dist/runtime/api/docs/MongoFindRequest.md

@@ -0,0 +1,38 @@
+
+# MongoFindRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filter` | { [key: string]: string; }
+`sort` | { [key: string]: string; }
+`projection` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { MongoFindRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "filter": null,
+  "sort": null,
+  "projection": null,
+} satisfies MongoFindRequest
+
+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 MongoFindRequest
+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/dist/runtime/api/docs/MongoIndex.md

@@ -0,0 +1,56 @@
+
+# MongoIndex
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`fields` | Array<string>
+`unique` | boolean
+`version` | number
+`namespace` | string
+`keys` | { [key: string]: string; }
+`weights` | { [key: string]: string; }
+`expire` | boolean
+`expireAfterSeconds` | number
+`text` | boolean
+`fetched` | Date
+`map` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { MongoIndex } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "fields": null,
+  "unique": null,
+  "version": null,
+  "namespace": null,
+  "keys": null,
+  "weights": null,
+  "expire": null,
+  "expireAfterSeconds": null,
+  "text": null,
+  "fetched": null,
+  "map": null,
+} satisfies MongoIndex
+
+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 MongoIndex
+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/dist/runtime/api/docs/PasswordUpdateRequest.md

@@ -0,0 +1,34 @@
+
+# PasswordUpdateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`password` | string
+
+## Example
+
+```typescript
+import type { PasswordUpdateRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "password": null,
+} satisfies PasswordUpdateRequest
+
+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 PasswordUpdateRequest
+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/dist/runtime/api/docs/PipelineStage.md

@@ -0,0 +1,36 @@
+
+# PipelineStage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`stage` | string
+`value` | string
+
+## Example
+
+```typescript
+import type { PipelineStage } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "stage": null,
+  "value": null,
+} satisfies PipelineStage
+
+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 PipelineStage
+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/dist/runtime/api/docs/Role.md

@@ -0,0 +1,38 @@
+
+# Role
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`isAdmin` | boolean
+`collectionGrants` | [Array<Grant>](Grant.md)
+
+## Example
+
+```typescript
+import type { Role } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "isAdmin": null,
+  "collectionGrants": null,
+} satisfies Role
+
+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 Role
+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/dist/runtime/api/docs/SchemaAnalysis.md

@@ -0,0 +1,40 @@
+
+# SchemaAnalysis
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`count` | number
+`sample` | number
+`percentageOfAnalysed` | number
+`fields` | [Array<SchemaAnalysisField>](SchemaAnalysisField.md)
+
+## Example
+
+```typescript
+import type { SchemaAnalysis } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "count": null,
+  "sample": null,
+  "percentageOfAnalysed": null,
+  "fields": null,
+} satisfies SchemaAnalysis
+
+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 SchemaAnalysis
+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/dist/runtime/api/docs/SchemaAnalysisField.md

@@ -0,0 +1,44 @@
+
+# SchemaAnalysisField
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`fullName` | string
+`fieldTypes` | [Array<SchemaAnalysisFieldType>](SchemaAnalysisFieldType.md)
+`count` | number
+`percentageOfParent` | number
+`subFields` | [Array<SchemaAnalysisField>](SchemaAnalysisField.md)
+
+## Example
+
+```typescript
+import type { SchemaAnalysisField } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "fullName": null,
+  "fieldTypes": null,
+  "count": null,
+  "percentageOfParent": null,
+  "subFields": null,
+} satisfies SchemaAnalysisField
+
+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 SchemaAnalysisField
+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/dist/runtime/api/docs/SchemaAnalysisFieldType.md

@@ -0,0 +1,38 @@
+
+# SchemaAnalysisFieldType
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`fieldType` | string
+`count` | number
+`percentageOfParent` | number
+
+## Example
+
+```typescript
+import type { SchemaAnalysisFieldType } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "fieldType": null,
+  "count": null,
+  "percentageOfParent": null,
+} satisfies SchemaAnalysisFieldType
+
+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 SchemaAnalysisFieldType
+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/dist/runtime/api/docs/SettingsResponse.md

@@ -0,0 +1,40 @@
+
+# SettingsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`routesPlugins` | Array<string>
+`filePlugins` | Array<string>
+`ignoredPlugins` | Array<string>
+`configurations` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { SettingsResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "routesPlugins": null,
+  "filePlugins": null,
+  "ignoredPlugins": null,
+  "configurations": null,
+} satisfies SettingsResponse
+
+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 SettingsResponse
+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/dist/runtime/api/docs/UpdateFileInformationRequest.md

@@ -0,0 +1,36 @@
+
+# UpdateFileInformationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filename` | string
+`metadata` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { UpdateFileInformationRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "filename": null,
+  "metadata": null,
+} satisfies UpdateFileInformationRequest
+
+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 UpdateFileInformationRequest
+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/dist/runtime/api/docs/UpdateRequest.md

@@ -0,0 +1,36 @@
+
+# UpdateRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`document` | { [key: string]: string; }
+`filter` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { UpdateRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "document": null,
+  "filter": null,
+} satisfies UpdateRequest
+
+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 UpdateRequest
+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/dist/runtime/api/docs/UpdateResponse.md

@@ -0,0 +1,40 @@
+
+# UpdateResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`wasAcknowledged` | boolean
+`upsertedIds` | Array<string>
+`modifiedCount` | number
+`matchedCount` | number
+
+## Example
+
+```typescript
+import type { UpdateResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "wasAcknowledged": null,
+  "upsertedIds": null,
+  "modifiedCount": null,
+  "matchedCount": null,
+} satisfies UpdateResponse
+
+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 UpdateResponse
+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/dist/runtime/api/docs/UpdateRoleRequest.md

@@ -0,0 +1,36 @@
+
+# UpdateRoleRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`isAdmin` | boolean
+`collectionGrants` | [Array<Grant>](Grant.md)
+
+## Example
+
+```typescript
+import type { UpdateRoleRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "isAdmin": null,
+  "collectionGrants": null,
+} satisfies UpdateRoleRequest
+
+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 UpdateRoleRequest
+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/dist/runtime/api/docs/UserInformation.md

@@ -0,0 +1,40 @@
+
+# UserInformation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`password` | string
+`apiKey` | string
+`roles` | Array<string>
+
+## Example
+
+```typescript
+import type { UserInformation } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "password": null,
+  "apiKey": null,
+  "roles": null,
+} satisfies UserInformation
+
+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 UserInformation
+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)
+
+