@sfxcode/nuxt-mongocamp-server 1.5.2 → 1.7.0

package/dist/runtime/api/apis/DocumentApi.js

@@ -1,8 +1,10 @@
 import * as runtime from "../runtime.js";
 import {
+  CountResponseFromJSON,
   DeleteResponseFromJSON,
   InsertResponseFromJSON,
   MongoFindRequestToJSON,
+  SearchRequestToJSON,
   UpdateRequestToJSON,
   UpdateResponseFromJSON
 } from "../models/index.js";
@@ -65,6 +67,60 @@ export class DocumentApi extends runtime.BaseAPI {
     const response = await this._deleteRaw(requestParameters, initOverrides);
     return await response.value();
   }
+  /**
+   * Creates request options for countDocuments without sending the request
+   */
+  async countDocumentsRequestOpts(requestParameters) {
+    if (requestParameters["collectionName"] == null) {
+      throw new runtime.RequiredError(
+        "collectionName",
+        'Required parameter "collectionName" was null or undefined when calling countDocuments().'
+      );
+    }
+    const queryParameters = {};
+    if (requestParameters["filter"] != null) {
+      queryParameters["filter"] = requestParameters["filter"];
+    }
+    const headerParameters = {};
+    if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
+      headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+    }
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token("httpAuth", []);
+      if (tokenString) {
+        headerParameters["Authorization"] = `Bearer ${tokenString}`;
+      }
+    }
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
+    }
+    let urlPath = `/mongodb/collections/{collectionName}/documents/count`;
+    urlPath = urlPath.replace(`{${"collectionName"}}`, encodeURIComponent(String(requestParameters["collectionName"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Count the Documents of the given Collection that match the filter without loading them
+   * Count Documents in Collection
+   */
+  async countDocumentsRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.countDocumentsRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => CountResponseFromJSON(jsonValue));
+  }
+  /**
+   * Count the Documents of the given Collection that match the filter without loading them
+   * Count Documents in Collection
+   */
+  async countDocuments(requestParameters, initOverrides) {
+    const response = await this.countDocumentsRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
   /**
    * Creates request options for deleteMany without sending the request
    */
@@ -82,6 +138,12 @@ export class DocumentApi extends runtime.BaseAPI {
       );
     }
     const queryParameters = {};
+    if (requestParameters["matchAll"] != null) {
+      queryParameters["matchAll"] = requestParameters["matchAll"];
+    }
+    if (requestParameters["filter"] != null) {
+      queryParameters["filter"] = requestParameters["filter"];
+    }
     const headerParameters = {};
     headerParameters["Content-Type"] = "application/json";
     if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
@@ -317,6 +379,9 @@ export class DocumentApi extends runtime.BaseAPI {
       );
     }
     const queryParameters = {};
+    if (requestParameters["ordered"] != null) {
+      queryParameters["ordered"] = requestParameters["ordered"];
+    }
     const headerParameters = {};
     headerParameters["Content-Type"] = "application/json";
     if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
@@ -425,6 +490,71 @@ export class DocumentApi extends runtime.BaseAPI {
     const response = await this.listDocumentsRaw(requestParameters, initOverrides);
     return await response.value();
   }
+  /**
+   * Creates request options for searchDocuments without sending the request
+   */
+  async searchDocumentsRequestOpts(requestParameters) {
+    if (requestParameters["collectionName"] == null) {
+      throw new runtime.RequiredError(
+        "collectionName",
+        'Required parameter "collectionName" was null or undefined when calling searchDocuments().'
+      );
+    }
+    if (requestParameters["searchRequest"] == null) {
+      throw new runtime.RequiredError(
+        "searchRequest",
+        'Required parameter "searchRequest" was null or undefined when calling searchDocuments().'
+      );
+    }
+    const queryParameters = {};
+    if (requestParameters["rowsPerPage"] != null) {
+      queryParameters["rowsPerPage"] = requestParameters["rowsPerPage"];
+    }
+    if (requestParameters["page"] != null) {
+      queryParameters["page"] = requestParameters["page"];
+    }
+    const headerParameters = {};
+    headerParameters["Content-Type"] = "application/json";
+    if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
+      headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+    }
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token("httpAuth", []);
+      if (tokenString) {
+        headerParameters["Authorization"] = `Bearer ${tokenString}`;
+      }
+    }
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
+    }
+    let urlPath = `/mongodb/collections/{collectionName}/documents/search`;
+    urlPath = urlPath.replace(`{${"collectionName"}}`, encodeURIComponent(String(requestParameters["collectionName"])));
+    return {
+      path: urlPath,
+      method: "POST",
+      headers: headerParameters,
+      query: queryParameters,
+      body: SearchRequestToJSON(requestParameters["searchRequest"])
+    };
+  }
+  /**
+   * The list of documents with the parameters in the request body: for filters that are too long for the URL (a URL of more than 2048 characters is refused by the server before the request is handled, without CORS headers). The filter is a Lucene query like in the list, the answer and the pagination headers are the same.
+   * Search Documents in Collection
+   */
+  async searchDocumentsRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.searchDocumentsRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response);
+  }
+  /**
+   * The list of documents with the parameters in the request body: for filters that are too long for the URL (a URL of more than 2048 characters is refused by the server before the request is handled, without CORS headers). The filter is a Lucene query like in the list, the answer and the pagination headers are the same.
+   * Search Documents in Collection
+   */
+  async searchDocuments(requestParameters, initOverrides) {
+    const response = await this.searchDocumentsRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
   /**
    * Creates request options for update without sending the request
    */
@@ -574,6 +704,12 @@ export class DocumentApi extends runtime.BaseAPI {
       );
     }
     const queryParameters = {};
