@sfxcode/nuxt-mongocamp-server 1.2.8 → 1.2.9

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

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

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

@@ -0,0 +1,48 @@
+
+# IndexOptionsRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`background` | boolean
+`defaultLanguage` | string
+`textVersion` | number
+`expireAfter` | string
+`unique` | boolean
+`max` | number
+`min` | number
+
+## Example
+
+```typescript
+import type { IndexOptionsRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "background": null,
+  "defaultLanguage": null,
+  "textVersion": null,
+  "expireAfter": null,
+  "unique": null,
+  "max": null,
+  "min": null,
+} satisfies IndexOptionsRequest
+
+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 IndexOptionsRequest
+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/InformationApi.md

@@ -0,0 +1,69 @@
+# InformationApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**version**](InformationApi.md#version) | **GET** /version | Version Information |
+
+
+
+## version
+
+> Version version()
+
+Version Information
+
+Version Info of the MongoCamp API
+
+### Example
+
+```ts
+import {
+  Configuration,
+  InformationApi,
+} from '';
+import type { VersionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new InformationApi();
+
+  try {
+    const data = await api.version();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Version**](Version.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+| **0** |  |  * x-error-code - Error Code <br>  * x-error-message - Message of the MongoCampException <br>  * x-error-additional-info - Additional information for the MongoCampException <br>  |
+
+[[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/InsertResponse.md

@@ -0,0 +1,36 @@
+
+# InsertResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`wasAcknowledged` | boolean
+`insertedIds` | Array<string>
+
+## Example
+
+```typescript
+import type { InsertResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "wasAcknowledged": null,
+  "insertedIds": null,
+} satisfies InsertResponse
+
+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 InsertResponse
+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/JobConfig.md

@@ -0,0 +1,44 @@
+
+# JobConfig
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`className` | string
+`description` | string
+`cronExpression` | string
+`group` | string
+`priority` | number
+
+## Example
+
+```typescript
+import type { JobConfig } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "className": null,
+  "description": null,
+  "cronExpression": null,
+  "group": null,
+  "priority": null,
+} satisfies JobConfig
+
+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 JobConfig
+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/JobInformation.md

@@ -0,0 +1,50 @@
+
+# JobInformation
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`group` | string
+`jobClassName` | string
+`description` | string
+`cronExpression` | string
+`priority` | number
+`lastScheduledFireTime` | Date
+`nextScheduledFireTime` | Date
+`scheduleInformation` | string
+
+## Example
+
+```typescript
+import type { JobInformation } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "group": null,
+  "jobClassName": null,
+  "description": null,
+  "cronExpression": null,
+  "priority": null,
+  "lastScheduledFireTime": null,
+  "nextScheduledFireTime": null,
+  "scheduleInformation": null,
+} satisfies JobInformation
+
+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 JobInformation
+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)
+
+