kb-cloud-client-typescript 2.4.0-alpha.89 → 2.4.0-alpha.90

package/src/adminapi/models/index.ts

@@ -751,6 +751,23 @@ export * from './node-pool-node';
 export * from './node-resource-stats';
 export * from './node-resource-stats-list';
 export * from './node-status';
+export * from './object-privilege-capabilities';
+export * from './object-privilege-capability';
+export * from './object-privilege-change';
+export * from './object-privilege-definition';
+export * from './object-privilege-evidence';
+export * from './object-privilege-grant';
+export * from './object-privilege-grant-option-scope';
+export * from './object-privilege-object';
+export * from './object-privilege-object-list';
+export * from './object-privilege-prerequisite-check';
+export * from './object-privilege-prerequisite-status';
+export * from './object-privilege-qualifier';
+export * from './object-privilege-snapshot';
+export * from './object-privilege-spec';
+export * from './object-privilege-subject';
+export * from './object-privilege-subject-type';
+export * from './object-privilege-target';
 export * from './offline-instance';
 export * from './offline-instance-list';
 export * from './offset-reset-strategy';

package/src/adminapi/models/object-privilege-capabilities.ts

@@ -0,0 +1,57 @@
+/* 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 { ObjectPrivilegeCapability } from './object-privilege-capability';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeQualifier } from './object-privilege-qualifier';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeSubjectType } from './object-privilege-subject-type';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeCapabilities
+ */
+export interface ObjectPrivilegeCapabilities {
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeCapabilities
+     */
+    'engineVersion': string;
+    /**
+     * 
+     * @type {Array<ObjectPrivilegeCapability>}
+     * @memberof ObjectPrivilegeCapabilities
+     */
+    'objects': Array<ObjectPrivilegeCapability>;
+    /**
+     * Native subject kinds supported by this connected engine version.
+     * @type {Array<ObjectPrivilegeSubjectType>}
+     * @memberof ObjectPrivilegeCapabilities
+     */
+    'subjectTypes': Array<ObjectPrivilegeSubjectType>;
+    /**
+     * 
+     * @type {Array<ObjectPrivilegeQualifier>}
+     * @memberof ObjectPrivilegeCapabilities
+     */
+    'subjectQualifiers'?: Array<ObjectPrivilegeQualifier>;
+}
+

package/src/adminapi/models/object-privilege-capability.ts

@@ -0,0 +1,104 @@
+/* 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 { ObjectPrivilegeDefinition } from './object-privilege-definition';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeGrantOptionScope } from './object-privilege-grant-option-scope';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeCapability
+ */
+export interface ObjectPrivilegeCapability {
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'objectType': string;
+    /**
+     * 
+     * @type {Array<ObjectPrivilegeDefinition>}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'privileges': Array<ObjectPrivilegeDefinition>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'requiredTargetFields': Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'warnings'?: Array<string>;
+    /**
+     * Fields required to enumerate objects of this kind; distinct from fields needed to identify an individual target.
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'requiredDiscoveryFields': Array<string>;
+    /**
+     * 
+     * @type {ObjectPrivilegeGrantOptionScope}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'revokeGrantOptionScope'?: ObjectPrivilegeGrantOptionScope;
+    /**
+     * Versioned namespaced JSON extensions. Response keys unknown to a client may be ignored. Change keys must be registered and strictly decoded by the current engine; PG/MySQL currently accept no change extensions.
+     * @type {{ [key: string]: any; }}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'extensions'?: { [key: string]: any; };
+    /**
+     * Allows explicitly granting the documented access prerequisites together with an object grant.
+     * @type {boolean}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'supportsGrantPrerequisites'?: boolean;
+    /**
+     * When prerequisite grants are supported, whether they and the requested grant are atomic.
+     * @type {boolean}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'grantPrerequisitesAtomic'?: boolean;
+    /**
+     * Explicit revoke behaviors supported by this object kind. Omitted change behavior uses defaultRevokeBehavior.
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'revokeBehaviors': Array<string>;
+    /**
+     * Default native revoke behavior. PostgreSQL restrict; MySQL native.
+     * @type {string}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'defaultRevokeBehavior': string;
+    /**
+     * Versioned namespaces accepted for change extensions by this engine/version; empty means none.
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeCapability
+     */
+    'changeExtensions'?: Array<string>;
+}
+
+
+

