kb-cloud-client-typescript 2.3.0-alpha.124 → 2.3.0-alpha.125

package/src/adminapi/models/redis-key-mutate-request.ts

@@ -0,0 +1,54 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 RedisKeyMutateRequest
+ */
+export interface RedisKeyMutateRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyMutateRequest
+     */
+    'key': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeyMutateRequest
+     */
+    'expectedType'?: string;
+    /**
+     * Redis key mutation operation, such as set, hset, hdel, lset, lpush, rpush, sadd, srem, zadd, zrem, xadd, xtrim, json_set, json_del, expire, persist, rename, or delete
+     * @type {string}
+     * @memberof RedisKeyMutateRequest
+     */
+    'operation': string;
+    /**
+     * 
+     * @type {{ [key: string]: any; }}
+     * @memberof RedisKeyMutateRequest
+     */
+    'payload'?: { [key: string]: any; };
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RedisKeyMutateRequest
+     */
+    'confirm'?: boolean;
+}
+

package/src/adminapi/models/redis-key-mutate-response.ts

@@ -0,0 +1,51 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 { RedisKeySummary } from './redis-key-summary';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisKeyValue } from './redis-key-value';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisOperationSummary } from './redis-operation-summary';
+
+/**
+ * 
+ * @export
+ * @interface RedisKeyMutateResponse
+ */
+export interface RedisKeyMutateResponse {
+    /**
+     * 
+     * @type {RedisOperationSummary}
+     * @memberof RedisKeyMutateResponse
+     */
+    'operationSummary'?: RedisOperationSummary;
+    /**
+     * 
+     * @type {RedisKeySummary}
+     * @memberof RedisKeyMutateResponse
+     */
+    'metadata'?: RedisKeySummary;
+    /**
+     * 
+     * @type {RedisKeyValue}
+     * @memberof RedisKeyMutateResponse
+     */
+    'valuePreview'?: RedisKeyValue;
+}
+

package/src/adminapi/models/redis-key-summary-list.ts

@@ -0,0 +1,45 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 { RedisKeySummary } from './redis-key-summary';
+
+/**
+ * 
+ * @export
+ * @interface RedisKeySummaryList
+ */
+export interface RedisKeySummaryList {
+    /**
+     * 
+     * @type {Array<RedisKeySummary>}
+     * @memberof RedisKeySummaryList
+     */
+    'items'?: Array<RedisKeySummary>;
+    /**
+     * Cursor for the next SCAN page. Empty or \"0\" means the scan is complete.
+     * @type {string}
+     * @memberof RedisKeySummaryList
+     */
+    'nextCursor'?: string;
+    /**
+     * Whether another key page should be requested.
+     * @type {boolean}
+     * @memberof RedisKeySummaryList
+     */
+    'hasMore'?: boolean;
+}
+

package/src/adminapi/models/redis-key-summary.ts

@@ -0,0 +1,78 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 RedisKeySummary
+ */
+export interface RedisKeySummary {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeySummary
+     */
+    'key'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeySummary
+     */
+    'type'?: string;
+    /**
+     * key TTL in seconds; -1 means no expiration and -2 means missing key
+     * @type {number}
+     * @memberof RedisKeySummary
+     */
+    'ttl'?: number;
+    /**
+     * memory usage in bytes when available
+     * @type {number}
+     * @memberof RedisKeySummary
+     */
+    'memory'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeySummary
+     */
+    'length'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeySummary
+     */
+    'encoding'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisKeySummary
+     */
+    'slot'?: number;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisKeySummary
+     */
+    'nodeId'?: string;
+    /**
+     * datasource ACL access result for this key
+     * @type {string}
+     * @memberof RedisKeySummary
+     */
+    'aclAccess'?: string;
+}
+

package/src/adminapi/models/redis-key-value-item.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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.
+ */
+
+
+
+/**
+ * Stable Redis collection item shape. Fields are populated according to Redis value type.
+ * @export
+ * @interface RedisKeyValueItem
+ */
+export interface RedisKeyValueItem {
+    /**
+     * Hash field name.
+     * @type {string}
+     * @memberof RedisKeyValueItem
+     */
+    'field'?: string;
+    /**
+     * Hash/list/set/json item value.
+     * @type {{ [key: string]: any; }}
+     * @memberof RedisKeyValueItem
+     */
+    'value'?: { [key: string]: any; };
+    /**
+     * Set or sorted-set member.
+     * @type {string}
+     * @memberof RedisKeyValueItem
+     */
+    'member'?: string;
+    /**
+     * Sorted-set score.
+     * @type {number}
+     * @memberof RedisKeyValueItem
+     */
+    'score'?: number;
+    /**
+     * Stream entry ID.
+     * @type {string}
+     * @memberof RedisKeyValueItem
+     */
+    'id'?: string;
+    /**
+     * Stream entry field/value map.
+     * @type {{ [key: string]: string; }}
+     * @memberof RedisKeyValueItem
+     */
+    'fields'?: { [key: string]: string; };
+    /**
+     * List item index when available.
+     * @type {number}
+     * @memberof RedisKeyValueItem
+     */
+    'index'?: number;
+}
+

package/src/adminapi/models/redis-key-value.ts

