@sfxcode/nuxt-mongocamp-server 1.5.1 → 1.6.3

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

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

@@ -19,11 +19,11 @@ All URIs are relative to *http://localhost*
 
 ## aggregate
 
-> Array<{ [key: string]: string; }> aggregate(collectionName, mongoAggregateRequest, rowsPerPage, page)
+> Array<{ [key: string]: any; }> aggregate(collectionName, mongoAggregateRequest, rowsPerPage, page)
 
 Aggregate in Collection
 
-Aggregate in a given Collection
+Aggregate in a given Collection. The value of a stage is any JSON value. Operators that run JavaScript on the database server or write to collections (`$function`, `$accumulator`, `$where`, `$out`, `$merge`, `$currentOp`, `$listSessions` by default, configured with AGGREGATION_STAGES_DENIED) are refused with 403.
 
 ### Example
 
@@ -82,7 +82,7 @@ example().catch(console.error);
 
 ### Return type
 
-**Array<{ [key: string]: string; }>**
+**Array<{ [key: string]: any; }>**
 
 ### Authorization
 
@@ -260,7 +260,7 @@ example().catch(console.error);
 
 ## distinct
 
-> Array&lt;string&gt; distinct(collectionName, field, rowsPerPage, page)
+> Array&lt;any&gt; distinct(collectionName, field, rowsPerPage, page)
 
 Distinct in Collection
 
@@ -323,7 +323,7 @@ example().catch(console.error);
 
 ### Return type
 
-**Array<string>**
+**Array<any>**
 
 ### Authorization
 

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

@@ -18,7 +18,7 @@ Name | Type
 `totalIndexSize` | number
 `ok` | number
 `fetched` | Date
-`map` | { [key: string]: string; }
+`map` | { [key: string]: any; }
 
 ## Example
 

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

@@ -10,7 +10,7 @@ Name | Type
 `sizeOnDisk` | number
 `empty` | boolean
 `fetched` | Date
-`map` | { [key: string]: string; }
+`map` | { [key: string]: any; }
 
 ## Example
 

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

@@ -99,7 +99,7 @@ example().catch(console.error);
 
 ## deleteMany
 
-> DeleteResponse deleteMany(collectionName, requestBody)
+> DeleteResponse deleteMany(collectionName, requestBody, matchAll)
 
 Delete Many in Collection
 
