@sfxcode/nuxt-mongocamp-server 1.7.0 → 1.9.0

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

@@ -7,8 +7,10 @@ All URIs are relative to *http://localhost*
 | [**_delete**](DocumentApi.md#_delete) | **DELETE** /mongodb/collections/{collectionName}/documents/{documentId} | Delete Document from Collection |
 | [**countDocuments**](DocumentApi.md#countdocuments) | **GET** /mongodb/collections/{collectionName}/documents/count | Count Documents in Collection |
 | [**deleteMany**](DocumentApi.md#deletemany) | **DELETE** /mongodb/collections/{collectionName}/documents/many/delete | Delete Many in Collection |
+| [**exportDocuments**](DocumentApi.md#exportdocuments) | **GET** /mongodb/collections/{collectionName}/documents/export | Export Documents of a Collection |
 | [**find**](DocumentApi.md#find) | **POST** /mongodb/collections/{collectionName}/documents | Documents in Collection |
 | [**getDocument**](DocumentApi.md#getdocument) | **GET** /mongodb/collections/{collectionName}/documents/{documentId} | Document from Collection |
+| [**importDocuments**](DocumentApi.md#importdocuments) | **POST** /mongodb/collections/{collectionName}/documents/import | Import Documents into a Collection |
 | [**insert**](DocumentApi.md#insert) | **PUT** /mongodb/collections/{collectionName}/documents | Insert Document |
 | [**insertMany**](DocumentApi.md#insertmany) | **PUT** /mongodb/collections/{collectionName}/documents/many/insert | Insert many Documents |
 | [**listDocuments**](DocumentApi.md#listdocuments) | **GET** /mongodb/collections/{collectionName}/documents | Documents in Collection |
@@ -212,7 +214,7 @@ async function example() {
   const body = {
     // string | The name of your MongoDb Collection
     collectionName: collectionName_example,
-    // { [key: string]: any; }
+    // { [key: string]: any | null; }
     requestBody: Object,
     // boolean | Allow an empty filter, that matches all documents of the collection (optional)
     matchAll: true,
@@ -238,7 +240,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
-| **requestBody** | `{ [key: string]: any; }` |  | |
+| **requestBody** | `{ [key: string]: any | null; }` |  | |
 | **matchAll** | `boolean` | Allow an empty filter, that matches all documents of the collection | [Optional] [Defaults to `false`] |
 | **filter** | `string` | Filter Query like on the list of documents, as an alternative to the filter of the request body. Use only one of both. | [Optional] [Defaults to `undefined`] |
 
@@ -266,9 +268,105 @@ 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)
 
 
+## exportDocuments
+
+> string exportDocuments(collectionName, format, filter, sort, projection, limit, extendedJson)
+
+Export Documents of a Collection
+
+Download the documents of a Collection as a stream: ndjson (one JSON document per line), json (one array) or csv (a header line, nested values as JSON, a text with a comma, a quote or a line break in quotes). The documents are written while the database delivers them, the memory of the server does not depend on the size of the Collection. The columns of a csv export are the fields of `projection`, by default the fields of the first 1000 documents. With extendedJson the types of the values are explicit. A failure while the stream is running ends the stream, the status is 200 by then.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentApi,
+} from '';
+import type { ExportDocumentsRequest } 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 DocumentApi(config);
+
+  const body = {
+    // string | The name of your MongoDb Collection
+    collectionName: collectionName_example,
+    // string | ndjson (one JSON document per line), json (one array) or csv (optional)
+    format: format_example,
+    // string | Filter Query like on the list of documents, by default all documents are exported (optional)
+    filter: filter_example,
+    // Array<string> | Sorting like on the list of documents, a leading - sorts descending (optional)
+    sort: ...,
+    // Array<string> | The fields to export, for csv they are the columns in this order (optional)
+    projection: ...,
+    // number | The greatest number of documents, by default all (optional)
+    limit: 56,
+    // string | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\"$oid\": ...}, {\"$date\": ...}, {\"$numberDecimal\": ...}, canonical also {\"$numberInt\": ...}, {\"$numberLong\": ...} and {\"$numberDouble\": ...}). Without the parameter the documents are returned as before. (optional)
+    extendedJson: extendedJson_example,
+  } satisfies ExportDocumentsRequest;
+
+  try {
+    const data = await api.exportDocuments(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`] |
+| **format** | `string` | ndjson (one JSON document per line), json (one array) or csv | [Optional] [Defaults to `&#39;ndjson&#39;`] |
+| **filter** | `string` | Filter Query like on the list of documents, by default all documents are exported | [Optional] [Defaults to `undefined`] |
+| **sort** | `Array<string>` | Sorting like on the list of documents, a leading - sorts descending | [Optional] |
+| **projection** | `Array<string>` | The fields to export, for csv they are the columns in this order | [Optional] |
+| **limit** | `number` | The greatest number of documents, by default all | [Optional] [Defaults to `undefined`] |
+| **extendedJson** | `string` | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\&quot;$oid\&quot;: ...}, {\&quot;$date\&quot;: ...}, {\&quot;$numberDecimal\&quot;: ...}, canonical also {\&quot;$numberInt\&quot;: ...}, {\&quot;$numberLong\&quot;: ...} and {\&quot;$numberDouble\&quot;: ...}). Without the parameter the documents are returned as before. | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  * Content-Disposition -  <br>  |
+| **400** | Invalid value for: query parameter limit |  -  |
+| **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)
+
+
 ## find
 
-> Array&lt;{ [key: string]: any; }&gt; find(collectionName, mongoFindRequest, rowsPerPage, page)
+> Array&lt;{ [key: string]: any | null; }&gt; find(collectionName, mongoFindRequest, rowsPerPage, page, extendedJson)
 
 Documents in Collection
 
@@ -305,6 +403,8 @@ async function example() {
     rowsPerPage: 100,
     // number | Requested page of the ResultSets (optional)
     page: 1,
+    // string | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\"$oid\": ...}, {\"$date\": ...}, {\"$numberDecimal\": ...}, canonical also {\"$numberInt\": ...}, {\"$numberLong\": ...} and {\"$numberDouble\": ...}). Without the parameter the documents are returned as before. (optional)
+    extendedJson: extendedJson_example,
   } satisfies FindRequest;
 
   try {
@@ -328,10 +428,11 @@ example().catch(console.error);
 | **mongoFindRequest** | [MongoFindRequest](MongoFindRequest.md) |  | |
 | **rowsPerPage** | `number` | Count elements per page | [Optional] [Defaults to `undefined`] |
 | **page** | `number` | Requested page of the ResultSets | [Optional] [Defaults to `undefined`] |
+| **extendedJson** | `string` | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\&quot;$oid\&quot;: ...}, {\&quot;$date\&quot;: ...}, {\&quot;$numberDecimal\&quot;: ...}, canonical also {\&quot;$numberInt\&quot;: ...}, {\&quot;$numberLong\&quot;: ...} and {\&quot;$numberDouble\&quot;: ...}). Without the parameter the documents are returned as before. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-**Array<{ [key: string]: any; }>**
+**Array<{ [key: string]: any | null; }>**
 
 ### Authorization
 
@@ -355,7 +456,7 @@ example().catch(console.error);
 
 ## getDocument
 
-> { [key: string]: any; } getDocument(collectionName, documentId)
+> { [key: string]: any | null; } getDocument(collectionName, documentId, extendedJson)
 
 Document from Collection
 
@@ -388,6 +489,8 @@ async function example() {
     collectionName: collectionName_example,
     // string | DocumentId to read
     documentId: documentId_example,
+    // string | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\"$oid\": ...}, {\"$date\": ...}, {\"$numberDecimal\": ...}, canonical also {\"$numberInt\": ...}, {\"$numberLong\": ...} and {\"$numberDouble\": ...}). Without the parameter the documents are returned as before. (optional)
+    extendedJson: extendedJson_example,
   } satisfies GetDocumentRequest;
 
   try {
@@ -409,10 +512,11 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
 | **documentId** | `string` | DocumentId to read | [Defaults to `undefined`] |
+| **extendedJson** | `string` | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\&quot;$oid\&quot;: ...}, {\&quot;$date\&quot;: ...}, {\&quot;$numberDecimal\&quot;: ...}, canonical also {\&quot;$numberInt\&quot;: ...}, {\&quot;$numberLong\&quot;: ...} and {\&quot;$numberDouble\&quot;: ...}). Without the parameter the documents are returned as before. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-**{ [key: string]: any; }**
+**{ [key: string]: any | null; }**
 
 ### Authorization
 
@@ -433,6 +537,87 @@ 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)
 
 
+## importDocuments
+
+> ImportResponse importDocuments(collectionName, body)
+
+Import Documents into a Collection
+
+Store the documents of the request body: one JSON document per line (NDJSON, as written by the export). A line is read like a document in the body of an insert (Extended JSON wrappers, dates). The body is read as a stream and the documents are stored in batches without ordering, a line that cannot be stored does not stop the others: the answer counts what was read, stored and failed and names the first failed lines (&#x60;errors&#x60;, &#x60;index&#x60; is the number of the line). The size of the body is limited by IMPORT_MAX_BYTES (413 above), there is no time limit.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentApi,
+} from '';
+import type { ImportDocumentsRequest } 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 DocumentApi(config);
+
+  const body = {
+    // string | The name of your MongoDb Collection
+    collectionName: collectionName_example,
+    // string
+    body: body_example,
+  } satisfies ImportDocumentsRequest;
+
+  try {
+    const data = await api.importDocuments(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`] |
+| **body** | `string` |  | |
+
+### Return type
+
+[**ImportResponse**](ImportResponse.md)
+
+### Authorization
+
+[httpAuth1](../README.md#httpAuth1), [httpAuth](../README.md#httpAuth), [apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `text/plain`
+- **Accept**: `application/json`, `text/plain`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** |  |  -  |
+| **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)
+
+
 ## insert
 
 > InsertResponse insert(collectionName, requestBody)
@@ -466,8 +651,8 @@ async function example() {
   const body = {
     // string | The name of your MongoDb Collection
     collectionName: collectionName_example,
-    // { [key: string]: any; } | JSON Representation for your Document.
-    requestBody: {"key1":"value","key2":true,"key3":{"creationDate":"2026-11-06T06:04:09.291Z"}},
+    // { [key: string]: any | null; } | JSON Representation for your Document.
+    requestBody: {"key1":"value","key2":true,"key3":{"creationDate":"2026-11-12T19:00:42.728Z"}},
   } satisfies InsertRequest;
 
   try {
@@ -488,7 +673,7 @@ example().catch(console.error);
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
-| **requestBody** | `{ [key: string]: any; }` | JSON Representation for your Document. | |
+| **requestBody** | `{ [key: string]: any | null; }` | JSON Representation for your Document. | |
 
 ### Return type
 
@@ -549,7 +734,7 @@ async function example() {
     collectionName: collectionName_example,
     // boolean | true (default): the insert stops at the first document that fails (answer 409 for a duplicate key). false: all documents that can be stored are stored, the others are listed in `errors` of the answer. (optional)
     ordered: true,
-    // Array<{ [key: string]: any; }> (optional)
+    // Array<{ [key: string]: any | null; }> (optional)
     requestBody: ...,
   } satisfies InsertManyRequest;
 
@@ -572,7 +757,7 @@ example().catch(console.error);
 |------------- | ------------- | ------------- | -------------|
 | **collectionName** | `string` | The name of your MongoDb Collection | [Defaults to `undefined`] |
 | **ordered** | `boolean` | true (default): the insert stops at the first document that fails (answer 409 for a duplicate key). false: all documents that can be stored are stored, the others are listed in &#x60;errors&#x60; of the answer. | [Optional] [Defaults to `true`] |
-| **requestBody** | `Array<{ [key: string]: any; }>` |  | [Optional] |
+| **requestBody** | `Array<{ [key: string]: any | null; }>` |  | [Optional] |
 
 ### Return type
 
@@ -600,7 +785,7 @@ example().catch(console.error);
 
 ## listDocuments
 
-> Array&lt;{ [key: string]: any; }&gt; listDocuments(collectionName, filter, sort, projection, rowsPerPage, page)
+> Array&lt;{ [key: string]: any | null; }&gt; listDocuments(collectionName, filter, sort, projection, rowsPerPage, page, extendedJson)
 
 Documents in Collection
 
@@ -641,6 +826,8 @@ async function example() {
     rowsPerPage: 100,
     // number | Requested page of the ResultSets (optional)
     page: 1,
+    // string | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\"$oid\": ...}, {\"$date\": ...}, {\"$numberDecimal\": ...}, canonical also {\"$numberInt\": ...}, {\"$numberLong\": ...} and {\"$numberDouble\": ...}). Without the parameter the documents are returned as before. (optional)
+    extendedJson: extendedJson_example,
   } satisfies ListDocumentsRequest;
 
   try {
@@ -666,10 +853,11 @@ example().catch(console.error);
 | **projection** | `Array<string>` | MongoDB projection | [Optional] |
 | **rowsPerPage** | `number` | Count elements per page | [Optional] [Defaults to `undefined`] |
 | **page** | `number` | Requested page of the ResultSets | [Optional] [Defaults to `undefined`] |
+| **extendedJson** | `string` | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\&quot;$oid\&quot;: ...}, {\&quot;$date\&quot;: ...}, {\&quot;$numberDecimal\&quot;: ...}, canonical also {\&quot;$numberInt\&quot;: ...}, {\&quot;$numberLong\&quot;: ...} and {\&quot;$numberDouble\&quot;: ...}). Without the parameter the documents are returned as before. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-**Array<{ [key: string]: any; }>**
+**Array<{ [key: string]: any | null; }>**
 
 ### Authorization
 
@@ -693,7 +881,7 @@ example().catch(console.error);
 
 ## searchDocuments
 
-> Array&lt;{ [key: string]: any; }&gt; searchDocuments(collectionName, searchRequest, rowsPerPage, page)
+> Array&lt;{ [key: string]: any | null; }&gt; searchDocuments(collectionName, searchRequest, rowsPerPage, page, extendedJson)
 
 Search Documents in Collection
 
@@ -730,6 +918,8 @@ async function example() {
     rowsPerPage: 100,
     // number | Requested page of the ResultSets (optional)
     page: 1,
+    // string | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\"$oid\": ...}, {\"$date\": ...}, {\"$numberDecimal\": ...}, canonical also {\"$numberInt\": ...}, {\"$numberLong\": ...} and {\"$numberDouble\": ...}). Without the parameter the documents are returned as before. (optional)
+    extendedJson: extendedJson_example,
   } satisfies SearchDocumentsRequest;
 
   try {
@@ -753,10 +943,11 @@ example().catch(console.error);
 | **searchRequest** | [SearchRequest](SearchRequest.md) |  | |
 | **rowsPerPage** | `number` | Count elements per page | [Optional] [Defaults to `undefined`] |
 | **page** | `number` | Requested page of the ResultSets | [Optional] [Defaults to `undefined`] |
+| **extendedJson** | `string` | relaxed or canonical: the documents with the types of their values as MongoDB Extended JSON ({\&quot;$oid\&quot;: ...}, {\&quot;$date\&quot;: ...}, {\&quot;$numberDecimal\&quot;: ...}, canonical also {\&quot;$numberInt\&quot;: ...}, {\&quot;$numberLong\&quot;: ...} and {\&quot;$numberDouble\&quot;: ...}). Without the parameter the documents are returned as before. | [Optional] [Defaults to `undefined`] |
 
 ### Return type
 
-**Array<{ [key: string]: any; }>**
+**Array<{ [key: string]: any | null; }>**
 
 ### Authorization
 
@@ -813,7 +1004,7 @@ async function example() {
     collectionName: collectionName_example,
     // string | DocumentId to update
     documentId: documentId_example,
-    // { [key: string]: any; }
+    // { [key: string]: any | null; }
     requestBody: Object,
   } satisfies UpdateRequest;
 
@@ -836,7 +1027,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]: any; }` |  | |
+| **requestBody** | `{ [key: string]: any | null; }` |  | |
 
 ### Return type
 
@@ -897,7 +1088,7 @@ async function example() {
     collectionName: collectionName_example,
     // string | DocumentId to update
     documentId: documentId_example,
-    // { [key: string]: any; }
+    // { [key: string]: any | null; }
     requestBody: Object,
   } satisfies UpdateDocumentPartialRequest;
 
@@ -920,7 +1111,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]: any; }` |  | |
+| **requestBody** | `{ [key: string]: any | null; }` |  | |
 
 ### Return type
 

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

@@ -0,0 +1,36 @@
+
+# FieldInfo
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`path` | string
+`types` | [Array<FieldTypeCount>](FieldTypeCount.md)
+
+## Example
+
+```typescript
+import type { FieldInfo } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "path": null,
+  "types": null,
+} satisfies FieldInfo
+
+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 FieldInfo
+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/FieldTypeCount.md

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

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

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

@@ -0,0 +1,42 @@
+
+# ImportResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`read` | number
+`inserted` | number
+`failed` | number
+`errors` | [Array<InsertError>](InsertError.md)
+`errorsTruncated` | boolean
+
+## Example
+
+```typescript
+import type { ImportResponse } from ''
+
+// TODO: Update the object below with actual values
+const example = {
+  "read": null,
+  "inserted": null,
+  "failed": null,
+  "errors": null,
+  "errorsTruncated": null,
+} satisfies ImportResponse
+
+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 ImportResponse
+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/IndexApi.md

@@ -11,6 +11,7 @@ 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 |
 
@@ -605,6 +606,83 @@ 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)

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)