@sfxcode/nuxt-mongocamp-server 1.2.8 → 1.2.9

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

@@ -0,0 +1,58 @@
+
+# CollectionStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`ns` | string
+`collectionType` | string
+`scaleFactor` | number
+`size` | number
+`count` | number
+`storageSize` | number
+`avgObjSize` | number
+`nindexes` | number
+`indexSizes` | { [key: string]: number; }
+`totalIndexSize` | number
+`ok` | number
+`fetched` | Date
+`map` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { CollectionStatus } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "ns": null,
+  "collectionType": null,
+  "scaleFactor": null,
+  "size": null,
+  "count": null,
+  "storageSize": null,
+  "avgObjSize": null,
+  "nindexes": null,
+  "indexSizes": null,
+  "totalIndexSize": null,
+  "ok": null,
+  "fetched": null,
+  "map": null,
+} satisfies CollectionStatus
+
+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 CollectionStatus
+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/DatabaseApi.md

@@ -0,0 +1,382 @@
+# DatabaseApi
+
+All URIs are relative to *http://localhost*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**databaseInfos**](DatabaseApi.md#databaseinfos) | **GET** /mongodb/databases/infos | List of Database Infos |
+| [**deleteDatabase**](DatabaseApi.md#deletedatabase) | **DELETE** /mongodb/databases/{databaseName} | Delete Database |
+| [**getDatabaseInfo**](DatabaseApi.md#getdatabaseinfo) | **GET** /mongodb/databases/{databaseName} | Database Infos of selected Database |
+| [**listCollectionsByDatabase**](DatabaseApi.md#listcollectionsbydatabase) | **GET** /mongodb/databases/{databaseName}/collections | List of Collections |
+| [**listDatabases**](DatabaseApi.md#listdatabases) | **GET** /mongodb/databases | List of Databases |
+
+
+
+## databaseInfos
+
+> Array<DatabaseInfo> databaseInfos()
+
+List of Database Infos
+
+List of all Databases Infos
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatabaseApi,
+} from '';
+import type { DatabaseInfosRequest } 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 DatabaseApi(config);
+
+  try {
+    const data = await api.databaseInfos();
+    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
+
+[**Array<DatabaseInfo>**](DatabaseInfo.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)
+
+
+## deleteDatabase
+
+> JsonValueBoolean deleteDatabase(databaseName)
+
+Delete Database
+
+Delete given Database
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatabaseApi,
+} from '';
+import type { DeleteDatabaseRequest } 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 DatabaseApi(config);
+
+  const body = {
+    // string | Name of your Database
+    databaseName: databaseName_example,
+  } satisfies DeleteDatabaseRequest;
+
+  try {
+    const data = await api.deleteDatabase(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **databaseName** | `string` | Name of your Database | [Defaults to `undefined`] |
+
+### Return type
+
+[**JsonValueBoolean**](JsonValueBoolean.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)
+
+
+## getDatabaseInfo
+
+> DatabaseInfo getDatabaseInfo(databaseName)
+
+Database Infos of selected Database
+
+All Information about given Database
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatabaseApi,
+} from '';
+import type { GetDatabaseInfoRequest } 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 DatabaseApi(config);
+
+  const body = {
+    // string | Name of your Database
+    databaseName: databaseName_example,
+  } satisfies GetDatabaseInfoRequest;
+
+  try {
+    const data = await api.getDatabaseInfo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **databaseName** | `string` | Name of your Database | [Defaults to `undefined`] |
+
+### Return type
+
+[**DatabaseInfo**](DatabaseInfo.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)
+
+
+## listCollectionsByDatabase
+
+> Array&lt;string&gt; listCollectionsByDatabase(databaseName)
+
+List of Collections
+
+List of all Collections of the given database
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatabaseApi,
+} from '';
+import type { ListCollectionsByDatabaseRequest } 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 DatabaseApi(config);
+
+  const body = {
+    // string | Name of your Database
+    databaseName: databaseName_example,
+  } satisfies ListCollectionsByDatabaseRequest;
+
+  try {
+    const data = await api.listCollectionsByDatabase(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **databaseName** | `string` | Name of your Database | [Defaults to `undefined`] |
+
+### Return type
+
+**Array<string>**
+
+### 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)
+
+
+## listDatabases
+
+> Array&lt;string&gt; listDatabases()
+
+List of Databases
+
+List of all Databases
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DatabaseApi,
+} from '';
+import type { ListDatabasesRequest } 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 DatabaseApi(config);
+
+  try {
+    const data = await api.listDatabases();
+    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
+
+**Array<string>**
+
+### 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/DatabaseInfo.md

@@ -0,0 +1,42 @@
+
+# DatabaseInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`sizeOnDisk` | number
+`empty` | boolean
+`fetched` | Date
+`map` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { DatabaseInfo } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "sizeOnDisk": null,
+  "empty": null,
+  "fetched": null,
+  "map": null,
+} satisfies DatabaseInfo
+
+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 DatabaseInfo
+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/DeleteResponse.md

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