tencentcloud-sdk-nodejs 4.0.691 → 4.0.692

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (70) hide show
  1. package/CHANGELOG.md +218 -0
  2. package/SERVICE_CHANGELOG.md +288 -230
  3. package/package.json +1 -1
  4. package/products.md +19 -19
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cbs/v20170312/cbs_models.ts +5 -4
  7. package/src/services/cdn/v20180606/cdn_client.ts +21 -14
  8. package/src/services/cdn/v20180606/cdn_models.ts +19 -19
  9. package/src/services/clb/v20180317/clb_client.ts +61 -11
  10. package/src/services/clb/v20180317/clb_models.ts +235 -40
  11. package/src/services/cvm/v20170312/cvm_models.ts +2 -2
  12. package/src/services/cwp/v20180228/cwp_client.ts +52 -2
  13. package/src/services/cwp/v20180228/cwp_models.ts +343 -46
  14. package/src/services/cynosdb/v20190107/cynosdb_client.ts +1 -0
  15. package/src/services/cynosdb/v20190107/cynosdb_models.ts +81 -24
  16. package/src/services/dasb/v20191018/dasb_client.ts +12 -0
  17. package/src/services/dasb/v20191018/dasb_models.ts +33 -0
  18. package/src/services/ess/v20201111/ess_client.ts +25 -21
  19. package/src/services/ess/v20201111/ess_models.ts +255 -171
  20. package/src/services/iai/v20180301/iai_models.ts +3 -3
  21. package/src/services/iai/v20200303/iai_models.ts +3 -3
  22. package/src/services/iss/v20230517/iss_client.ts +21 -7
  23. package/src/services/iss/v20230517/iss_models.ts +47 -0
  24. package/src/services/lcic/v20220817/lcic_models.ts +1 -1
  25. package/src/services/mps/v20190612/mps_models.ts +5 -0
  26. package/src/services/organization/v20210331/organization_client.ts +18 -6
  27. package/src/services/organization/v20210331/organization_models.ts +20 -0
  28. package/src/services/trtc/v20190722/trtc_models.ts +5 -3
  29. package/src/services/waf/v20180125/waf_client.ts +20 -8
  30. package/src/services/waf/v20180125/waf_models.ts +122 -52
  31. package/tencentcloud/common/sdk_version.d.ts +1 -1
  32. package/tencentcloud/common/sdk_version.js +1 -1
  33. package/tencentcloud/services/cbs/v20170312/cbs_models.d.ts +5 -4
  34. package/tencentcloud/services/cdn/v20180606/cdn_client.d.ts +14 -7
  35. package/tencentcloud/services/cdn/v20180606/cdn_client.js +14 -7
  36. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +19 -19
  37. package/tencentcloud/services/clb/v20180317/clb_client.d.ts +19 -3
  38. package/tencentcloud/services/clb/v20180317/clb_client.js +27 -3
  39. package/tencentcloud/services/clb/v20180317/clb_models.d.ts +225 -40
  40. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +2 -2
  41. package/tencentcloud/services/cwp/v20180228/cwp_client.d.ts +17 -1
  42. package/tencentcloud/services/cwp/v20180228/cwp_client.js +24 -0
  43. package/tencentcloud/services/cwp/v20180228/cwp_models.d.ts +333 -46
  44. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +80 -24
  45. package/tencentcloud/services/dasb/v20191018/dasb_client.d.ts +5 -1
  46. package/tencentcloud/services/dasb/v20191018/dasb_client.js +6 -0
  47. package/tencentcloud/services/dasb/v20191018/dasb_models.d.ts +31 -0
  48. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +25 -21
  49. package/tencentcloud/services/ess/v20201111/ess_client.js +25 -21
  50. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +255 -171
  51. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +3 -3
  52. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +3 -3
  53. package/tencentcloud/services/iss/v20230517/iss_client.d.ts +8 -3
  54. package/tencentcloud/services/iss/v20230517/iss_client.js +10 -3
  55. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +44 -0
  56. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +1 -1
  57. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +5 -0
  58. package/tencentcloud/services/organization/v20210331/organization_client.d.ts +7 -3
  59. package/tencentcloud/services/organization/v20210331/organization_client.js +9 -3
  60. package/tencentcloud/services/organization/v20210331/organization_models.d.ts +18 -0
  61. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +5 -3
  62. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +13 -9
  63. package/tencentcloud/services/waf/v20180125/waf_client.js +14 -8
  64. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +120 -52
  65. package/test/clb.v20180317.test.js +42 -2
  66. package/test/cwp.v20180228.test.js +40 -0
  67. package/test/dasb.v20191018.test.js +10 -0
  68. package/test/iss.v20230517.test.js +12 -2
  69. package/test/organization.v20210331.test.js +12 -2
  70. package/test/waf.v20180125.test.js +10 -0