@@ -0,0 +1,75 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 { RedisKeyValueItem } from './redis-key-value-item';
+
+/**
+ * Discriminated Redis key value payload for string, hash, list, set, zset, stream, and json editors.
+ * @export
+ * @interface RedisKeyValue
+ */
+export interface RedisKeyValue {
+    /**
+     * Redis value type, such as string, hash, list, set, zset, stream, or json.
+     * @type {string}
+     * @memberof RedisKeyValue
+     */
+    'type'?: string;
+    /**
+     * String or serialized scalar value for string/json previews.
+     * @type {string}
+     * @memberof RedisKeyValue
+     */
+    'text'?: string;
+    /**
+     * Paged collection items for hash, list, set, zset, stream, and json collection previews.
+     * @type {Array<RedisKeyValueItem>}
+     * @memberof RedisKeyValue
+     */
+    'items'?: Array<RedisKeyValueItem>;
+    /**
+     * Cursor for the next value page. Empty or \"0\" means the value page is complete.
+     * @type {string}
+     * @memberof RedisKeyValue
+     */
+    'cursor'?: string;
+    /**
+     * Offset used by offset-based value pagination.
+     * @type {number}
+     * @memberof RedisKeyValue
+     */
+    'offset'?: number;
+    /**
+     * Maximum number of value items returned.
+     * @type {number}
+     * @memberof RedisKeyValue
+     */
+    'limit'?: number;
+    /**
+     * Whether the returned value is truncated by size or item limit.
+     * @type {boolean}
+     * @memberof RedisKeyValue
+     */
+    'truncated'?: boolean;
+    /**
+     * JSON path used for the returned JSON value.
+     * @type {string}
+     * @memberof RedisKeyValue
+     */
+    'jsonPath'?: string;
+}
+

package/src/adminapi/models/redis-operation-guard.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 RedisOperationGuard
+ */
+export interface RedisOperationGuard {
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RedisOperationGuard
+     */
+    'aclAllowed'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RedisOperationGuard
+     */
+    'crossSlot'?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof RedisOperationGuard
+     */
+    'dangerous'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisOperationGuard
+     */
+    'reason'?: string;
+}
+

package/src/adminapi/models/redis-operation-status.ts

@@ -0,0 +1,32 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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
+ * @enum {string}
+ */
+
+export const RedisOperationStatus = {
+    success: 'success',
+    error: 'error',
+    blocked: 'blocked'
+} as const;
+
+export type RedisOperationStatus = typeof RedisOperationStatus[keyof typeof RedisOperationStatus];
+
+
+

package/src/adminapi/models/redis-operation-summary.ts

@@ -0,0 +1,62 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 { RedisOperationGuard } from './redis-operation-guard';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { RedisOperationStatus } from './redis-operation-status';
+
+/**
+ * 
+ * @export
+ * @interface RedisOperationSummary
+ */
+export interface RedisOperationSummary {
+    /**
+     * 
+     * @type {RedisOperationStatus}
+     * @memberof RedisOperationSummary
+     */
+    'status'?: RedisOperationStatus;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisOperationSummary
+     */
+    'message'?: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisOperationSummary
+     */
+    'affected'?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof RedisOperationSummary
+     */
+    'durationMs'?: number;
+    /**
+     * 
+     * @type {RedisOperationGuard}
+     * @memberof RedisOperationSummary
+     */
+    'guard'?: RedisOperationGuard;
+}
+
+
+

package/src/adminapi/models/redis-pub-sub-message-list.ts

@@ -0,0 +1,39 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 { RedisPubSubMessage } from './redis-pub-sub-message';
+
+/**
+ * 
+ * @export
+ * @interface RedisPubSubMessageList
+ */
+export interface RedisPubSubMessageList {
+    /**
+     * 
+     * @type {Array<RedisPubSubMessage>}
+     * @memberof RedisPubSubMessageList
+     */
+    'items'?: Array<RedisPubSubMessage>;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisPubSubMessageList
+     */
+    'nextCursor'?: string;
+}
+

package/src/adminapi/models/redis-pub-sub-message.ts

@@ -0,0 +1,48 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 RedisPubSubMessage
+ */
+export interface RedisPubSubMessage {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisPubSubMessage
+     */
+    'channel'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisPubSubMessage
+     */
+    'pattern'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisPubSubMessage
+     */
+    'message'?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisPubSubMessage
+     */
+    'receivedAt'?: string;
+}
+

package/src/adminapi/models/redis-pub-sub-publish-request.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 RedisPubSubPublishRequest
+ */
+export interface RedisPubSubPublishRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisPubSubPublishRequest
+     */
+    'channel': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof RedisPubSubPublishRequest
+     */
+    'message': string;
+}
+

package/src/adminapi/models/redis-pub-sub-session-create-request.ts

@@ -0,0 +1,36 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Admin API
+ * The Admin API is used to manage the ApeCloud platform. 
+ *
+ * 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 RedisPubSubSessionCreateRequest
+ */
+export interface RedisPubSubSessionCreateRequest {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RedisPubSubSessionCreateRequest
+     */
+    'channels'?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof RedisPubSubSessionCreateRequest
+     */
+    'patterns'?: Array<string>;
+}
+