tencentcloud-sdk-nodejs 4.0.913 → 4.0.915

package/tencentcloud/services/smh/v20210712/smh_client.js

@@ -27,6 +27,24 @@ class Client extends abstract_client_1.AbstractClient {
     constructor(clientConfig) {
         super("smh.tencentcloudapi.com", "2021-07-12", clientConfig);
     }
+    /**
+     * 更新用户信息。
+     */
+    async ModifyUser(req, cb) {
+        return this.request("ModifyUser", req, cb);
+    }
+    /**
+     * 一次删除多个用户。
+     */
+    async DeleteUser(req, cb) {
+        return this.request("DeleteUser", req, cb);
+    }
+    /**
+     * 验证短信验证码以换绑官方云盘实例的超级管理员账号
+     */
+    async VerifySmsCode(req, cb) {
+        return this.request("VerifySmsCode", req, cb);
+    }
     /**
      * 查询官方云盘实例
      */
@@ -46,10 +64,16 @@ class Client extends abstract_client_1.AbstractClient {
         return this.request("SendSmsCode", req, cb);
     }
     /**
-     * 验证短信验证码以换绑官方云盘实例的超级管理员账号
+     * 新建用户。
      */
-    async VerifySmsCode(req, cb) {
-        return this.request("VerifySmsCode", req, cb);
+    async CreateUser(req, cb) {
+        return this.request("CreateUser", req, cb);
+    }
+    /**
+     * 设置用户生命周期。如果指定的用户已经设置了生命周期，重复调用此接口将覆盖已有的设置。也可用于清除指定用户的生命周期。
+     */
+    async CreateUserLifecycle(req, cb) {
+        return this.request("CreateUserLifecycle", req, cb);
     }
     /**
      * 查询 PaaS 服务媒体库列表
@@ -81,6 +105,12 @@ class Client extends abstract_client_1.AbstractClient {
     async DeleteLibrary(req, cb) {
         return this.request("DeleteLibrary", req, cb);
     }
+    /**
+     * 查询用户生命周期。
+     */
+    async DescribeUserLifecycle(req, cb) {
+        return this.request("DescribeUserLifecycle", req, cb);
+    }
     /**
      * 查询 PaaS 服务媒体库密钥
      */

package/tencentcloud/services/smh/v20210712/smh_models.d.ts

@@ -1,3 +1,26 @@
+/**
+ * DescribeUserLifecycle返回参数结构体
+ */
+export interface DescribeUserLifecycleResponse {
+    /**
+     * 用户 ID。
+     */
+    UserId?: string;
+    /**
+     * 设置的隔离时间。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    IsolateTime?: string;
+    /**
+     * 设置的销毁时间。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DestroyTime?: string;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * ModifyLibrary返回参数结构体
  */
@@ -84,6 +107,19 @@ export interface Instance {
      */
     SuperAdminAccount: string;
 }
+/**
+ * DeleteUser请求参数结构体
+ */
+export interface DeleteUserRequest {
+    /**
+     * 媒体库 ID。
+     */
+    LibraryId: string;
+    /**
+     * 用于唯一查找用户的过滤器数组，数组之间为 **或** 的关系，即满足任意一个过滤器的用户，都将被删除，单次传入的过滤器最多为 100 个。
+     */
+    Filters: Array<UserFilter>;
+}
 /**
  * 流量资源包信息
  */
@@ -186,6 +222,80 @@ export interface DescribeTrafficPackagesResponse {
      */
     RequestId?: string;
 }
+/**
+ * CreateUser返回参数结构体
+ */
+export interface CreateUserResponse {
+    /**
+     * 用户所在的媒体库 ID。
+     */
+    LibraryId?: string;
+    /**
+     * 用户 ID。
+     */
+    UserId?: string;
+    /**
+     * 用户创建时间。
+     */
+    CreationTime?: string;
+    /**
+     * 用户角色.
+     */
+    Role?: string;
+    /**
+     * 是否启用。
+     */
+    Enabled?: boolean;
+    /**
+     * 手机号国家码，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    CountryCode?: string;
+    /**
+     * 手机号码，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    PhoneNumber?: string;
+    /**
+     * 邮箱，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Email?: string;
+    /**
+     * 账号，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AccountName?: string;
+    /**
+     * 第三方账号 ID，用于关联第三方账号体系，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AccountUserId?: string;
+    /**
+     * 备注。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Comment?: string;
+    /**
+     * 昵称。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Nickname?: string;
+    /**
+     * 用户头像地址。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Avatar?: string;
+    /**
+     * 自定义信息。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Customize?: string;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * DescribeLibrarySecret请求参数结构体
  */
@@ -234,41 +344,13 @@ export interface SendSmsCodeRequest {
     CountryCode?: string;
 }
 /**
- * DescribeOfficialInstances请求参数结构体
+ * DeleteUser返回参数结构体
  */
-export interface DescribeOfficialInstancesRequest {
-    /**
-     * 是否查询实例绑定的超级管理员账号，默认值为 false。
-     */
-    SuperAdminAccount?: boolean;
-    /**
-     * 按照一个或者多个实例 ID 查询，每次请求的上限为 100 个。
-     */
-    InstanceIds?: Array<string>;
-    /**
-     * 页码，整型，配合 PageSize 使用，默认值为 1。
-     */
-    PageNumber?: number;
-    /**
-     * 每页数目，整型，配合 PageNumber 使用，默认值为 20，最大值为 100。
-     */
-    PageSize?: number;
-    /**
-     * 对指定列进行排序
-     */
-    OrderBy?: string;
-    /**
-     * 排序方式
-     */
-    OrderByType?: string;
-    /**
-     * 续费管理筛选类型
-     */
-    AutoRenew?: number;
+export interface DeleteUserResponse {
     /**
-     * 超级管理管理员账号是否绑定了手机号
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
      */
-    BindPhone?: boolean;
+    RequestId?: string;
 }
 /**
  * DescribeLibraries请求参数结构体
@@ -379,6 +461,76 @@ export interface LibraryExtension {
      */
     RecognizeSensitiveContent?: boolean;
 }
+/**
+ * ModifyUser返回参数结构体
+ */
+export interface ModifyUserResponse {
+    /**
+     * 用户所在的媒体库 ID。
+     */
+    LibraryId?: string;
+    /**
+     * 用户 ID。
+     */
+    UserId?: string;
+    /**
+     * 用户创建时间。
+     */
+    CreationTime?: string;
+    /**
+     * 用户角色.
+     */
+    Role?: string;
+    /**
+     * 是否启用。
+     */
+    Enabled?: boolean;
+    /**
+     * 手机号国家码，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    CountryCode?: string;
+    /**
+     * 手机号码，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    PhoneNumber?: string;
+    /**
+     * 邮箱，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    Email?: string;
+    /**
+     * 账号，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AccountName?: string;
+    /**
+     * 第三方账号 ID，用于关联第三方账号体系，如未指定则为 null。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    AccountUserId?: string;
+    /**
+     * 备注。
+     */
+    Comment?: string;
+    /**
+     * 昵称。
+     */
+    Nickname?: string;
+    /**
+     * 用户头像地址。
+     */
+    Avatar?: string;
+    /**
+     * 自定义信息。
+     */
+    Customize?: string;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * VerifySmsCode返回参数结构体
  */
@@ -439,6 +591,19 @@ export interface DescribeOfficialInstancesResponse {
      */
     RequestId?: string;
 }
+/**
+ * DescribeUserLifecycle请求参数结构体
+ */
+export interface DescribeUserLifecycleRequest {
+    /**
+     * 媒体库 ID。
+     */
+    LibraryId: string;
+    /**
+     * 用于唯一查找用户的过滤器。
+     */
+    Filter: UserFilter;
+}
 /**
  * VerifySmsCode请求参数结构体
  */
@@ -464,6 +629,123 @@ export interface VerifySmsCodeRequest {
      */
     CountryCode?: string;
 }
+/**
+ * DescribeOfficialInstances请求参数结构体
+ */
+export interface DescribeOfficialInstancesRequest {
+    /**
+     * 是否查询实例绑定的超级管理员账号，默认值为 false。
+     */
+    SuperAdminAccount?: boolean;
+    /**
+     * 按照一个或者多个实例 ID 查询，每次请求的上限为 100 个。
+     */
+    InstanceIds?: Array<string>;
+    /**
+     * 页码，整型，配合 PageSize 使用，默认值为 1。
+     */
+    PageNumber?: number;
+    /**
+     * 每页数目，整型，配合 PageNumber 使用，默认值为 20，最大值为 100。
+     */
+    PageSize?: number;
+    /**
+     * 对指定列进行排序
+     */
+    OrderBy?: string;
+    /**
+     * 排序方式
+     */
+    OrderByType?: string;
+    /**
+     * 续费管理筛选类型
+     */
+    AutoRenew?: number;
+    /**
+     * 超级管理管理员账号是否绑定了手机号
+     */
+    BindPhone?: boolean;
+}
+/**
+ * CreateUser请求参数结构体
+ */
+export interface CreateUserRequest {
+    /**
+     * 媒体库 ID。
+     */
+    LibraryId: string;
+    /**
+     * 用户角色，当只支持 user。
+     */
+    Role: string;
+    /**
+     * 是否启用。
+     */
+    Enabled: boolean;
+    /**
+     * 手机号国家码，不传默认为 null，此时无法使用该登录方式进行登录。
+     */
+    CountryCode?: string;
+    /**
+     * 手机号码，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有手机号重复则报错。CountryCode 和 PhoneNumber 必须同时传入或同时不传入。
+     */
+    PhoneNumber?: string;
+    /**
+     * 邮箱，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有邮箱重复则报错。
+     */
+    Email?: string;
+    /**
+     * 账号，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有账号重复则报错。只能使用大小写字母、数字、中划线、下划线、小数点，长度不超过 50 个字符。
+     */
+    AccountName?: string;
+    /**
+     * 密码的 base64 形式，不传默认为 null，此时无法使用该登录方式进行登录。AccountName 和 AccountPassword 必须同时传入或同时不传入。
+     */
+    AccountPassword?: string;
+    /**
+     * 第三方账号 ID，用于关联第三方账号体系，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有第三方账号重复则报错。只能使用大小写字母、数字、中划线、下划线、小数点，长度不超过 200 个字符。
+     */
+    AccountUserId?: string;
+    /**
+     * 备注。不超过 255 个字符。
+     */
+    Comment?: string;
+    /**
+     * 昵称。不超过 100 个字符。
+     */
+    Nickname?: string;
+    /**
+     * 用户头像地址。不超过 255 个字符。
+     */
+    Avatar?: string;
+    /**
+     * 自定义信息。不超过 255 个字符。
+     */
+    Customize?: string;
+}
+/**
+ * CreateUserLifecycle返回参数结构体
+ */
+export interface CreateUserLifecycleResponse {
+    /**
+     * 用户 ID。
+     */
+    UserId?: string;
+    /**
+     * 设置的隔离时间。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    IsolateTime?: string;
+    /**
+     * 设置的销毁时间。
+  注意：此字段可能返回 null，表示取不到有效值。
+     */
+    DestroyTime?: string;
+    /**
+     * 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+     */
+    RequestId?: string;
+}
 /**
  * CreateLibrary返回参数结构体
  */
@@ -477,6 +759,24 @@ export interface CreateLibraryResponse {
      */
     RequestId?: string;
 }
+/**
+ * 用于唯一查找用户的过滤器。
+ */
+export interface UserFilter {
+    /**
+     * 过滤类型，当前支持：UserId、PhoneNumber、Email、AccountName、AccountUserId。
+     */
+    Key: string;
+    /**
+     * 过滤值，只支持完全匹配，不支持模糊搜索。针对不同的 Key，Value 的取值如下：
+  UserId: user12345678abcde
+  PhoneNumber: +86-13800000000（格式为：{CountryCode}-{PhoneNumber}）
+  Email: admin@mail.foobar.com
+  AccountName: account_name
+  AccountUserId: x53mYVqykfPqTCqekbNwwa4aXk4
+     */
+    Value: string;
+}
 /**
  * PaaS 服务媒体库信息
  */
@@ -522,6 +822,88 @@ export interface Library {
      */
     FileNum: string;
 }
+/**
+ * CreateUserLifecycle请求参数结构体
+ */
+export interface CreateUserLifecycleRequest {
+    /**
+     * 媒体库 ID。
+     */
+    LibraryId: string;
+    /**
+     * 用于唯一查找用户的过滤器。
+     */
+    Filter: UserFilter;
+    /**
+     * 隔离时间，当时间超过该时间点后，指定用户将无法登录，但他的账号信息、文件资源会被保留，可以通过再次调用本接口更新隔离时间，恢复登录。如不指定，则代表不设置隔离时间，且当前用户已经设置的隔离时间会被删除。
+     */
+    IsolateTime?: string;
+    /**
+     * 销毁时间，当时间超过该时间点后，指定用户的资源将被销毁且无法通过再次调用此接口更新时间。如果同时指定了 IsolateTime 则不能早于 IsolateTime 指定的时间。如不指定，则代表不设置销毁时间，且当前用户已经设置的销毁时间会被删除。
+     */
+    DestroyTime?: string;
+}
+/**
+ * ModifyUser请求参数结构体
+ */
+export interface ModifyUserRequest {
+    /**
+     * 媒体库 ID。
+     */
+    LibraryId: string;
+    /**
+     * 用于唯一查找用户的过滤器。
+     */
+    Filter: UserFilter;
+    /**
+     * 用户角色，当只支持 user。
+     */
+    Role?: string;
+    /**
+     * 是否启用。
+     */
+    Enabled?: boolean;
+    /**
+     * 手机号国家码，不传默认为 null，此时无法使用该登录方式进行登录。
+     */
+    CountryCode?: string;
+    /**
+     * 手机号码，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有手机号重复则报错。CountryCode 和 PhoneNumber 必须同时传入或同时不传入。
+     */
+    PhoneNumber?: string;
+    /**
+     * 邮箱，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有邮箱重复则报错。
+     */
+    Email?: string;
+    /**
+     * 账号，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有账号重复则报错。只能使用大小写字母、数字、中划线、下划线、小数点，长度不超过 50 个字符。
+     */
+    AccountName?: string;
+    /**
+     * 密码的 base64 形式，不传默认为 null，此时无法使用该登录方式进行登录。AccountName 和 AccountPassword 必须同时传入或同时不传入。
+     */
+    AccountPassword?: string;
+    /**
+     * 第三方账号 ID，用于关联第三方账号体系，不传默认为 null，此时无法使用该登录方式进行登录。如果与同一媒体库内已有第三方账号重复则报错。只能使用大小写字母、数字、中划线、下划线、小数点，长度不超过 200 个字符。
+     */
+    AccountUserId?: string;
+    /**
+     * 备注。不超过 255 个字符。
+     */
+    Comment?: string;
+    /**
+     * 昵称。不超过 100 个字符。
+     */
+    Nickname?: string;
+    /**
+     * 用户头像地址。不超过 255 个字符。
+     */
+    Avatar?: string;
+    /**
+     * 自定义信息。不超过 255 个字符。
+     */
+    Customize?: string;
+}
 /**
  * CreateLibrary请求参数结构体
  */