@@ -1514,25 +1514,30 @@ export interface DescribeBackupConfigResponse {
1514
1514
  /**
1515
1515
  * 表示全备开始时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
1516
1516
  */
1517
- BackupTimeBeg: number;
1517
+ BackupTimeBeg?: number;
1518
1518
  /**
1519
1519
  * 表示全备开始时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
1520
1520
  */
1521
- BackupTimeEnd: number;
1521
+ BackupTimeEnd?: number;
1522
1522
  /**
1523
1523
  * 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600*24*7=604800
1524
1524
  */
1525
- ReserveDuration: number;
1525
+ ReserveDuration?: number;
1526
1526
  /**
1527
1527
  * 备份频率,长度为7的数组,分别对应周一到周日的备份方式,full-全量备份,increment-增量备份
1528
1528
  注意:此字段可能返回 null,表示取不到有效值。
1529
1529
  */
1530
- BackupFreq: Array<string>;
1530
+ BackupFreq?: Array<string>;
1531
1531
  /**
1532
1532
  * 备份方式,logic-逻辑备份,snapshot-快照备份
1533
1533
  注意:此字段可能返回 null,表示取不到有效值。
1534
1534
  */
1535
- BackupType: string;
1535
+ BackupType?: string;
1536
+ /**
1537
+ * 跨地域逻辑备份配置修改时间
1538
+ 注意:此字段可能返回 null,表示取不到有效值。
1539
+ */
1540
+ LogicCrossRegionsConfigUpdateTime?: string;
1536
1541
  /**
1537
1542
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1538
1543
  */
@@ -2802,54 +2807,54 @@ export interface BackupFileInfo {
2802
2807
  /**
2803
2808
  * 快照文件ID,已废弃,请使用BackupId
2804
2809
  */
2805
- SnapshotId: number;
2810
+ SnapshotId?: number;
2806
2811
  /**
2807
2812
  * 备份文件名
2808
2813
  */
2809
- FileName: string;
2814
+ FileName?: string;
2810
2815
  /**
2811
2816
  * 备份文件大小
2812
2817
  */
2813
- FileSize: number;
2818
+ FileSize?: number;
2814
2819
  /**
2815
2820
  * 备份开始时间
2816
2821
  */
2817
- StartTime: string;
2822
+ StartTime?: string;
2818
2823
  /**
2819
2824
  * 备份完成时间
2820
2825
  */
2821
- FinishTime: string;
2826
+ FinishTime?: string;
2822
2827
  /**
2823
2828
  * 备份类型:snapshot,快照备份;logic,逻辑备份
2824
2829
  */
2825
- BackupType: string;
2830
+ BackupType?: string;
2826
2831
  /**
2827
2832
  * 备份方式:auto,自动备份;manual,手动备份
2828
2833
  */
2829
- BackupMethod: string;
2834
+ BackupMethod?: string;
2830
2835
  /**
2831
2836
  * 备份文件状态:success:备份成功;fail:备份失败;creating:备份文件创建中;deleting:备份文件删除中
2832
2837
  */
2833
- BackupStatus: string;
2838
+ BackupStatus?: string;
2834
2839
  /**
2835
2840
  * 备份文件时间
2836
2841
  */
2837
- SnapshotTime: string;
2842
+ SnapshotTime?: string;
2838
2843
  /**
2839
2844
  * 备份ID
2840
2845
  注意:此字段可能返回 null,表示取不到有效值。
2841
2846
  */
2842
- BackupId: number;
2847
+ BackupId?: number;
2843
2848
  /**
2844
2849
  * 快照类型,可选值:full,全量;increment,增量
2845
2850
  注意:此字段可能返回 null,表示取不到有效值。
2846
2851
  */
2847
- SnapShotType: string;
2852
+ SnapShotType?: string;
2848
2853
  /**
2849
2854
  * 备份文件备注
2850
2855
  注意:此字段可能返回 null,表示取不到有效值。
2851
2856
  */
2852
- BackupName: string;
2857
+ BackupName?: string;
2853
2858
  }
2854
2859
  /**
2855
2860
  * mysql表权限
@@ -3042,6 +3047,14 @@ export interface DescribeBackupListRequest {
3042
3047
  * 快照备份Id列表
3043
3048
  */
3044
3049
  SnapshotIdList?: Array<number | bigint>;
3050
+ /**
3051
+ * 备份地域
3052
+ */
3053
+ BackupRegion?: string;
3054
+ /**
3055
+ * 是否跨地域备份
3056
+ */
3057
+ IsCrossRegionsBackup?: string;
3045
3058
  }