package/src/adminapi/models/object-privilege-change.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.
+ */
+
+
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeSpec } from './object-privilege-spec';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeTarget } from './object-privilege-target';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeChange
+ */
+export interface ObjectPrivilegeChange {
+    /**
+     * 
+     * @type {ObjectPrivilegeTarget}
+     * @memberof ObjectPrivilegeChange
+     */
+    'target': ObjectPrivilegeTarget;
+    /**
+     * Operation, either grant or revoke.
+     * @type {string}
+     * @memberof ObjectPrivilegeChange
+     */
+    'action': string;
+    /**
+     * Required except when revoking MySQL scope-wide GRANT OPTION. Dynamic global privileges require explicit names.
+     * @type {Array<ObjectPrivilegeSpec>}
+     * @memberof ObjectPrivilegeChange
+     */
+    'privileges'?: Array<ObjectPrivilegeSpec>;
+    /**
+     * Grant delegation. MySQL static GRANT OPTION is scope-wide; dynamic global privileges each have their own grant option.
+     * @type {boolean}
+     * @memberof ObjectPrivilegeChange
+     */
+    'grantOption'?: boolean;
+    /**
+     * Revoke delegation only. PostgreSQL applies to listed privileges. MySQL requires an empty privileges list and revokes GRANT OPTION at the entire scope; global dynamic grant options can also be removed.
+     * @type {boolean}
+     * @memberof ObjectPrivilegeChange
+     */
+    'grantOptionOnly'?: boolean;
+    /**
+     * Versioned namespaced JSON extensions. Response keys unknown to a client may be ignored. Change keys must be registered and strictly decoded by the current engine; PG/MySQL currently accept no change extensions.
+     * @type {{ [key: string]: any; }}
+     * @memberof ObjectPrivilegeChange
+     */
+    'extensions'?: { [key: string]: any; };
+    /**
+     * Explicitly grant advertised access prerequisites. PG schema-contained grants add CONNECT and schema USAGE in the same transaction; never sequence privileges. Defaults false; later revoke does not undo prerequisites.
+     * @type {boolean}
+     * @memberof ObjectPrivilegeChange
+     */
+    'grantPrerequisites'?: boolean;
+    /**
+     * Explicit native revoke behavior from capabilities; valid only for revoke. Omitted uses the advertised default.
+     * @type {string}
+     * @memberof ObjectPrivilegeChange
+     */
+    'revokeBehavior'?: string;
+}
+

package/src/adminapi/models/object-privilege-definition.ts

@@ -0,0 +1,47 @@
+/* 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 { ObjectPrivilegeGrantOptionScope } from './object-privilege-grant-option-scope';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeDefinition
+ */
+export interface ObjectPrivilegeDefinition {
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeDefinition
+     */
+    'name': string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ObjectPrivilegeDefinition
+     */
+    'supportsColumns'?: boolean;
+    /**
+     * 
+     * @type {ObjectPrivilegeGrantOptionScope}
+     * @memberof ObjectPrivilegeDefinition
+     */
+    'grantOptionScope': ObjectPrivilegeGrantOptionScope;
+}
+
+
+

package/src/adminapi/models/object-privilege-evidence.ts

@@ -0,0 +1,42 @@
+/* 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 ObjectPrivilegeEvidence
+ */
+export interface ObjectPrivilegeEvidence {
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeEvidence
+     */
+    'kind': string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeEvidence
+     */
+    'format': string;
+    /**
+     * Read-only native evidence; never replay as a privilege mutation.
+     * @type {Array<string>}
+     * @memberof ObjectPrivilegeEvidence
+     */
+    'items': Array<string>;
+}
+

package/src/adminapi/models/object-privilege-grant-option-scope.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 ObjectPrivilegeGrantOptionScope = {
+    none: 'none',
+    privilege: 'privilege',
+    object: 'object'
+} as const;
+
+export type ObjectPrivilegeGrantOptionScope = typeof ObjectPrivilegeGrantOptionScope[keyof typeof ObjectPrivilegeGrantOptionScope];
+
+
+