+    if (requestParameters["matchAll"] != null) {
+      queryParameters["matchAll"] = requestParameters["matchAll"];
+    }
+    if (requestParameters["filter"] != null) {
+      queryParameters["filter"] = requestParameters["filter"];
+    }
     const headerParameters = {};
     headerParameters["Content-Type"] = "application/json";
     if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {

package/dist/runtime/api/apis/FileApi.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.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/apis/IndexApi.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.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { IndexCreateRequest, IndexCreateResponse, IndexDropResponse, IndexOptionsRequest, MongoIndex } from '../models/index.js';
+import type { IndexCreateRequest, IndexCreateResponse, IndexDropResponse, IndexOptionsRequest, IndexUsage, MongoIndex } from '../models/index.js';
 export interface CreateExpiringIndexRequest {
     collectionName: string;
     fieldName: string;
@@ -47,6 +47,9 @@ export interface IndexRequest {
     collectionName: string;
     indexName: string;
 }
+export interface IndexStatsRequest {
+    collectionName: string;
+}
 export interface ListIndicesRequest {
     collectionName: string;
 }
@@ -152,6 +155,20 @@ export declare class IndexApi extends runtime.BaseAPI {
      * Index for Collection
      */
     index(requestParameters: IndexRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MongoIndex>;
+    /**
+     * Creates request options for indexStats without sending the request
+     */
+    indexStatsRequestOpts(requestParameters: IndexStatsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * 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.
+     * Index usage for Collection
+     */
+    indexStatsRaw(requestParameters: IndexStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<IndexUsage>>>;
+    /**
+     * 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.
+     * Index usage for Collection
+     */
+    indexStats(requestParameters: IndexStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<IndexUsage>>;
     /**
      * Creates request options for listIndices without sending the request
      */

package/dist/runtime/api/apis/IndexApi.js

@@ -4,6 +4,7 @@ import {
   IndexCreateResponseFromJSON,
   IndexDropResponseFromJSON,
   IndexOptionsRequestToJSON,
+  IndexUsageFromJSON,
   MongoIndexFromJSON
 } from "../models/index.js";
 export class IndexApi extends runtime.BaseAPI {
@@ -440,6 +441,57 @@ export class IndexApi extends runtime.BaseAPI {
     const response = await this.indexRaw(requestParameters, initOverrides);
     return await response.value();
   }
+  /**
+   * Creates request options for indexStats without sending the request
+   */
+  async indexStatsRequestOpts(requestParameters) {
+    if (requestParameters["collectionName"] == null) {
+      throw new runtime.RequiredError(
+        "collectionName",
+        'Required parameter "collectionName" was null or undefined when calling indexStats().'
+      );
+    }
+    const queryParameters = {};
+    const headerParameters = {};
+    if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
+      headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+    }
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token("httpAuth", []);
+      if (tokenString) {
+        headerParameters["Authorization"] = `Bearer ${tokenString}`;
+      }
+    }
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
+    }
+    let urlPath = `/mongodb/collections/{collectionName}/index/stats`;
+    urlPath = urlPath.replace(`{${"collectionName"}}`, encodeURIComponent(String(requestParameters["collectionName"])));
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * 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.
+   * Index usage for Collection
+   */
+  async indexStatsRaw(requestParameters, initOverrides) {
+    const requestOptions = await this.indexStatsRequestOpts(requestParameters);
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(IndexUsageFromJSON));
+  }
+  /**
+   * 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.
+   * Index usage for Collection
+   */
+  async indexStats(requestParameters, initOverrides) {
+    const response = await this.indexStatsRaw(requestParameters, initOverrides);
+    return await response.value();
+  }
   /**
    * Creates request options for listIndices without sending the request
    */

package/dist/runtime/api/apis/JobsApi.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.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/dist/runtime/api/apis/{InformationApi.d.ts → SystemApi.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.7.1
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -10,11 +10,11 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime.js';
-import type { Version } from '../models/index.js';
+import type { ClusterInformation, Version } from '../models/index.js';
 /**
  *
  */
-export declare class InformationApi extends runtime.BaseAPI {
+export declare class SystemApi extends runtime.BaseAPI {
     /**
      * Creates request options for version without sending the request
      */
@@ -29,4 +29,18 @@ export declare class InformationApi extends runtime.BaseAPI {
      * Version Information
      */
     version(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Version>;
+    /**
+     * Creates request options for viewCluster without sending the request
+     */
+    viewClusterRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Returns the List of all registered Jobs with full information
+     * Registered Jobs
+     */
+    viewClusterRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ClusterInformation>>;
+    /**
+     * Returns the List of all registered Jobs with full information
+     * Registered Jobs
+     */
+    viewCluster(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ClusterInformation>;
 }

package/dist/runtime/api/apis/SystemApi.js

@@ -0,0 +1,82 @@
+import * as runtime from "../runtime.js";
+import {
+  ClusterInformationFromJSON,
+  VersionFromJSON
+} from "../models/index.js";
+export class SystemApi extends runtime.BaseAPI {
+  /**
+   * Creates request options for version without sending the request
+   */
+  async versionRequestOpts() {
+    const queryParameters = {};
+    const headerParameters = {};
+    let urlPath = `/version`;
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Version Info of the MongoCamp API
+   * Version Information
+   */
+  async versionRaw(initOverrides) {
+    const requestOptions = await this.versionRequestOpts();
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => VersionFromJSON(jsonValue));
+  }
+  /**
+   * Version Info of the MongoCamp API
+   * Version Information
+   */
+  async version(initOverrides) {
+    const response = await this.versionRaw(initOverrides);
+    return await response.value();
+  }
+  /**
+   * Creates request options for viewCluster without sending the request
+   */
+  async viewClusterRequestOpts() {
+    const queryParameters = {};
+    const headerParameters = {};
+    if (this.configuration && (this.configuration.username !== void 0 || this.configuration.password !== void 0)) {
+      headerParameters["Authorization"] = "Basic " + btoa(this.configuration.username + ":" + this.configuration.password);
+    }
+    if (this.configuration && this.configuration.accessToken) {
+      const token = this.configuration.accessToken;
+      const tokenString = await token("httpAuth", []);
+      if (tokenString) {
+        headerParameters["Authorization"] = `Bearer ${tokenString}`;
+      }
+    }
+    if (this.configuration && this.configuration.apiKey) {
+      headerParameters["X-AUTH-APIKEY"] = await this.configuration.apiKey("X-AUTH-APIKEY");
+    }
+    let urlPath = `/system/cluster`;
+    return {
+      path: urlPath,
+      method: "GET",
+      headers: headerParameters,
+      query: queryParameters
+    };
+  }
+  /**
+   * Returns the List of all registered Jobs with full information
+   * Registered Jobs
+   */
+  async viewClusterRaw(initOverrides) {
+    const requestOptions = await this.viewClusterRequestOpts();
+    const response = await this.request(requestOptions, initOverrides);
+    return new runtime.JSONApiResponse(response, (jsonValue) => ClusterInformationFromJSON(jsonValue));
+  }
+  /**
+   * Returns the List of all registered Jobs with full information
+   * Registered Jobs
+   */
+  async viewCluster(initOverrides) {
+    const response = await this.viewClusterRaw(initOverrides);
+    return await response.value();
+  }
+}

package/dist/runtime/api/apis/index.d.ts

@@ -7,5 +7,5 @@ export * from './DatabaseApi.js';
 export * from './DocumentApi.js';
 export * from './FileApi.js';
 export * from './IndexApi.js';
-export * from './InformationApi.js';
 export * from './JobsApi.js';
+export * from './SystemApi.js';

package/dist/runtime/api/apis/index.js

@@ -7,5 +7,5 @@ export * from "./DatabaseApi.js";
 export * from "./DocumentApi.js";
 export * from "./FileApi.js";
 export * from "./IndexApi.js";
-export * from "./InformationApi.js";
 export * from "./JobsApi.js";
+export * from "./SystemApi.js";

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

@@ -638,7 +638,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 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)
@@ -722,7 +722,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 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/AuthApi.md

@@ -11,6 +11,7 @@ All URIs are relative to *http://localhost*
 | [**logoutByDelete**](AuthApi.md#logoutbydelete) | **DELETE** /auth/logout | Logout User |
 | [**refreshToken**](AuthApi.md#refreshtoken) | **GET** /auth/token/refresh | Refresh User |
 | [**updatePassword**](AuthApi.md#updatepassword) | **PATCH** /auth/profile/password | Update Password |
+| [**userPermissions**](AuthApi.md#userpermissions) | **GET** /auth/permissions | Collection permissions |
 | [**userProfile**](AuthApi.md#userprofile) | **GET** /auth/profile | User Profile |
 
 
@@ -366,7 +367,7 @@ This endpoint does not need any parameter.
 
 Refresh User
 
-Refresh Token and return Login Information
+Refresh Token and return Login Information. A new token is issued on every call, the bearer token that was used for the call stays valid for a grace period (AUTH_REFRESH_GRACE_DURATION, default 60 seconds) and is invalid afterwards.
 
 ### Example
 
@@ -507,6 +508,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)
 
 
+## userPermissions
+
+> Array<CollectionPermission> userPermissions(collection)
+
+Collection permissions
+
+Return the resolved rights (read, write, administrate) of the loggedin user for the collections of the default database
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthApi,
+} from '';
+import type { UserPermissionsRequest } 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 AuthApi(config);
+
+  const body = {
+    // string | Resolve the rights for this collection only (also if the user has none) (optional)
+    collection: collection_example,
+  } satisfies UserPermissionsRequest;
+
+  try {
+    const data = await api.userPermissions(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **collection** | `string` | Resolve the rights for this collection only (also if the user has none) | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<CollectionPermission>**](CollectionPermission.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)
+
+
 ## userProfile
 
 > UserProfile userProfile()

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

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