3046
3059
  /**
3047
3060
  * CloseProxy请求参数结构体
@@ -4816,7 +4829,7 @@ export interface CreateBackupResponse {
4816
4829
  /**
4817
4830
  * 异步任务流ID
4818
4831
  */
4819
- FlowId: number;
4832
+ FlowId?: number;
4820
4833
  /**
4821
4834
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4822
4835
  */
@@ -6381,11 +6394,11 @@ export interface DescribeBackupListResponse {
6381
6394
  /**
6382
6395
  * 总共备份文件个数
6383
6396
  */
6384
- TotalCount: number;
6397
+ TotalCount?: number;
6385
6398
  /**
6386
6399
  * 备份文件列表
6387
6400
  */
6388
- BackupList: Array<BackupFileInfo>;
6401
+ BackupList?: Array<BackupFileInfo>;
6389
6402
  /**
6390
6403
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6391
6404
  */
@@ -6483,10 +6496,6 @@ export interface ModifyBackupConfigRequest {
6483
6496
  * 集群ID
6484
6497
  */
6485
6498
  ClusterId: string;
6486
- /**
6487
- * 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600*24*7=604800,最大为158112000
6488
- */
6489
- ReserveDuration: number;
6490
6499
  /**
6491
6500
  * 表示全备开始时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
6492
6501
  */
@@ -6495,6 +6504,10 @@ export interface ModifyBackupConfigRequest {
6495
6504
  * 表示全备结束时间,[0-24*3600], 如0:00, 1:00, 2:00 分别为 0,3600, 7200
6496
6505
  */
6497
6506
  BackupTimeEnd?: number;
6507
+ /**
6508
+ * 表示保留备份时长, 单位秒,超过该时间将被清理, 七天表示为3600*24*7=604800,最大为158112000
6509
+ */
6510
+ ReserveDuration?: number;
6498
6511
  /**
6499
6512
  * 该参数目前不支持修改,无需填写。备份频率,长度为7的数组,分别对应周一到周日的备份方式,full-全量备份,increment-增量备份
6500
6513
  */
@@ -6503,6 +6516,14 @@ export interface ModifyBackupConfigRequest {
6503
6516
  * 该参数目前不支持修改,无需填写。备份方式,logic-逻辑备份,snapshot-快照备份
6504
6517
  */
6505
6518
  BackupType?: string;
6519
+ /**
6520
+ * 逻辑备份配置
6521
+ */
6522
+ LogicBackupConfig?: LogicBackupConfigInfo;
6523
+ /**
6524
+ * 是否删除自动逻辑备份
6525
+ */
6526
+ DeleteAutoLogicBackup?: boolean;
6506
6527
  }
6507
6528
  /**
6508
6529
  * ActivateInstance返回参数结构体
@@ -7014,6 +7035,41 @@ export interface ExportInstanceSlowQueriesResponse {
7014
7035
  */
7015
7036
  RequestId?: string;
7016
7037
  }
7038
+ /**
7039
+ * 逻辑备份配置信息
7040
+ */
7041
+ export interface LogicBackupConfigInfo {
7042
+ /**
7043
+ * 是否开启自动逻辑备份
7044
+ 注意:此字段可能返回 null,表示取不到有效值。
7045
+ */
7046
+ LogicBackupEnable?: string;
7047
+ /**
7048
+ * 自动逻辑备份开始时间
7049
+ 注意:此字段可能返回 null,表示取不到有效值。
7050
+ */
7051
+ LogicBackupTimeBeg?: number;
7052
+ /**
7053
+ * 自动逻辑备份结束时间
7054
+ 注意:此字段可能返回 null,表示取不到有效值。
7055
+ */
7056
+ LogicBackupTimeEnd?: number;
7057
+ /**
7058
+ * 自动逻辑备份保留时间
7059
+ 注意:此字段可能返回 null,表示取不到有效值。
7060
+ */
7061
+ LogicReserveDuration?: number;
7062
+ /**
7063
+ * 是否开启跨地域逻辑备份
7064
+ 注意:此字段可能返回 null,表示取不到有效值。
7065
+ */
7066
+ LogicCrossRegionsEnable?: string;
7067
+ /**
7068
+ * 逻辑备份所跨地域
7069
+ 注意:此字段可能返回 null,表示取不到有效值。
7070
+ */
7071
+ LogicCrossRegions?: Array<string>;
7072
+ }
7017
7073
  /**
7018
7074
  * RefundResourcePackage返回参数结构体
7019
7075
  */
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { ResetDeviceAccountPasswordResponse, DescribeLoginEventRequest, BindDeviceAccountPasswordRequest, DeleteAclsRequest, DeleteDeviceGroupsResponse, DescribeDeviceGroupsResponse, DeleteCmdTemplatesResponse, DeleteDevicesResponse, BindDeviceAccountPasswordResponse, ResetDeviceAccountPasswordRequest, AddUserGroupMembersRequest, DescribeDevicesResponse, ResetUserResponse, DeleteUserGroupMembersRequest, DeleteUserGroupsResponse, ModifyDeviceRequest, SearchFileRequest, SearchCommandRequest, ImportExternalDeviceRequest, SearchSessionRequest, BindDeviceResourceResponse, DeleteUserGroupMembersResponse, CreateUserGroupRequest, BindDeviceAccountPrivateKeyResponse, SearchCommandBySidRequest, CreateDeviceGroupResponse, DescribeUserGroupMembersRequest, CreateUserResponse, DescribeAssetSyncStatusResponse, CreateAclRequest, DescribeLoginEventResponse, DeleteDeviceGroupMembersRequest, CreateDeviceGroupRequest, CreateAclResponse, DescribeAclsResponse, CreateCmdTemplateResponse, ModifyAclRequest, SearchAuditLogRequest, SearchCommandResponse, DeleteUsersResponse, SearchCommandBySidResponse, DescribeResourcesResponse, DescribeUsersRequest, DeployResourceRequest, SearchSessionResponse, CreateCmdTemplateRequest, ResetDeviceAccountPrivateKeyRequest, DescribeDeviceGroupsRequest, CreateAssetSyncJobResponse, BindDeviceAccountPrivateKeyRequest, CreateAssetSyncJobRequest, DescribeAssetSyncStatusRequest, ResetDeviceAccountPrivateKeyResponse, DeleteUsersRequest, DeleteDeviceAccountsRequest, DeleteDeviceGroupMembersResponse, ModifyDeviceGroupResponse, DescribeUserGroupMembersResponse, ImportExternalDeviceResponse, SearchSessionCommandResponse, DeleteUserGroupsRequest, ResetUserRequest, DescribeDasbImageIdsRequest, CreateDeviceAccountResponse, ModifyDeviceGroupRequest, DescribeUsersResponse, DeployResourceResponse, CreateUserRequest, SearchFileBySidResponse, DescribeOperationEventRequest, ModifyDeviceResponse, ModifyUserResponse, DescribeCmdTemplatesResponse, CreateDeviceAccountRequest, AddDeviceGroupMembersResponse, DeleteCmdTemplatesRequest, DescribeUserGroupsResponse, AddUserGroupMembersResponse, DescribeDeviceAccountsRequest, DescribeDasbImageIdsResponse, DescribeCmdTemplatesRequest, DeleteAclsResponse, CreateUserGroupResponse, DeleteDevicesRequest, DescribeDeviceAccountsResponse, ModifyUserRequest, ModifyAclResponse, DescribeResourcesRequest, DeleteDeviceGroupsRequest, DescribeDeviceGroupMembersResponse, SearchAuditLogResponse, BindDeviceResourceRequest, DescribeDevicesRequest, SearchSessionCommandRequest, SearchFileBySidRequest, DescribeOperationEventResponse, DescribeUserGroupsRequest, DescribeDeviceGroupMembersRequest, DescribeAclsRequest, AddDeviceGroupMembersRequest, DeleteDeviceAccountsResponse, SearchFileResponse } from "./dasb_models";
3
+ import { ResetDeviceAccountPasswordResponse, DescribeLoginEventRequest, BindDeviceAccountPasswordRequest, DeleteAclsRequest, DeleteDeviceGroupsResponse, DescribeDeviceGroupsResponse, DeleteCmdTemplatesResponse, DeleteDevicesResponse, BindDeviceAccountPasswordResponse, ResetDeviceAccountPasswordRequest, AddUserGroupMembersRequest, DescribeDevicesResponse, ResetUserResponse, DeleteUserGroupMembersRequest, DeleteUserGroupsResponse, ModifyDeviceRequest, SearchFileRequest, SearchCommandRequest, ImportExternalDeviceRequest, SearchSessionRequest, BindDeviceResourceResponse, DeleteUserGroupMembersResponse, CreateUserGroupRequest, BindDeviceAccountPrivateKeyResponse, SearchCommandBySidRequest, CreateDeviceGroupResponse, DescribeUserGroupMembersRequest, ModifyCmdTemplateRequest, CreateUserResponse, DescribeAssetSyncStatusResponse, CreateAclRequest, DescribeLoginEventResponse, DeleteDeviceGroupMembersRequest, CreateDeviceGroupRequest, CreateAclResponse, DescribeAclsResponse, CreateCmdTemplateResponse, ModifyAclRequest, SearchAuditLogRequest, SearchCommandResponse, DeleteUsersResponse, SearchCommandBySidResponse, DescribeResourcesResponse, DescribeUsersRequest, DeployResourceRequest, SearchSessionResponse, CreateCmdTemplateRequest, ResetDeviceAccountPrivateKeyRequest, DescribeDeviceGroupsRequest, CreateAssetSyncJobResponse, BindDeviceAccountPrivateKeyRequest, CreateAssetSyncJobRequest, DescribeAssetSyncStatusRequest, ResetDeviceAccountPrivateKeyResponse, DeleteUsersRequest, DeleteDeviceAccountsRequest, DeleteDeviceGroupMembersResponse, ModifyDeviceGroupResponse, DescribeUserGroupMembersResponse, ImportExternalDeviceResponse, SearchSessionCommandResponse, DeleteUserGroupsRequest, ResetUserRequest, DescribeDasbImageIdsRequest, CreateDeviceAccountResponse, ModifyDeviceGroupRequest, DescribeUsersResponse, DeployResourceResponse, CreateUserRequest, SearchFileBySidResponse, DescribeOperationEventRequest, ModifyDeviceResponse, ModifyUserResponse, DescribeCmdTemplatesResponse, CreateDeviceAccountRequest, ModifyCmdTemplateResponse, AddDeviceGroupMembersResponse, DeleteCmdTemplatesRequest, DescribeUserGroupsResponse, AddUserGroupMembersResponse, DescribeDeviceAccountsRequest, DescribeDasbImageIdsResponse, DescribeCmdTemplatesRequest, DeleteAclsResponse, CreateUserGroupResponse, DeleteDevicesRequest, DescribeDeviceAccountsResponse, ModifyUserRequest, ModifyAclResponse, DescribeResourcesRequest, DeleteDeviceGroupsRequest, DescribeDeviceGroupMembersResponse, SearchAuditLogResponse, BindDeviceResourceRequest, DescribeDevicesRequest, SearchSessionCommandRequest, SearchFileBySidRequest, DescribeOperationEventResponse, DescribeUserGroupsRequest, DescribeDeviceGroupMembersRequest, DescribeAclsRequest, AddDeviceGroupMembersRequest, DeleteDeviceAccountsResponse, SearchFileResponse } from "./dasb_models";
4
4
  /**
5
5
  * dasb client
6
6
  * @class
@@ -15,6 +15,10 @@ export declare class Client extends AbstractClient {
15
15
  * 查询资产组成员列表
16
16
  */
17
17
  DescribeDeviceGroupMembers(req: DescribeDeviceGroupMembersRequest, cb?: (error: string, rep: DescribeDeviceGroupMembersResponse) => void): Promise<DescribeDeviceGroupMembersResponse>;
18
+ /**
19
+ * 修改高危命令模板
20
+ */
21
+ ModifyCmdTemplate(req: ModifyCmdTemplateRequest, cb?: (error: string, rep: ModifyCmdTemplateResponse) => void): Promise<ModifyCmdTemplateResponse>;
18
22
  /**
19
23
  * 查询登录日志
20
24
  */
@@ -39,6 +39,12 @@ class Client extends abstract_client_1.AbstractClient {
39
39
  async DescribeDeviceGroupMembers(req, cb) {
40
40
  return this.request("DescribeDeviceGroupMembers", req, cb);
41
41
  }
42
+ /**
43
+ * 修改高危命令模板
44
+ */
45
+ async ModifyCmdTemplate(req, cb) {
46
+ return this.request("ModifyCmdTemplate", req, cb);
47
+ }
42
48
  /**
43
49
  * 查询登录日志
44
50
  */
@@ -812,6 +812,28 @@ export interface OperationEvent {
812
812
  */
813
813
  Result: number;
814
814
  }
815
+ /**
816
+ * ModifyCmdTemplate请求参数结构体
817
+ */
818
+ export interface ModifyCmdTemplateRequest {
819
+ /**
820
+ * 模板名,最长32字符,不能包含空白字符
821
+ */
822
+ Name: string;
823
+ /**
824
+ * 命令列表,\n分隔,最长32768字节
825
+ */
826
+ CmdList: string;
827
+ /**
828
+ * 命令模板ID
829
+ */
830
+ Id: number;
831
+ /**
832
+ * CmdList字段前端是否base64传值。
833
+ 0:否,1:是
834
+ */
835
+ Encoding?: number;
836
+ }
815
837
  /**
816
838
  * 搜索字符或图形会话时返回的SessionResul结构体
817
839
  */
@@ -2162,6 +2184,15 @@ export interface CreateDeviceAccountRequest {
2162
2184
  */
2163
2185
  Account: string;
2164
2186
  }
2187
+ /**
2188
+ * ModifyCmdTemplate返回参数结构体
2189
+ */
2190
+ export interface ModifyCmdTemplateResponse {
2191
+ /**
2192
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2193
+ */
2194
+ RequestId?: string;
2195
+ }
2165
2196
  /**
2166
2197
  * AddDeviceGroupMembers返回参数结构体
2167
2198
  */
@@ -8,7 +8,8 @@ import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowRespo
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
- * 查询合同详情
11
+ * 接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100)
12
+
12
13
  适用场景:可用于主动查询某个合同详情信息。
13
14
  */
14
15
  DescribeFlowInfo(req: DescribeFlowInfoRequest, cb?: (error: string, rep: DescribeFlowInfoResponse) => void): Promise<DescribeFlowInfoResponse>;
@@ -33,27 +34,27 @@ export declare class Client extends AbstractClient {
33
34
  */
34
35
  CancelFlow(req: CancelFlowRequest, cb?: (error: string, rep: CancelFlowResponse) => void): Promise<CancelFlowResponse>;
35
36
  /**
36
- * 本接口用于查询本企业模板列表。
37
-
38
- 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
39
-
40
- > **适用场景**
41
- >
42
- > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
37
+ * 此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。
43
38
  > 一个模板通常会包含以下结构信息
44
39
  >- 模板基本信息
45
40
  >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
46
41
  >- 填写控件 Components
47
42
  >- 签署控件 SignComponents
48
43
  >- 生成模板的文件基础信息 FileInfos
44
+
45
+ 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
46
+
47
+ 适用场景:
48
+ 该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口,作为创建电子文档的前置接口使用。
49
+ 通过此接口查询到模板信息后,再通过调用创建电子文档接口,指定模板ID,指定模板中需要的填写控件内容等,完成电子文档的创建。
49
50
  */
50
51
  DescribeFlowTemplates(req: DescribeFlowTemplatesRequest, cb?: (error: string, rep: DescribeFlowTemplatesResponse) => void): Promise<DescribeFlowTemplatesResponse>;
51
52
  /**
52
- * 撤销员工持有的印章权限
53
+ * 本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限
53
54
  */
54
55
  DeleteSealPolicies(req: DeleteSealPoliciesRequest, cb?: (error: string, rep: DeleteSealPoliciesResponse) => void): Promise<DeleteSealPoliciesResponse>;
55
56
  /**
56
- * 查询文件下载URL。
57
+ * 本接口(DescribeFileUrls)用于查询文件的下载URL。
57
58
  适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
58
59
  */
59
60
  DescribeFileUrls(req: DescribeFileUrlsRequest, cb?: (error: string, rep: DescribeFileUrlsResponse) => void): Promise<DescribeFileUrlsResponse>;
@@ -88,7 +89,7 @@ export declare class Client extends AbstractClient {
88
89
  */
89
90
  CreateEmbedWebUrl(req: CreateEmbedWebUrlRequest, cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void): Promise<CreateEmbedWebUrlResponse>;
90
91
  /**
91
- * 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
92
+ * 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
92
93
  */
93
94
  VerifyPdf(req: VerifyPdfRequest, cb?: (error: string, rep: VerifyPdfResponse) => void): Promise<VerifyPdfResponse>;
94
95
  /**
@@ -140,15 +141,17 @@ export declare class Client extends AbstractClient {
140
141
  */
141
142
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
142
143
  /**
143
- * 创建快速发起流程
144
- <br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
145
- <br/>注:该接口文件的resourceId 是通过上传文件之后获取的。
144
+ * 创建发起流程web页面
145
+ <br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
146
+ <br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
146
147
  */
147
148
  CreatePrepareFlow(req: CreatePrepareFlowRequest, cb?: (error: string, rep: CreatePrepareFlowResponse) => void): Promise<CreatePrepareFlowResponse>;
148
149
  /**
149
- * 创建签署流程电子文档
150
- 适用场景:见创建签署流程接口。
151
- 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用, 具体逻辑可以参考下图:
150
+ * 创建签署流程电子文档<br />
151
+ 适用场景:见创建签署流程接口。<br />
152
+ 点击查看<a href="https://qian.tencent.com/developers/startFlows/CreateFlow" target="_blank">通过模板创建签署流程</a>
153
+ <a href="https://qian.tencent.com/developers/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>。<br />
154
+ 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
152
155
 
153
156
  <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
154
157
  */
@@ -371,7 +374,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
371
374
  */
372
375
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
373
376
  /**
374
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
377
+ * 查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
375
378
  */
376
379
  DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
377
380
  /**
@@ -396,8 +399,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
396
399
  */
397
400
  DescribeThirdPartyAuthCode(req: DescribeThirdPartyAuthCodeRequest, cb?: (error: string, rep: DescribeThirdPartyAuthCodeResponse) => void): Promise<DescribeThirdPartyAuthCodeResponse>;
398
401
  /**
399
- * 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
400
- 创建配置对当前企业全局生效,如果多次调用,会以最后一次的配置为准
402
+ * 用来设置本企业嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),设置后获取的web签署界面都会使用此配置进行展示。
403
+
404
+ 如果多次调用,会以最后一次的配置为准
401
405
  */
402
406
  CreateWebThemeConfig(req: CreateWebThemeConfigRequest, cb?: (error: string, rep: CreateWebThemeConfigResponse) => void): Promise<CreateWebThemeConfigResponse>;
403
407
  /**
@@ -458,7 +462,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
458
462
  */
459
463
  DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
460
464
  /**
461
- * 对企业员工进行印章授权
465
+ * 本接口(CreateSealPolicy)用于对企业员工进行印章授权
462
466
  */
463
467
  CreateSealPolicy(req: CreateSealPolicyRequest, cb?: (error: string, rep: CreateSealPolicyResponse) => void): Promise<CreateSealPolicyResponse>;
464
468
  /**
@@ -28,7 +28,8 @@ class Client extends abstract_client_1.AbstractClient {
28
28
  super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
29
29
  }
30
30
  /**
31
- * 查询合同详情
31
+ * 接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100)
32
+
32
33
  适用场景:可用于主动查询某个合同详情信息。
33
34
  */
34
35
  async DescribeFlowInfo(req, cb) {
@@ -61,31 +62,31 @@ class Client extends abstract_client_1.AbstractClient {
61
62
  return this.request("CancelFlow", req, cb);
62
63
  }
63
64
  /**
64
- * 本接口用于查询本企业模板列表。
65
-
66
- 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
67
-
68
- > **适用场景**
69
- >
70
- > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
65
+ * 此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。
71
66
  > 一个模板通常会包含以下结构信息
72
67
  >- 模板基本信息
73
68
  >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
74
69
  >- 填写控件 Components
75
70
  >- 签署控件 SignComponents
76
71
  >- 生成模板的文件基础信息 FileInfos
72
+
73
+ 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
74
+
75
+ 适用场景:
76
+ 该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口,作为创建电子文档的前置接口使用。
77
+ 通过此接口查询到模板信息后,再通过调用创建电子文档接口,指定模板ID,指定模板中需要的填写控件内容等,完成电子文档的创建。
77
78
  */
78
79
  async DescribeFlowTemplates(req, cb) {
79
80
  return this.request("DescribeFlowTemplates", req, cb);
80
81
  }
81
82
  /**
82
- * 撤销员工持有的印章权限
83
+ * 本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限
83
84
  */
84
85
  async DeleteSealPolicies(req, cb) {
85
86
  return this.request("DeleteSealPolicies", req, cb);
86
87
  }
87
88
  /**
88
- * 查询文件下载URL。
89
+ * 本接口(DescribeFileUrls)用于查询文件的下载URL。
89
90
  适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
90
91
  */
91
92
  async DescribeFileUrls(req, cb) {
@@ -128,7 +129,7 @@ class Client extends abstract_client_1.AbstractClient {
128
129
  return this.request("CreateEmbedWebUrl", req, cb);
129
130
  }
130
131
  /**
131
- * 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
132
+ * 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
132
133
  */
133
134
  async VerifyPdf(req, cb) {
134
135
  return this.request("VerifyPdf", req, cb);
@@ -200,17 +201,19 @@ class Client extends abstract_client_1.AbstractClient {
200
201
  return this.request("CreateFlowSignReview", req, cb);
201
202
  }
202
203
  /**
203
- * 创建快速发起流程
204
- <br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
205
- <br/>注:该接口文件的resourceId 是通过上传文件之后获取的。
204
+ * 创建发起流程web页面
205
+ <br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
206
+ <br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
206
207
  */
207
208
  async CreatePrepareFlow(req, cb) {
208
209
  return this.request("CreatePrepareFlow", req, cb);
209
210
  }
210
211
  /**
211
- * 创建签署流程电子文档
212
- 适用场景:见创建签署流程接口。
213
- 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用, 具体逻辑可以参考下图:
212
+ * 创建签署流程电子文档<br />
213
+ 适用场景:见创建签署流程接口。<br />
214
+ 点击查看<a href="https://qian.tencent.com/developers/startFlows/CreateFlow" target="_blank">通过模板创建签署流程</a>
215
+ <a href="https://qian.tencent.com/developers/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>。<br />
216
+ 注:该接口需要给对应的流程指定一个模板id,并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
214
217
 
215
218
  <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
216
219
  */
@@ -485,7 +488,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
485
488
  return this.request("CreateFlowReminds", req, cb);
486
489
  }
487
490
  /**
488
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
491
+ * 查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
489
492
  */
490
493
  async DescribeFlowComponents(req, cb) {
491
494
  return this.request("DescribeFlowComponents", req, cb);
@@ -516,8 +519,9 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
516
519
  return this.request("DescribeThirdPartyAuthCode", req, cb);
517
520
  }
518
521
  /**
519
- * 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
520
- 创建配置对当前企业全局生效,如果多次调用,会以最后一次的配置为准
522
+ * 用来设置本企业嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),设置后获取的web签署界面都会使用此配置进行展示。
523
+
524
+ 如果多次调用,会以最后一次的配置为准
521
525
  */
522
526
  async CreateWebThemeConfig(req, cb) {
523
527
  return this.request("CreateWebThemeConfig", req, cb);
@@ -594,7 +598,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
594
598
  return this.request("DescribeOrganizationGroupOrganizations", req, cb);
595
599
  }
596
600
  /**
597
- * 对企业员工进行印章授权
601
+ * 本接口(CreateSealPolicy)用于对企业员工进行印章授权
598
602
  */
599
603
  async CreateSealPolicy(req, cb) {
600
604
  return this.request("CreateSealPolicy", req, cb);