kb-cloud-client-typescript 2.2.29 → 2.3.0-alpha.100

package/src/openapi/models/mongo-collection-stats.ts

@@ -0,0 +1,69 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MongoCollectionCapabilities } from './mongo-collection-capabilities';
+
+/**
+ * 
+ * @export
+ * @interface MongoCollectionStats
+ */
+export interface MongoCollectionStats {
+    /**
+     * collection name
+     * @type {string}
+     * @memberof MongoCollectionStats
+     */
+    'name'?: string;
+    /**
+     * collection type (collection or view)
+     * @type {string}
+     * @memberof MongoCollectionStats
+     */
+    'type'?: string;
+    /**
+     * whether this is a MongoDB system collection
+     * @type {boolean}
+     * @memberof MongoCollectionStats
+     */
+    'isSystem'?: boolean;
+    /**
+     * 
+     * @type {MongoCollectionCapabilities}
+     * @memberof MongoCollectionStats
+     */
+    'capabilities'?: MongoCollectionCapabilities;
+    /**
+     * 
+     * @type {number}
+     * @memberof MongoCollectionStats
+     */
+    'documentCount'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MongoCollectionStats
+     */
+    'totalSize'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MongoCollectionStats
+     */
+    'indexCount'?: number;
+}
+

package/src/openapi/models/mongo-create-collection-options.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoCreateCollectionOptions
+ */
+export interface MongoCreateCollectionOptions {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MongoCreateCollectionOptions
+     */
+    'capped'?: boolean;
+    /**
+     * capped collection size in bytes
+     * @type {number}
+     * @memberof MongoCreateCollectionOptions
+     */
+    'size'?: number;
+    /**
+     * capped collection max document count
+     * @type {number}
+     * @memberof MongoCreateCollectionOptions
+     */
+    'max'?: number;
+    /**
+     * collection validator document
+     * @type {object}
+     * @memberof MongoCreateCollectionOptions
+     */
+    'validator'?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof MongoCreateCollectionOptions
+     */
+    'validationLevel'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MongoCreateCollectionOptions
+     */
+    'validationAction'?: string;
+    /**
+     * default collection collation
+     * @type {object}
+     * @memberof MongoCreateCollectionOptions
+     */
+    'collation'?: object;
+}
+

package/src/openapi/models/mongo-create-collection-request.ts

@@ -0,0 +1,33 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MongoCreateCollectionOptions } from './mongo-create-collection-options';
+
+/**
+ * 
+ * @export
+ * @interface MongoCreateCollectionRequest
+ */
+export interface MongoCreateCollectionRequest {
+    /**
+     * 
+     * @type {MongoCreateCollectionOptions}
+     * @memberof MongoCreateCollectionRequest
+     */
+    'options'?: MongoCreateCollectionOptions;
+}
+

package/src/openapi/models/mongo-create-index-request.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { MongoIndexOptions } from './mongo-index-options';
+
+/**
+ * 
+ * @export
+ * @interface MongoCreateIndexRequest
+ */
+export interface MongoCreateIndexRequest {
+    /**
+     * index key pattern
+     * @type {object}
+     * @memberof MongoCreateIndexRequest
+     */
+    'keys'?: object;
+    /**
+     * 
+     * @type {MongoIndexOptions}
+     * @memberof MongoCreateIndexRequest
+     */
+    'options'?: MongoIndexOptions;
+}
+

package/src/openapi/models/mongo-create-view-request.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoCreateViewRequest
+ */
+export interface MongoCreateViewRequest {
+    /**
+     * view name
+     * @type {string}
+     * @memberof MongoCreateViewRequest
+     */
+    'name'?: string;
+    /**
+     * source collection name
+     * @type {string}
+     * @memberof MongoCreateViewRequest
+     */
+    'viewOn'?: string;
+    /**
+     * read-only aggregation pipeline backing the view
+     * @type {Array<object>}
+     * @memberof MongoCreateViewRequest
+     */
+    'pipeline'?: Array<object>;
+    /**
+     * optional view collation
+     * @type {object}
+     * @memberof MongoCreateViewRequest
+     */
+    'collation'?: object;
+}
+

package/src/openapi/models/mongo-database-info.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoDatabaseInfo
+ */
+export interface MongoDatabaseInfo {
+    /**
+     * database name
+     * @type {string}
+     * @memberof MongoDatabaseInfo
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof MongoDatabaseInfo
+     */
+    'sizeOnDisk'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MongoDatabaseInfo
+     */
+    'empty'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof MongoDatabaseInfo
+     */
+    'collectionCount'?: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MongoDatabaseInfo
+     */
+    'isSystem'?: boolean;
+}
+

package/src/openapi/models/mongo-delete-request.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoDeleteRequest
+ */
+export interface MongoDeleteRequest {
+    /**
+     * document selector
+     * @type {object}
+     * @memberof MongoDeleteRequest
+     */
+    'filter'?: object;
+    /**
+     * reserved for future bulk delete; S1 rejects true
+     * @type {boolean}
+     * @memberof MongoDeleteRequest
+     */
+    'many'?: boolean;
+}
+