@@ -130,8 +130,10 @@ async function example() {
   const body = {
     // string | The name of your MongoDb Collection
     collectionName: collectionName_example,
-    // { [key: string]: string; }
+    // { [key: string]: any; }
     requestBody: Object,
+    // boolean | Allow an empty filter, that matches all documents of the collection (optional)
+    matchAll: true,
   } satisfies DeleteManyRequest;
 
   try {
@@ -152,7 +154,8 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
-| **requestBody** | `{ [key: string]: string; }` |  | |
+| **requestBody** | `{ [key: string]: any; }` |  | |
+| **matchAll** | `boolean` | Allow an empty filter, that matches all documents of the collection | [Optional] [Defaults to `false`] |
 
 ### Return type
 
@@ -172,7 +175,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  -  |
-| **400** | Invalid value for: body |  -  |
+| **400** | Invalid value for: body, Invalid value for: query parameter matchAll |  -  |
 | **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)
@@ -180,7 +183,7 @@ example().catch(console.error);
 
 ## find
 
-> Array&lt;{ [key: string]: string; }&gt; find(collectionName, mongoFindRequest, rowsPerPage, page)
+> Array&lt;{ [key: string]: any; }&gt; find(collectionName, mongoFindRequest, rowsPerPage, page)
 
 Documents in Collection
 
@@ -243,7 +246,7 @@ example().catch(console.error);
 
 ### Return type
 
-**Array<{ [key: string]: string; }>**
+**Array<{ [key: string]: any; }>**
 
 ### Authorization
 
@@ -267,7 +270,7 @@ example().catch(console.error);
 
 ## getDocument
 
-> { [key: string]: string; } getDocument(collectionName, documentId)
+> { [key: string]: any; } getDocument(collectionName, documentId)
 
 Document from Collection
 
@@ -324,7 +327,7 @@ example().catch(console.error);
 
 ### Return type
 
-**{ [key: string]: string; }**
+**{ [key: string]: any; }**
 
 ### Authorization
 
@@ -378,8 +381,8 @@ async function example() {
   const body = {
     // string | The name of your MongoDb Collection
     collectionName: collectionName_example,
-    // { [key: string]: string; } | JSON Representation for your Document.
-    requestBody: {"key1":"value","key2":true,"key3":{"creationDate":"2024-10-11T16:43:24.553Z"}},
+    // { [key: string]: any; } | JSON Representation for your Document.
+    requestBody: {"key1":"value","key2":true,"key3":{"creationDate":"2026-11-02T05:03:40.430Z"}},
   } satisfies InsertRequest;
 
   try {
@@ -400,7 +403,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
-| **requestBody** | `{ [key: string]: string; }` | JSON Representation for your Document. | |
+| **requestBody** | `{ [key: string]: any; }` | JSON Representation for your Document. | |
 
 ### Return type
 
@@ -459,7 +462,7 @@ async function example() {
   const body = {
     // string | The name of your MongoDb Collection
     collectionName: collectionName_example,
-    // Array<{ [key: string]: string; }> (optional)
+    // Array<{ [key: string]: any; }> (optional)
     requestBody: ...,
   } satisfies InsertManyRequest;
 
@@ -481,7 +484,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
-| **requestBody** | `Array<{ [key: string]: string; }>` |  | [Optional] |
+| **requestBody** | `Array<{ [key: string]: any; }>` |  | [Optional] |
 
 ### Return type
 
@@ -509,7 +512,7 @@ example().catch(console.error);
 
 ## listDocuments
 
-> Array&lt;{ [key: string]: string; }&gt; listDocuments(collectionName, filter, sort, projection, rowsPerPage, page)
+> Array&lt;{ [key: string]: any; }&gt; listDocuments(collectionName, filter, sort, projection, rowsPerPage, page)
 
 Documents in Collection
 
@@ -578,7 +581,7 @@ example().catch(console.error);
 
 ### Return type
 
-**Array<{ [key: string]: string; }>**
+**Array<{ [key: string]: any; }>**
 
 ### Authorization
 
@@ -594,7 +597,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  * x-pagination-count-rows - count all elements <br>  * x-pagination-rows-per-page - Count elements per page <br>  * x-pagination-current-page - Current page <br>  * x-pagination-count-pages - Count pages <br>  |
-| **400** | Invalid value for: query parameter filter, Invalid value for: query parameter sort, Invalid value for: query parameter projection, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page |  -  |
+| **400** | Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page |  -  |
 | **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)
@@ -635,7 +638,7 @@ async function example() {
     collectionName: collectionName_example,
     // string | DocumentId to update
     documentId: documentId_example,
-    // { [key: string]: string; }
+    // { [key: string]: any; }
     requestBody: Object,
   } satisfies UpdateRequest;
 
@@ -658,7 +661,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
 | **documentId** | `string` | DocumentId to update | [Defaults to `undefined`] |
-| **requestBody** | `{ [key: string]: string; }` |  | |
+| **requestBody** | `{ [key: string]: any; }` |  | |
 
 ### Return type
 
@@ -719,7 +722,7 @@ async function example() {
     collectionName: collectionName_example,
     // string | DocumentId to update
     documentId: documentId_example,
-    // { [key: string]: string; }
+    // { [key: string]: any; }
     requestBody: Object,
   } satisfies UpdateDocumentPartialRequest;
 
@@ -742,7 +745,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
 | **documentId** | `string` | DocumentId to update | [Defaults to `undefined`] |
-| **requestBody** | `{ [key: string]: string; }` |  | |
+| **requestBody** | `{ [key: string]: any; }` |  | |
 
 ### Return type
 
@@ -770,7 +773,7 @@ example().catch(console.error);
 
 ## updateMany
 
-> UpdateResponse updateMany(collectionName, updateRequest)
+> UpdateResponse updateMany(collectionName, updateRequest, matchAll)
 
 Update many in Collection
 
@@ -803,6 +806,8 @@ async function example() {
     collectionName: collectionName_example,
     // UpdateRequest
     updateRequest: ...,
+    // boolean | Allow an empty filter, that matches all documents of the collection (optional)
+    matchAll: true,
   } satisfies UpdateManyRequest;
 
   try {
@@ -824,6 +829,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
 | **updateRequest** | [UpdateRequest](UpdateRequest.md) |  | |
+| **matchAll** | `boolean` | Allow an empty filter, that matches all documents of the collection | [Optional] [Defaults to `false`] |
 
 ### Return type
 
@@ -843,7 +849,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  -  |
-| **400** | Invalid value for: body |  -  |
+| **400** | Invalid value for: body, Invalid value for: query parameter matchAll |  -  |
 | **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/FileApi.md

@@ -422,7 +422,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  -  |
-| **400** | Invalid value for: body, Invalid value for: query parameter fileName |  -  |
+| **400** | Invalid value for: body |  -  |
 | **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)
@@ -515,7 +515,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  * x-pagination-count-rows - count all elements <br>  * x-pagination-rows-per-page - Count elements per page <br>  * x-pagination-current-page - Current page <br>  * x-pagination-count-pages - Count pages <br>  |
-| **400** | Invalid value for: query parameter filter, Invalid value for: query parameter sort, Invalid value for: query parameter projection, Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page |  -  |
+| **400** | Invalid value for: query parameter rowsPerPage, Invalid value for: query parameter page |  -  |
 | **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/FileInformation.md

@@ -11,7 +11,7 @@ Name | Type
 `length` | number
 `chunkSize` | number
 `uploadDate` | Date
-`metadata` | { [key: string]: string; }
+`metadata` | { [key: string]: any; }
 
 ## Example
 

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

@@ -99,7 +99,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  -  |
-| **400** | Invalid value for: query parameter sortAscending, Invalid value for: query parameter name |  -  |
+| **400** | Invalid value for: query parameter sortAscending |  -  |
 | **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)
@@ -438,7 +438,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** |  |  -  |
-| **400** | Invalid value for: query parameter sortAscending, Invalid value for: query parameter name |  -  |
+| **400** | Invalid value for: query parameter sortAscending |  -  |
 | **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/JsonSchemaDefinition.md

@@ -10,7 +10,7 @@ Name | Type
 `title` | string
 `additionalProperties` | boolean
 `required` | Array<string>
-`properties` | { [key: string]: { [key: string]: string; }; }
+`properties` | { [key: string]: { [key: string]: any; }; }
 
 ## Example
 

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

@@ -6,7 +6,7 @@
 
 Name | Type
 ------------ | -------------
-`value` | string
+`value` | any
 
 ## Example
 

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

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `key` | string
-`value` | string
+`value` | any
 `configType` | string
 `comment` | string
 `needsRestartForActivation` | boolean

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

@@ -6,9 +6,9 @@
 
 Name | Type
 ------------ | -------------
-`filter` | { [key: string]: string; }
-`sort` | { [key: string]: string; }
-`projection` | { [key: string]: string; }
+`filter` | { [key: string]: any; }
+`sort` | { [key: string]: any; }
+`projection` | { [key: string]: any; }
 
 ## Example
 

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

@@ -11,13 +11,13 @@ Name | Type
 `unique` | boolean
 `version` | number
 `namespace` | string
-`keys` | { [key: string]: string; }
-`weights` | { [key: string]: string; }
+`keys` | { [key: string]: any; }
+`weights` | { [key: string]: any; }
 `expire` | boolean
 `expireAfterSeconds` | number
 `text` | boolean
 `fetched` | Date
-`map` | { [key: string]: string; }
+`map` | { [key: string]: any; }
 
 ## Example
 

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

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `stage` | string
-`value` | string
+`value` | any
 
 ## Example
 

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

@@ -9,7 +9,7 @@ Name | Type
 `routesPlugins` | Array<string>
 `filePlugins` | Array<string>
 `ignoredPlugins` | Array<string>
-`configurations` | { [key: string]: string; }
+`configurations` | { [key: string]: any; }
 
 ## Example
 

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

@@ -0,0 +1,139 @@
+# SystemApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**version**](SystemApi.md#version) | **GET** /version | Version Information |
+| [**viewCluster**](SystemApi.md#viewcluster) | **GET** /system/cluster | Registered Jobs |
+
+
+
+## version
+
+> Version version()
+
+Version Information
+
+Version Info of the MongoCamp API
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '';
+import type { VersionRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const api = new SystemApi();
+
+  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)
+
+
+## viewCluster
+
+> ClusterInformation viewCluster()
+
+Registered Jobs
+
+Returns the List of all registered Jobs with full information
+
+### Example
+
+```ts
+import {
+  Configuration,
+  SystemApi,
+} from '';
+import type { ViewClusterRequest } from '';
+
+async function example() {
+  console.log("🚀 Testing  SDK...");
+  const config = new Configuration({ 
+    // To configure HTTP basic authorization: httpAuth1
+    username: "YOUR USERNAME",
+    password: "YOUR PASSWORD",
+    // Configure HTTP bearer authorization: httpAuth
+    accessToken: "YOUR BEARER TOKEN",
+    // To configure API key authorization: apiKeyAuth
+    apiKey: "YOUR API KEY",
+  });
+  const api = new SystemApi(config);
+
+  try {
+    const data = await api.viewCluster();
+    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
+
+[**ClusterInformation**](ClusterInformation.md)
+
+### Authorization
+
+[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
+
+### 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/UpdateFileInformationRequest.md

@@ -7,7 +7,7 @@
 Name | Type
 ------------ | -------------
 `filename` | string
-`metadata` | { [key: string]: string; }
+`metadata` | { [key: string]: any; }
 
 ## Example
 

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

@@ -6,8 +6,8 @@
 
 Name | Type
 ------------ | -------------
-`document` | { [key: string]: string; }
-`filter` | { [key: string]: string; }
+`document` | { [key: string]: any; }
+`filter` | { [key: string]: any; }
 
 ## Example
 

package/dist/runtime/api/models/BucketInformation.d.ts

@@ -2,7 +2,7 @@
  * mongocamp-library
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.5.10
+ * The version of the OpenAPI document: 1.6.3
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/models/ClusterInformation.d.ts

@@ -0,0 +1,39 @@
+/**
+ * mongocamp-library
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.6.3
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { ClusterMemberInformation } from './ClusterMemberInformation.js';
+/**
+ *
+ * @export
+ * @interface ClusterInformation
+ */
+export interface ClusterInformation {
+    /**
+     *
+     * @type {Array<ClusterMemberInformation>}
+     * @memberof ClusterInformation
+     */
+    members?: Array<ClusterMemberInformation>;
+    /**
+     *
+     * @type {ClusterMemberInformation}
+     * @memberof ClusterInformation
+     */
+    coordinator: ClusterMemberInformation;
+}
+/**
+ * Check if a given object implements the ClusterInformation interface.
+ */
+export declare function instanceOfClusterInformation(value: object): value is ClusterInformation;
+export declare function ClusterInformationFromJSON(json: any): ClusterInformation;
+export declare function ClusterInformationFromJSONTyped(json: any, ignoreDiscriminator: boolean): ClusterInformation;
+export declare function ClusterInformationToJSON(json: any): ClusterInformation;
+export declare function ClusterInformationToJSONTyped(value?: ClusterInformation | null, ignoreDiscriminator?: boolean): any;