@sfxcode/nuxt-mongocamp-server 1.6.3 → 1.8.0

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

@@ -11,6 +11,8 @@ All URIs are relative to *http://localhost*
 | [**createUniqueIndex**](IndexApi.md#createuniqueindex) | **PUT** /mongodb/collections/{collectionName}/index/field/{fieldName}/unique | Create Unique Index |
 | [**deleteIndex**](IndexApi.md#deleteindex) | **DELETE** /mongodb/collections/{collectionName}/index/{indexName} | Delete Index |
 | [**index**](IndexApi.md#index) | **GET** /mongodb/collections/{collectionName}/index/{indexName} | Index for Collection |
+| [**indexDetails**](IndexApi.md#indexdetails) | **GET** /mongodb/collections/{collectionName}/index/details | Indices with details for Collection |
+| [**indexStats**](IndexApi.md#indexstats) | **GET** /mongodb/collections/{collectionName}/index/stats | Index usage for Collection |
 | [**listIndices**](IndexApi.md#listindices) | **GET** /mongodb/collections/{collectionName}/index | List Indices for Collection |
 
 
@@ -604,6 +606,160 @@ example().catch(console.error);
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
+## indexDetails
+
+> Array<IndexInfo> indexDetails(collectionName)
+
+Indices with details for Collection
+
+All Indices of the given Collection as the database reports them: the keys in the order of the index (`direction` is 1, -1 or the type of the key, a text index lists its fields), unique, sparse, hidden, partial filter, collation, weights, default language and expiration.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IndexApi,
+} from '';
+import type { IndexDetailsRequest } 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 IndexApi(config);
+
+  const body = {
+    // string | The name of your MongoDb Collection
+    collectionName: collectionName_example,
+  } satisfies IndexDetailsRequest;
+
+  try {
+    const data = await api.indexDetails(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<IndexInfo>**](IndexInfo.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)
+
+
+## indexStats
+
+> Array&lt;IndexUsage&gt; indexStats(collectionName)
+
+Index usage for Collection
+
+How often every Index of the given Collection was used since the counting started. Replaces the aggregation stage $indexStats, which is denied by default because its result contains the address of the database server.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  IndexApi,
+} from '';
+import type { IndexStatsRequest } 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 IndexApi(config);
+
+  const body = {
+    // string | The name of your MongoDb Collection
+    collectionName: collectionName_example,
+  } satisfies IndexStatsRequest;
+
+  try {
+    const data = await api.indexStats(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array&lt;IndexUsage&gt;**](IndexUsage.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)
+
+
 ## listIndices
 
 > Array&lt;MongoIndex&gt; listIndices(collectionName)

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

@@ -8,6 +8,7 @@ Name | Type
 ------------ | -------------
 `keys` | { [key: string]: number; }
 `indexOptionsRequest` | [IndexOptionsRequest](IndexOptionsRequest.md)
+`orderedKeys` | [Array<IndexKey>](IndexKey.md)
 
 ## Example
 
@@ -18,6 +19,7 @@ import type { IndexCreateRequest } from ''
 const example = {
   "keys": null,
   "indexOptionsRequest": null,
+  "orderedKeys": null,
 } satisfies IndexCreateRequest
 
 console.log(example)

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

@@ -0,0 +1,54 @@
+
+# IndexInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`keys` | [Array<IndexKey>](IndexKey.md)
+`unique` | boolean
+`sparse` | boolean
+`hidden` | boolean
+`partialFilterExpression` | { [key: string]: any; }
+`collation` | { [key: string]: any; }
+`weights` | { [key: string]: any; }
+`defaultLanguage` | string
+`expireAfterSeconds` | number
+`version` | number
+
+## Example
+
+```typescript
+import type { IndexInfo } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "keys": null,
+  "unique": null,
+  "sparse": null,
+  "hidden": null,
+  "partialFilterExpression": null,
+  "collation": null,
+  "weights": null,
+  "defaultLanguage": null,
+  "expireAfterSeconds": null,
+  "version": null,
+} satisfies IndexInfo
+
+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 IndexInfo
+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/IndexKey.md

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

@@ -14,6 +14,11 @@ Name | Type
 `unique` | boolean
 `max` | number
 `min` | number
+`sparse` | boolean
+`hidden` | boolean
+`partialFilterExpression` | { [key: string]: any; }
+`weights` | { [key: string]: number; }
+`collation` | { [key: string]: any; }
 
 ## Example
 
@@ -30,6 +35,11 @@ const example = {
   "unique": null,
   "max": null,
   "min": null,
+  "sparse": null,
+  "hidden": null,
+  "partialFilterExpression": null,
+  "weights": null,
+  "collation": null,
 } satisfies IndexOptionsRequest
 
 console.log(example)

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

@@ -0,0 +1,40 @@
+
+# IndexUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`key` | { [key: string]: any; }
+`ops` | number
+`since` | Date
+
+## Example
+
+```typescript
+import type { IndexUsage } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "key": null,
+  "ops": null,
+  "since": null,
+} satisfies IndexUsage
+
+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 IndexUsage
+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/InsertError.md

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

@@ -8,6 +8,8 @@ Name | Type
 ------------ | -------------
 `wasAcknowledged` | boolean
 `insertedIds` | Array<string>
+`insertedCount` | number
+`errors` | [Array<InsertError>](InsertError.md)
 
 ## Example
 
@@ -18,6 +20,8 @@ import type { InsertResponse } from ''
 const example = {
   "wasAcknowledged": null,
   "insertedIds": null,
+  "insertedCount": null,
+  "errors": null,
 } satisfies InsertResponse
 
 console.log(example)

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

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

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

@@ -0,0 +1,38 @@
+
+# SearchRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`filter` | string
+`sort` | Array<string>
+`projection` | Array<string>
+
+## Example
+
+```typescript
+import type { SearchRequest } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "filter": null,
+  "sort": null,
+  "projection": null,
+} satisfies SearchRequest
+
+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 SearchRequest
+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/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.6.3
+ * The version of the OpenAPI document: 1.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/models/ClusterInformation.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.6.3
+ * The version of the OpenAPI document: 1.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/models/ClusterMemberInformation.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.6.3
+ * The version of the OpenAPI document: 1.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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

@@ -0,0 +1,50 @@
+/**
+ * mongocamp-library
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1.8.1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface CollectionPermission
+ */
+export interface CollectionPermission {
+    /**
+     *
+     * @type {string}
+     * @memberof CollectionPermission
+     */
+    name: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionPermission
+     */
+    read: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionPermission
+     */
+    write: boolean;
+    /**
+     *
+     * @type {boolean}
+     * @memberof CollectionPermission
+     */
+    administrate: boolean;
+}
+/**
+ * Check if a given object implements the CollectionPermission interface.
+ */
+export declare function instanceOfCollectionPermission(value: object): value is CollectionPermission;
+export declare function CollectionPermissionFromJSON(json: any): CollectionPermission;
+export declare function CollectionPermissionFromJSONTyped(json: any, ignoreDiscriminator: boolean): CollectionPermission;
+export declare function CollectionPermissionToJSON(json: any): CollectionPermission;
+export declare function CollectionPermissionToJSONTyped(value?: CollectionPermission | null, ignoreDiscriminator?: boolean): any;

package/dist/runtime/api/models/CollectionPermission.js

@@ -0,0 +1,35 @@
+export function instanceOfCollectionPermission(value) {
+  if (!("name" in value) || value["name"] === void 0) return false;
+  if (!("read" in value) || value["read"] === void 0) return false;
+  if (!("write" in value) || value["write"] === void 0) return false;
+  if (!("administrate" in value) || value["administrate"] === void 0) return false;
+  return true;
+}
+export function CollectionPermissionFromJSON(json) {
+  return CollectionPermissionFromJSONTyped(json, false);
+}
+export function CollectionPermissionFromJSONTyped(json, ignoreDiscriminator) {
+  if (json == null) {
+    return json;
+  }
+  return {
+    "name": json["name"],
+    "read": json["read"],
+    "write": json["write"],
+    "administrate": json["administrate"]
+  };
+}
+export function CollectionPermissionToJSON(json) {
+  return CollectionPermissionToJSONTyped(json, false);
+}
+export function CollectionPermissionToJSONTyped(value, ignoreDiscriminator = false) {
+  if (value == null) {
+    return value;
+  }
+  return {
+    "name": value["name"],
+    "read": value["read"],
+    "write": value["write"],
+    "administrate": value["administrate"]
+  };
+}

package/dist/runtime/api/models/CollectionStatus.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.6.3
+ * The version of the OpenAPI document: 1.8.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).