package/src/openapi/models/mongo-explain-request.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoExplainRequest
+ */
+export interface MongoExplainRequest {
+    /**
+     * database name
+     * @type {string}
+     * @memberof MongoExplainRequest
+     */
+    'database'?: string;
+    /**
+     * collection name
+     * @type {string}
+     * @memberof MongoExplainRequest
+     */
+    'collection'?: string;
+    /**
+     * query filter to explain
+     * @type {object}
+     * @memberof MongoExplainRequest
+     */
+    'filter'?: object;
+    /**
+     * sort specification
+     * @type {object}
+     * @memberof MongoExplainRequest
+     */
+    'sort'?: object;
+    /**
+     * aggregation pipeline to explain
+     * @type {Array<object>}
+     * @memberof MongoExplainRequest
+     */
+    'pipeline'?: Array<object>;
+    /**
+     * MongoDB collation options
+     * @type {object}
+     * @memberof MongoExplainRequest
+     */
+    'collation'?: object;
+    /**
+     * maximum query execution time in milliseconds
+     * @type {number}
+     * @memberof MongoExplainRequest
+     */
+    'maxTimeMS'?: number;
+    /**
+     * explain verbosity level (queryPlanner, executionStats, or allPlansExecution)
+     * @type {string}
+     * @memberof MongoExplainRequest
+     */
+    'verbosity'?: string;
+}
+

package/src/openapi/models/mongo-explain-response.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoExplainResponse
+ */
+export interface MongoExplainResponse {
+    /**
+     * 
+     * @type {object}
+     * @memberof MongoExplainResponse
+     */
+    'queryPlanner'?: object;
+    /**
+     * 
+     * @type {object}
+     * @memberof MongoExplainResponse
+     */
+    'executionStats'?: object;
+}
+

package/src/openapi/models/mongo-find-request.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoFindRequest
+ */
+export interface MongoFindRequest {
+    /**
+     * MongoDB query filter
+     * @type {object}
+     * @memberof MongoFindRequest
+     */
+    'filter'?: object;
+    /**
+     * sort specification
+     * @type {object}
+     * @memberof MongoFindRequest
+     */
+    'sort'?: object;
+    /**
+     * field projection
+     * @type {object}
+     * @memberof MongoFindRequest
+     */
+    'projection'?: object;
+    /**
+     * MongoDB collation options
+     * @type {object}
+     * @memberof MongoFindRequest
+     */
+    'collation'?: object;
+    /**
+     * number of documents to skip
+     * @type {number}
+     * @memberof MongoFindRequest
+     */
+    'skip'?: number;
+    /**
+     * maximum number of documents to return
+     * @type {number}
+     * @memberof MongoFindRequest
+     */
+    'limit'?: number;
+    /**
+     * maximum query execution time in milliseconds
+     * @type {number}
+     * @memberof MongoFindRequest
+     */
+    'maxTimeMS'?: number;
+}
+

package/src/openapi/models/mongo-find-response.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoFindResponse
+ */
+export interface MongoFindResponse {
+    /**
+     * column names (flattened document key union)
+     * @type {Array<string>}
+     * @memberof MongoFindResponse
+     */
+    'columns'?: Array<string>;
+    /**
+     * row data (flattened document values)
+     * @type {Array<Array<any>>}
+     * @memberof MongoFindResponse
+     */
+    'rows'?: Array<Array<any>>;
+    /**
+     * raw documents (when raw mode)
+     * @type {Array<object>}
+     * @memberof MongoFindResponse
+     */
+    'documents'?: Array<object>;
+    /**
+     * total matching documents
+     * @type {number}
+     * @memberof MongoFindResponse
+     */
+    'totalCount'?: number;
+}
+

package/src/openapi/models/mongo-index-info.ts

@@ -0,0 +1,72 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoIndexInfo
+ */
+export interface MongoIndexInfo {
+    /**
+     * 
+     * @type {string}
+     * @memberof MongoIndexInfo
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {object}
+     * @memberof MongoIndexInfo
+     */
+    'key'?: object;
+    /**
+     * 
+     * @type {string}
+     * @memberof MongoIndexInfo
+     */
+    'type'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MongoIndexInfo
+     */
+    'unique'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MongoIndexInfo
+     */
+    'sparse'?: boolean;
+    /**
+     * 
+     * @type {number}
+     * @memberof MongoIndexInfo
+     */
+    'ttl'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof MongoIndexInfo
+     */
+    'size'?: number;
+    /**
+     * 
+     * @type {object}
+     * @memberof MongoIndexInfo
+     */
+    'usage'?: object;
+}
+

package/src/openapi/models/mongo-index-options.ts

@@ -0,0 +1,42 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * KubeBlocks Cloud API
+ * ***KubeBlocks Cloud API*** is a RESTful API for managing KubeBlocks Cloud resources.  The API is organized around REST.  Our API has predictable resource-oriented URLs, accepts `JSON-encoded` request bodies, returns `JSON-encoded` responses, and uses standard HTTP response codes, authentication, and verbs.  We use standard HTTP authentication and provide API keys to identify who you are. Your API keys carry many privileges, so be sure to keep them secret! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. 
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@apecloud.com
+ *
+ * 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 MongoIndexOptions
+ */
+export interface MongoIndexOptions {
+    /**
+     * 
+     * @type {string}
+     * @memberof MongoIndexOptions
+     */
+    'name'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MongoIndexOptions
+     */
+    'unique'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof MongoIndexOptions
+     */
+    'sparse'?: boolean;
+}
+