package/src/adminapi/models/object-privilege-grant.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 ObjectPrivilegeGrant
+ */
+export interface ObjectPrivilegeGrant {
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeGrant
+     */
+    'name': string;
+    /**
+     * Empty means an object-level privilege.
+     * @type {string}
+     * @memberof ObjectPrivilegeGrant
+     */
+    'column'?: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ObjectPrivilegeGrant
+     */
+    'grantable': boolean;
+    /**
+     * PostgreSQL ACL grantor. Omitted for MySQL and effective privilege results.
+     * @type {string}
+     * @memberof ObjectPrivilegeGrant
+     */
+    'grantor'?: string;
+}
+

package/src/adminapi/models/object-privilege-object-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 { ObjectPrivilegeObject } from './object-privilege-object';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeObjectList
+ */
+export interface ObjectPrivilegeObjectList {
+    /**
+     * 
+     * @type {Array<ObjectPrivilegeObject>}
+     * @memberof ObjectPrivilegeObjectList
+     */
+    'items': Array<ObjectPrivilegeObject>;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ObjectPrivilegeObjectList
+     */
+    'hasMore': boolean;
+    /**
+     * Offset for the next page; omitted when exhausted.
+     * @type {number}
+     * @memberof ObjectPrivilegeObjectList
+     */
+    'nextOffset'?: number;
+}
+

package/src/adminapi/models/object-privilege-object.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 { ObjectPrivilegeTarget } from './object-privilege-target';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegeObject
+ */
+export interface ObjectPrivilegeObject {
+    /**
+     * 
+     * @type {ObjectPrivilegeTarget}
+     * @memberof ObjectPrivilegeObject
+     */
+    'target': ObjectPrivilegeTarget;
+    /**
+     * Display identity, including PostgreSQL routine input argument types. Use target for operations; identity is never accepted as SQL.
+     * @type {string}
+     * @memberof ObjectPrivilegeObject
+     */
+    'identity': string;
+}
+

package/src/adminapi/models/object-privilege-prerequisite-check.ts

@@ -0,0 +1,56 @@
+/* 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 { ObjectPrivilegePrerequisiteStatus } from './object-privilege-prerequisite-status';
+// May contain unused imports in some cases
+// @ts-ignore
+import type { ObjectPrivilegeTarget } from './object-privilege-target';
+
+/**
+ * 
+ * @export
+ * @interface ObjectPrivilegePrerequisiteCheck
+ */
+export interface ObjectPrivilegePrerequisiteCheck {
+    /**
+     * 
+     * @type {ObjectPrivilegeTarget}
+     * @memberof ObjectPrivilegePrerequisiteCheck
+     */
+    'target': ObjectPrivilegeTarget;
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegePrerequisiteCheck
+     */
+    'privilege': string;
+    /**
+     * 
+     * @type {ObjectPrivilegePrerequisiteStatus}
+     * @memberof ObjectPrivilegePrerequisiteCheck
+     */
+    'status': ObjectPrivilegePrerequisiteStatus;
+    /**
+     * Optional explanation. Checks are not a complete proof of executable access. Missing checks do not imply granted.
+     * @type {string}
+     * @memberof ObjectPrivilegePrerequisiteCheck
+     */
+    'reason'?: string;
+}
+
+
+

package/src/adminapi/models/object-privilege-prerequisite-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 ObjectPrivilegePrerequisiteStatus = {
+    granted: 'granted',
+    denied: 'denied',
+    unknown: 'unknown'
+} as const;
+
+export type ObjectPrivilegePrerequisiteStatus = typeof ObjectPrivilegePrerequisiteStatus[keyof typeof ObjectPrivilegePrerequisiteStatus];
+
+
+

package/src/adminapi/models/object-privilege-qualifier.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 ObjectPrivilegeQualifier
+ */
+export interface ObjectPrivilegeQualifier {
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeQualifier
+     */
+    'name': string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ObjectPrivilegeQualifier
+     */
+    'required'?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeQualifier
+     */
+    'defaultValue'?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ObjectPrivilegeQualifier
+     */
+    'description'?: string;
+}
+