tencentcloud-sdk-nodejs-ess 4.0.1038 → 4.0.1042

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.
@@ -174,7 +174,6 @@ export interface DescribeCancelFlowsTaskResponse {
174
174
  export interface IntentionActionResult {
175
175
  /**
176
176
  * 意愿核身结果详细数据,与每段点头确认过程一一对应
177
- 注意:此字段可能返回 null,表示取不到有效值。
178
177
  */
179
178
  Details?: Array<IntentionActionResultDetail>
180
179
  }
@@ -566,6 +565,30 @@ export interface DeleteExtendedServiceAuthInfosResponse {
566
565
  RequestId?: string
567
566
  }
568
567
 
568
+ /**
569
+ * CreateFlowForwards请求参数结构体
570
+ */
571
+ export interface CreateFlowForwardsRequest {
572
+ /**
573
+ * 执行本接口操作的员工信息。注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
574
+ */
575
+ Operator: UserInfo
576
+ /**
577
+ * 合同对应参与方需要修改的目标经办人。其UserId可在企业控制台中组织管理里面找到。或者使用获取员工信息接口得到。
578
+
579
+ 注意:`需要保证目标经办人已经加入企业且已实名`
580
+ */
581
+ TargetUserId: string
582
+ /**
583
+ * 企业签署方的合同及对应签署方
584
+ */
585
+ FlowForwardInfos: Array<FlowForwardInfo>
586
+ /**
587
+ * 代理企业和员工的信息。在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
588
+ */
589
+ Agent?: Agent
590
+ }
591
+
569
592
  /**
570
593
  * CreateDynamicFlowApprover请求参数结构体
571
594
  */
@@ -655,17 +678,14 @@ export interface IntentionQuestionResult {
655
678
  * 视频base64(其中包含全程问题和回答音频,mp4格式)
656
679
 
657
680
  注:`需进行base64解码获取视频文件`
658
- 注意:此字段可能返回 null,表示取不到有效值。
659
681
  */
660
682
  Video?: string
661
683
  /**
662
684
  * 和答案匹配结果列表
663
- 注意:此字段可能返回 null,表示取不到有效值。
664
685
  */
665
686
  ResultCode?: Array<string>
666
687
  /**
667
688
  * 回答问题语音识别结果列表
668
- 注意:此字段可能返回 null,表示取不到有效值。
669
689
  */
670
690
  AsrResult?: Array<string>
671
691
  }
@@ -702,32 +722,26 @@ export interface CancelUserAutoSignEnableUrlRequest {
702
722
  export interface AuthInfoDetail {
703
723
  /**
704
724
  * 扩展服务类型,和入参一致
705
- 注意:此字段可能返回 null,表示取不到有效值。
706
725
  */
707
726
  Type?: string
708
727
  /**
709
728
  * 扩展服务名称
710
- 注意:此字段可能返回 null,表示取不到有效值。
711
729
  */
712
730
  Name?: string
713
731
  /**
714
732
  * 授权员工列表
715
- 注意:此字段可能返回 null,表示取不到有效值。
716
733
  */
717
734
  HasAuthUserList?: Array<HasAuthUser>
718
735
  /**
719
736
  * 授权企业列表(企业自动签时,该字段有值)
720
- 注意:此字段可能返回 null,表示取不到有效值。
721
737
  */
722
738
  HasAuthOrganizationList?: Array<HasAuthOrganization>
723
739
  /**
724
740
  * 授权员工列表总数
725
- 注意:此字段可能返回 null,表示取不到有效值。
726
741
  */
727
742
  AuthUserTotal?: number
728
743
  /**
729
744
  * 授权企业列表总数
730
- 注意:此字段可能返回 null,表示取不到有效值。
731
745
  */
732
746
  AuthOrganizationTotal?: number
733
747
  }
@@ -838,7 +852,6 @@ export interface FlowBrief {
838
852
  FlowName?: string
839
853
  /**
840
854
  * 合同流程描述信息。
841
- 注意:此字段可能返回 null,表示取不到有效值。
842
855
  */
843
856
  FlowDescription?: string
844
857
  /**
@@ -859,27 +872,22 @@ export interface FlowBrief {
859
872
  <li> **9** : 部分填写</li>
860
873
  <li> **10** : 已拒填</li>
861
874
  <li> **21** : 已解除</li></ul>
862
- 注意:此字段可能返回 null,表示取不到有效值。
863
875
  */
864
876
  FlowStatus?: number
865
877
  /**
866
878
  * 合同流程创建时间,格式为Unix标准时间戳(秒)。
867
- 注意:此字段可能返回 null,表示取不到有效值。
868
879
  */
869
880
  CreatedOn?: number
870
881
  /**
871
882
  * 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
872
- 注意:此字段可能返回 null,表示取不到有效值。
873
883
  */
874
884
  FlowMessage?: string
875
885
  /**
876
886
  * 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
877
- 注意:此字段可能返回 null,表示取不到有效值。
878
887
  */
879
888
  Creator?: string
880
889
  /**
881
890
  * 合同流程的签署截止时间,格式为Unix标准时间戳(秒)。
882
- 注意:此字段可能返回 null,表示取不到有效值。
883
891
  */
884
892
  Deadline?: number
885
893
  }
@@ -922,19 +930,16 @@ false:表示未实名
922
930
  export interface HasAuthUser {
923
931
  /**
924
932
  * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
925
- 注意:此字段可能返回 null,表示取不到有效值。
926
933
  */
927
934
  UserId?: string
928
935
  /**
929
936
  * 当前员工的归属情况,可能值是:
930
937
  MainOrg:在集团企业的场景下,返回此值代表是归属主企业
931
938
  CurrentOrg:在普通企业场景下返回此值;或者在集团企业的场景下,返回此值代表归属子企业
932
- 注意:此字段可能返回 null,表示取不到有效值。
933
939
  */
934
940
  BelongTo?: string
935
941
  /**
936
942
  * 集团主企业id,当前企业为集团子企业时,该字段有值
937
- 注意:此字段可能返回 null,表示取不到有效值。
938
943
  */
939
944
  MainOrganizationId?: string
940
945
  }
@@ -1037,6 +1042,16 @@ export interface ModifyExtendedServiceRequest {
1037
1042
  Endpoint?: string
1038
1043
  }
1039
1044
 
1045
+ /**
1046
+ * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
1047
+ */
1048
+ export interface IntentionAction {
1049
+ /**
1050
+ * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
1051
+ */
1052
+ Text?: string
1053
+ }
1054
+
1040
1055
  /**
1041
1056
  * CreateBatchInitOrganizationUrl返回参数结构体
1042
1057
  */
@@ -1285,32 +1300,26 @@ export interface CreateOrganizationAuthFileResponse {
1285
1300
  export interface FilledComponent {
1286
1301
  /**
1287
1302
  * 控件Id
1288
- 注意:此字段可能返回 null,表示取不到有效值。
1289
1303
  */
1290
1304
  ComponentId?: string
1291
1305
  /**
1292
1306
  * 控件名称
1293
- 注意:此字段可能返回 null,表示取不到有效值。
1294
1307
  */
1295
1308
  ComponentName?: string
1296
1309
  /**
1297
1310
  * 控件填写状态;0-未填写;1-已填写
1298
- 注意:此字段可能返回 null,表示取不到有效值。
1299
1311
  */
1300
1312
  ComponentFillStatus?: string
1301
1313
  /**
1302
1314
  * 控件填写内容
1303
- 注意:此字段可能返回 null,表示取不到有效值。
1304
1315
  */
1305
1316
  ComponentValue?: string
1306
1317
  /**
1307
1318
  * 控件所属参与方Id
1308
- 注意:此字段可能返回 null,表示取不到有效值。
1309
1319
  */
1310
1320
  ComponentRecipientId?: string
1311
1321
  /**
1312
1322
  * 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
1313
- 注意:此字段可能返回 null,表示取不到有效值。
1314
1323
  */
1315
1324
  ImageUrl?: string
1316
1325
  }
@@ -1423,7 +1432,6 @@ export interface StartFlowResponse {
1423
1432
  export interface SealInfo {
1424
1433
  /**
1425
1434
  * 印章ID
1426
- 注意:此字段可能返回 null,表示取不到有效值。
1427
1435
  */
1428
1436
  SealId: string
1429
1437
  /**
@@ -1431,12 +1439,10 @@ export interface SealInfo {
1431
1439
  ORGANIZATIONSEAL:企业印章;
1432
1440
  OFFICIAL:企业公章;
1433
1441
  CONTRACT:合同专用章
1434
- 注意:此字段可能返回 null,表示取不到有效值。
1435
1442
  */
1436
1443
  SealType: string
1437
1444
  /**
1438
1445
  * 印章名称
1439
- 注意:此字段可能返回 null,表示取不到有效值。
1440
1446
  */
1441
1447
  SealName: string
1442
1448
  }
@@ -1447,12 +1453,10 @@ CONTRACT:合同专用章
1447
1453
  export interface StaffRole {
1448
1454
  /**
1449
1455
  * 角色ID。
1450
- 注意:此字段可能返回 null,表示取不到有效值。
1451
1456
  */
1452
1457
  RoleId?: string
1453
1458
  /**
1454
1459
  * 角色名称。
1455
- 注意:此字段可能返回 null,表示取不到有效值。
1456
1460
  */
1457
1461
  RoleName?: string
1458
1462
  }
@@ -1463,22 +1467,18 @@ export interface StaffRole {
1463
1467
  export interface GroupOrganization {
1464
1468
  /**
1465
1469
  * 成员企业名
1466
- 注意:此字段可能返回 null,表示取不到有效值。
1467
1470
  */
1468
1471
  Name?: string
1469
1472
  /**
1470
1473
  * 成员企业别名
1471
- 注意:此字段可能返回 null,表示取不到有效值。
1472
1474
  */
1473
1475
  Alias?: string
1474
1476
  /**
1475
1477
  * 成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取
1476
- 注意:此字段可能返回 null,表示取不到有效值。
1477
1478
  */
1478
1479
  OrganizationId?: string
1479
1480
  /**
1480
1481
  * 记录更新时间, unix时间戳,单位秒
1481
- 注意:此字段可能返回 null,表示取不到有效值。
1482
1482
  */
1483
1483
  UpdateTime?: number
1484
1484
  /**
@@ -1490,44 +1490,36 @@ export interface GroupOrganization {
1490
1490
  <li> **5**:已加入</li>
1491
1491
  </ul>
1492
1492
 
1493
- 注意:此字段可能返回 null,表示取不到有效值。
1494
1493
  */
1495
1494
  Status?: number
1496
1495
  /**
1497
1496
  * 是否为集团主企业
1498
- 注意:此字段可能返回 null,表示取不到有效值。
1499
1497
  */
1500
1498
  IsMainOrganization?: boolean
1501
1499
  /**
1502
1500
  * 企业社会信用代码
1503
- 注意:此字段可能返回 null,表示取不到有效值。
1504
1501
  */
1505
1502
  IdCardNumber?: string
1506
1503
  /**
1507
1504
  * 企业超管信息
1508
- 注意:此字段可能返回 null,表示取不到有效值。
1509
1505
  */
1510
1506
  AdminInfo?: Admin
1511
1507
  /**
1512
1508
  * 企业许可证Id,此字段暂时不需要关注
1513
- 注意:此字段可能返回 null,表示取不到有效值。
1514
1509
  */
1515
1510
  License?: string
1516
1511
  /**
1517
1512
  * 企业许可证过期时间,unix时间戳,单位秒
1518
- 注意:此字段可能返回 null,表示取不到有效值。
1519
1513
  */
1520
1514
  LicenseExpireTime?: number
1521
1515
  /**
1522
1516
  * 成员企业加入集团时间,unix时间戳,单位秒
1523
- 注意:此字段可能返回 null,表示取不到有效值。
1524
1517
  */
1525
1518
  JoinTime?: number
1526
1519
  /**
1527
1520
  * 是否使用自建审批流引擎(即不是企微审批流引擎)
1528
1521
  <ul><li> **true**:是</li>
1529
1522
  <li> **false**:否</li></ul>
1530
- 注意:此字段可能返回 null,表示取不到有效值。
1531
1523
  */
1532
1524
  FlowEngineEnable?: boolean
1533
1525
  }
@@ -1571,7 +1563,6 @@ export interface ArchiveDynamicApproverData {
1571
1563
  * 签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。
1572
1564
 
1573
1565
  可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。
1574
- 注意:此字段可能返回 null,表示取不到有效值。
1575
1566
  */
1576
1567
  SignId?: string
1577
1568
  /**
@@ -1579,7 +1570,6 @@ export interface ArchiveDynamicApproverData {
1579
1570
 
1580
1571
  填写控件和签署控件都与特定的角色编号关联。
1581
1572
 
1582
- 注意:此字段可能返回 null,表示取不到有效值。
1583
1573
  */
1584
1574
  RecipientId?: string
1585
1575
  }
@@ -2060,7 +2050,6 @@ export interface DescribeUserAutoSignStatusResponse {
2060
2050
  export interface FlowApproverDetail {
2061
2051
  /**
2062
2052
  * 签署时的相关信息
2063
- 注意:此字段可能返回 null,表示取不到有效值。
2064
2053
  */
2065
2054
  ApproveMessage?: string
2066
2055
  /**
@@ -2091,7 +2080,6 @@ export interface FlowApproverDetail {
2091
2080
  ReceiptId?: string
2092
2081
  /**
2093
2082
  * 客户自定义的用户ID
2094
- 注意:此字段可能返回 null,表示取不到有效值。
2095
2083
  */
2096
2084
  CustomUserId?: string
2097
2085
  /**
@@ -2108,37 +2096,30 @@ export interface FlowApproverDetail {
2108
2096
  ApproveTime?: number
2109
2097
  /**
2110
2098
  * 签署方类型,ORGANIZATION-企业员工,PERSON-个人,ENTERPRISESERVER-企业静默签
2111
- 注意:此字段可能返回 null,表示取不到有效值。
2112
2099
  */
2113
2100
  ApproveType?: string
2114
2101
  /**
2115
2102
  * 签署方侧用户来源,如WEWORKAPP-企业微信等
2116
- 注意:此字段可能返回 null,表示取不到有效值。
2117
2103
  */
2118
2104
  ApproverSource?: string
2119
2105
  /**
2120
2106
  * 客户自定义签署方标识
2121
- 注意:此字段可能返回 null,表示取不到有效值。
2122
2107
  */
2123
2108
  CustomApproverTag?: string
2124
2109
  /**
2125
2110
  * 签署方企业Id
2126
- 注意:此字段可能返回 null,表示取不到有效值。
2127
2111
  */
2128
2112
  OrganizationId?: string
2129
2113
  /**
2130
2114
  * 签署方企业名称
2131
- 注意:此字段可能返回 null,表示取不到有效值。
2132
2115
  */
2133
2116
  OrganizationName?: string
2134
2117
  /**
2135
2118
  * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
2136
- 注意:此字段可能返回 null,表示取不到有效值。
2137
2119
  */
2138
2120
  SignId?: string
2139
2121
  /**
2140
2122
  * 自定义签署人角色
2141
- 注意:此字段可能返回 null,表示取不到有效值。
2142
2123
  */
2143
2124
  ApproverRoleName?: string
2144
2125
  /**
@@ -2217,13 +2198,28 @@ export interface DescribeFlowEvidenceReportResponse {
2217
2198
  }
2218
2199
 
2219
2200
  /**
2220
- * 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
2201
+ * CreateWebThemeConfig请求参数结构体
2221
2202
  */
2222
- export interface IntentionAction {
2203
+ export interface CreateWebThemeConfigRequest {
2223
2204
  /**
2224
- * 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
2205
+ * 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2225
2206
  */
2226
- Text?: string
2207
+ Operator: UserInfo
2208
+ /**
2209
+ * 主题类型,取值如下:
2210
+ <ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
2211
+ </ul>
2212
+ */
2213
+ ThemeType: string
2214
+ /**
2215
+ * 电子签logo是否展示,主体颜色等配置项
2216
+ */
2217
+ WebThemeConfig: WebThemeConfig
2218
+ /**
2219
+ * 代理企业和员工的信息。
2220
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2221
+ */
2222
+ Agent?: Agent
2227
2223
  }
2228
2224
 
2229
2225
  /**
@@ -2322,6 +2318,72 @@ export interface CancelFailureFlow {
2322
2318
  Reason?: string
2323
2319
  }
2324
2320
 
2321
+ /**
2322
+ * 合同文件验签单个结果结构体
2323
+ */
2324
+ export interface PdfVerifyResult {
2325
+ /**
2326
+ * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
2327
+ */
2328
+ VerifyResult?: number
2329
+ /**
2330
+ * 签署平台
2331
+ 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
2332
+ 如果文件不在腾讯电子签平台签署,则为**其他平台**。
2333
+ */
2334
+ SignPlatform?: string
2335
+ /**
2336
+ * 申请证书的主体的名字
2337
+
2338
+ 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2339
+ **企业**: ESS@企业名称@编码
2340
+ **个人**: ESS@个人姓名@证件号@808854
2341
+
2342
+ 如果在其他平台签署的, 主体的名字参考其他平台的说明
2343
+ */
2344
+ SignerName?: string
2345
+ /**
2346
+ * 签署时间的Unix时间戳,单位毫秒
2347
+ */
2348
+ SignTime?: number
2349
+ /**
2350
+ * 证书签名算法, 如SHA1withRSA等算法
2351
+ */
2352
+ SignAlgorithm?: string
2353
+ /**
2354
+ * 在数字证书申请过程中,系统会自动生成一个独一无二的序列号。
2355
+ */
2356
+ CertSn?: string
2357
+ /**
2358
+ * 证书起始时间的Unix时间戳,单位毫秒
2359
+ */
2360
+ CertNotBefore?: number
2361
+ /**
2362
+ * 证书过期时间的时间戳,单位毫秒
2363
+ */
2364
+ CertNotAfter?: number
2365
+ /**
2366
+ * 签名域横坐标,单位px
2367
+ */
2368
+ ComponentPosX?: number
2369
+ /**
2370
+ * 签名域纵坐标,单位px
2371
+ */
2372
+ ComponentPosY?: number
2373
+ /**
2374
+ * 签名域宽度,单位px
2375
+ */
2376
+ ComponentWidth?: number
2377
+ /**
2378
+ * 签名域高度,单位px
2379
+ */
2380
+ ComponentHeight?: number
2381
+ /**
2382
+ * 签名域所在页码,1~N
2383
+ */
2384
+ ComponentPage?: number
2385
+ }
2386
+
2325
2387
  /**
2326
2388
  * CreateUserVerifyUrl返回参数结构体
2327
2389
  */
@@ -2501,7 +2563,6 @@ export interface TemplateInfo {
2501
2563
  您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
2502
2564
 
2503
2565
  注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
2504
- 注意:此字段可能返回 null,表示取不到有效值。
2505
2566
  */
2506
2567
  PreviewUrl?: string
2507
2568
  /**
@@ -2511,12 +2572,10 @@ export interface TemplateInfo {
2511
2572
 
2512
2573
  自定义合同类型配置的地方如链接图所示。[点击查看自定义合同类型管理的位置](https://qcloudimg.tencent-cloud.cn/raw/36582cea03ae6a2559894844942b5d5c.png)
2513
2574
 
2514
- 注意:此字段可能返回 null,表示取不到有效值。
2515
2575
  */
2516
2576
  UserFlowType?: UserFlowType
2517
2577
  /**
2518
2578
  * 模板版本的编号,旨在标识其独特的版本信息,通常呈现为一串字符串,由日期和递增的数字组成
2519
- 注意:此字段可能返回 null,表示取不到有效值。
2520
2579
  */
2521
2580
  TemplateVersion?: string
2522
2581
  /**
@@ -2524,17 +2583,14 @@ export interface TemplateInfo {
2524
2583
 
2525
2584
  <b>true</b>:已发布状态,表示该模板已经发布并可以正常使用。
2526
2585
  <b>false</b>:未发布状态,表示该模板还未发布,无法使用。
2527
- 注意:此字段可能返回 null,表示取不到有效值。
2528
2586
  */
2529
2587
  Published?: boolean
2530
2588
  /**
2531
2589
  * <b>集体账号场景下</b>: 集团账号分享给子企业的模板的来源模板ID。
2532
- 注意:此字段可能返回 null,表示取不到有效值。
2533
2590
  */
2534
2591
  ShareTemplateId?: string
2535
2592
  /**
2536
2593
  * 此模板配置的预填印章列表(包括自动签署指定的印章)
2537
- 注意:此字段可能返回 null,表示取不到有效值。
2538
2594
  */
2539
2595
  TemplateSeals?: Array<SealInfo>
2540
2596
  /**
@@ -3237,24 +3293,20 @@ export interface Staff {
3237
3293
  Mobile?: string
3238
3294
  /**
3239
3295
  * 用户邮箱。
3240
- 注意:此字段可能返回 null,表示取不到有效值。
3241
3296
  */
3242
3297
  Email?: string
3243
3298
  /**
3244
3299
  * 用户在第三方平台ID。
3245
3300
  注:`如需在此接口提醒员工实名,该参数不传。`
3246
- 注意:此字段可能返回 null,表示取不到有效值。
3247
3301
  */
3248
3302
  OpenId?: string
3249
3303
  /**
3250
3304
  * 员工角色信息。
3251
3305
  注:`创建和更新场景无需填写。`
3252
- 注意:此字段可能返回 null,表示取不到有效值。
3253
3306
  */
3254
3307
  Roles?: Array<StaffRole>
3255
3308
  /**
3256
3309
  * 员工部门信息。
3257
- 注意:此字段可能返回 null,表示取不到有效值。
3258
3310
  */
3259
3311
  Department?: Department
3260
3312
  /**
@@ -3270,14 +3322,12 @@ export interface Staff {
3270
3322
  /**
3271
3323
  * 员工实名时间戳,单位秒。
3272
3324
  注:`创建和更新场景无需填写。`
3273
- 注意:此字段可能返回 null,表示取不到有效值。
3274
3325
  */
3275
3326
  VerifiedOn?: number
3276
3327
  /**
3277
3328
  * 员工是否离职:
3278
3329
  <ul><li>**0**:未离职</li><li>**1**:离职</li></ul>
3279
3330
  注:`创建和更新场景无需填写。`
3280
- 注意:此字段可能返回 null,表示取不到有效值。
3281
3331
  */
3282
3332
  QuiteJob?: number
3283
3333
  /**
@@ -3293,7 +3343,6 @@ export interface Staff {
3293
3343
  /**
3294
3344
  * 企业微信用户账号ID。
3295
3345
  注:`仅企微类型的企业创建员工接口支持该字段。`
3296
- 注意:此字段可能返回 null,表示取不到有效值。
3297
3346
  */
3298
3347
  WeworkOpenId?: string
3299
3348
  }
@@ -3431,63 +3480,52 @@ export interface OrganizationCommonInfo {
3431
3480
  * 组织机构名称。
3432
3481
  请确认该名称与企业营业执照中注册的名称一致。
3433
3482
  如果名称中包含英文括号(),请使用中文括号()代替。
3434
- 注意:此字段可能返回 null,表示取不到有效值。
3435
3483
  */
3436
3484
  OrganizationName: string
3437
3485
  /**
3438
3486
  * 组织机构企业统一社会信用代码。
3439
3487
  请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
3440
- 注意:此字段可能返回 null,表示取不到有效值。
3441
3488
  */
3442
3489
  UniformSocialCreditCode: string
3443
3490
  /**
3444
3491
  * 组织机构法人的姓名。
3445
3492
  请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
3446
- 注意:此字段可能返回 null,表示取不到有效值。
3447
3493
  */
3448
3494
  LegalName: string
3449
3495
  /**
3450
3496
  * 组织机构法人的证件类型
3451
- 注意:此字段可能返回 null,表示取不到有效值。
3452
3497
  */
3453
3498
  LegalIdCardType?: string
3454
3499
  /**
3455
3500
  * 组织机构法人的证件号码
3456
- 注意:此字段可能返回 null,表示取不到有效值。
3457
3501
  */
3458
3502
  LegalIdCardNumber?: string
3459
3503
  /**
3460
3504
  * 组织机构超管姓名。
3461
3505
 
3462
- 注意:此字段可能返回 null,表示取不到有效值。
3463
3506
  */
3464
3507
  AdminName?: string
3465
3508
  /**
3466
3509
  * 组织机构超管手机号。
3467
3510
 
3468
- 注意:此字段可能返回 null,表示取不到有效值。
3469
3511
  */
3470
3512
  AdminMobile?: string
3471
3513
  /**
3472
3514
  * 组织机构超管证件类型
3473
3515
 
3474
- 注意:此字段可能返回 null,表示取不到有效值。
3475
3516
  */
3476
3517
  AdminIdCardType?: string
3477
3518
  /**
3478
3519
  * 组织机构超管证件号码
3479
3520
 
3480
- 注意:此字段可能返回 null,表示取不到有效值。
3481
3521
  */
3482
3522
  AdminIdCardNumber?: string
3483
3523
  /**
3484
3524
  * 原超管姓名
3485
- 注意:此字段可能返回 null,表示取不到有效值。
3486
3525
  */
3487
3526
  OldAdminName?: string
3488
3527
  /**
3489
3528
  * 原超管手机号
3490
- 注意:此字段可能返回 null,表示取不到有效值。
3491
3529
  */
3492
3530
  OldAdminMobile?: string
3493
3531
  /**
@@ -3548,57 +3586,46 @@ export interface DeleteSealPoliciesResponse {
3548
3586
  export interface Permission {
3549
3587
  /**
3550
3588
  * 权限名称
3551
- 注意:此字段可能返回 null,表示取不到有效值。
3552
3589
  */
3553
3590
  Name?: string
3554
3591
  /**
3555
3592
  * 权限key
3556
- 注意:此字段可能返回 null,表示取不到有效值。
3557
3593
  */
3558
3594
  Key?: string
3559
3595
  /**
3560
3596
  * 权限类型 1前端,2后端
3561
- 注意:此字段可能返回 null,表示取不到有效值。
3562
3597
  */
3563
3598
  Type?: number
3564
3599
  /**
3565
3600
  * 是否隐藏
3566
- 注意:此字段可能返回 null,表示取不到有效值。
3567
3601
  */
3568
3602
  Hide?: number
3569
3603
  /**
3570
3604
  * 数据权限标签 1:表示根节点,2:表示叶子结点
3571
- 注意:此字段可能返回 null,表示取不到有效值。
3572
3605
  */
3573
3606
  DataLabel?: number
3574
3607
  /**
3575
3608
  * 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
3576
- 注意:此字段可能返回 null,表示取不到有效值。
3577
3609
  */
3578
3610
  DataType?: number
3579
3611
  /**
3580
3612
  * 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
3581
- 注意:此字段可能返回 null,表示取不到有效值。
3582
3613
  */
3583
3614
  DataRange?: number
3584
3615
  /**
3585
3616
  * 关联权限, 表示这个功能权限要受哪个数据权限管控
3586
- 注意:此字段可能返回 null,表示取不到有效值。
3587
3617
  */
3588
3618
  DataTo?: string
3589
3619
  /**
3590
3620
  * 父级权限key
3591
- 注意:此字段可能返回 null,表示取不到有效值。
3592
3621
  */
3593
3622
  ParentKey?: string
3594
3623
  /**
3595
3624
  * 是否选中
3596
- 注意:此字段可能返回 null,表示取不到有效值。
3597
3625
  */
3598
3626
  IsChecked?: boolean
3599
3627
  /**
3600
3628
  * 子权限集合
3601
- 注意:此字段可能返回 null,表示取不到有效值。
3602
3629
  */
3603
3630
  Children?: Array<Permission>
3604
3631
  }
@@ -3778,7 +3805,6 @@ export interface OccupiedSeal {
3778
3805
  SealStatus?: string
3779
3806
  /**
3780
3807
  * 审核失败原因
3781
- 注意:此字段可能返回 null,表示取不到有效值。
3782
3808
  */
3783
3809
  FailReason?: string
3784
3810
  /**
@@ -3795,12 +3821,10 @@ export interface OccupiedSeal {
3795
3821
  IsAllTime?: boolean
3796
3822
  /**
3797
3823
  * 授权人列表
3798
- 注意:此字段可能返回 null,表示取不到有效值。
3799
3824
  */
3800
3825
  AuthorizedUsers?: Array<AuthorizedUser>
3801
3826
  /**
3802
3827
  * 印章扩展数据信息
3803
- 注意:此字段可能返回 null,表示取不到有效值。
3804
3828
  */
3805
3829
  ExtendScene?: ExtendScene
3806
3830
  }
@@ -3811,7 +3835,6 @@ export interface OccupiedSeal {
3811
3835
  export interface IntentionActionResultDetail {
3812
3836
  /**
3813
3837
  * 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
3814
- 注意:此字段可能返回 null,表示取不到有效值。
3815
3838
  */
3816
3839
  Video?: string
3817
3840
  }
@@ -3877,12 +3900,10 @@ export interface CreatePersonAuthCertificateImageResponse {
3877
3900
  export interface FailedDeleteStaffData {
3878
3901
  /**
3879
3902
  * 员工在电子签的userId
3880
- 注意:此字段可能返回 null,表示取不到有效值。
3881
3903
  */
3882
3904
  UserId?: string
3883
3905
  /**
3884
3906
  * 员工在第三方平台的openId
3885
- 注意:此字段可能返回 null,表示取不到有效值。
3886
3907
  */
3887
3908
  OpenId?: string
3888
3909
  /**
@@ -3892,69 +3913,17 @@ export interface FailedDeleteStaffData {
3892
3913
  }
3893
3914
 
3894
3915
  /**
3895
- * 合同文件验签单个结果结构体
3916
+ * 转交合同结果
3896
3917
  */
3897
- export interface PdfVerifyResult {
3898
- /**
3899
- * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
3900
- */
3901
- VerifyResult?: number
3902
- /**
3903
- * 签署平台
3904
- 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
3905
- 如果文件不在腾讯电子签平台签署,则为**其他平台**。
3906
- */
3907
- SignPlatform?: string
3908
- /**
3909
- * 申请证书的主体的名字
3910
-
3911
- 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
3912
- **企业**: ESS@企业名称@编码
3913
- **个人**: ESS@个人姓名@证件号@808854
3914
-
3915
- 如果在其他平台签署的, 主体的名字参考其他平台的说明
3916
- */
3917
- SignerName?: string
3918
- /**
3919
- * 签署时间的Unix时间戳,单位毫秒
3920
- */
3921
- SignTime?: number
3922
- /**
3923
- * 证书签名算法, 如SHA1withRSA等算法
3924
- */
3925
- SignAlgorithm?: string
3926
- /**
3927
- * 在数字证书申请过程中,系统会自动生成一个独一无二的序列号。
3928
- */
3929
- CertSn?: string
3930
- /**
3931
- * 证书起始时间的Unix时间戳,单位毫秒
3932
- */
3933
- CertNotBefore?: number
3934
- /**
3935
- * 证书过期时间的时间戳,单位毫秒
3936
- */
3937
- CertNotAfter?: number
3938
- /**
3939
- * 签名域横坐标,单位px
3940
- */
3941
- ComponentPosX?: number
3918
+ export interface FlowForwardResult {
3942
3919
  /**
3943
- * 签名域纵坐标,单位px
3920
+ * 合同流程ID为32位字符串。您可以登录腾讯电子签控制台,在 "合同" -> "合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)。
3944
3921
  */
3945
- ComponentPosY?: number
3946
- /**
3947
- * 签名域宽度,单位px
3948
- */
3949
- ComponentWidth?: number
3950
- /**
3951
- * 签名域高度,单位px
3952
- */
3953
- ComponentHeight?: number
3922
+ FlowId?: string
3954
3923
  /**
3955
- * 签名域所在页码,1~N
3924
+ * 如果失败,返回的错误细节。
3956
3925
  */
3957
- ComponentPage?: number
3926
+ ErrorDetail?: string
3958
3927
  }
3959
3928
 
3960
3929
  /**
@@ -4083,6 +4052,38 @@ export interface CreateSealPolicyResponse {
4083
4052
  RequestId?: string
4084
4053
  }
4085
4054
 
4055
+ /**
4056
+ * DeleteSealPolicies请求参数结构体
4057
+ */
4058
+ export interface DeleteSealPoliciesRequest {
4059
+ /**
4060
+ * 执行本接口操作的员工信息。
4061
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4062
+ */
4063
+ Operator: UserInfo
4064
+ /**
4065
+ * 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
4066
+ */
4067
+ PolicyIds?: Array<string>
4068
+ /**
4069
+ * 电子印章ID,为32位字符串。
4070
+ 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
4071
+ 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
4072
+ 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
4073
+ */
4074
+ SealId?: string
4075
+ /**
4076
+ * 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
4077
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4078
+ */
4079
+ UserIds?: Array<string>
4080
+ /**
4081
+ * 代理企业和员工的信息。
4082
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4083
+ */
4084
+ Agent?: Agent
4085
+ }
4086
+
4086
4087
  /**
4087
4088
  * 签署链接信息。
4088
4089
  */
@@ -4188,35 +4189,23 @@ export interface SuccessDeleteStaffData {
4188
4189
  }
4189
4190
 
4190
4191
  /**
4191
- * DeleteSealPolicies请求参数结构体
4192
+ * CreateEmployeeChangeUrl返回参数结构体
4192
4193
  */
4193
- export interface DeleteSealPoliciesRequest {
4194
+ export interface CreateEmployeeChangeUrlResponse {
4194
4195
  /**
4195
- * 执行本接口操作的员工信息。
4196
- 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4196
+ * 修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a>
4197
4197
  */
4198
- Operator: UserInfo
4199
- /**
4200
- * 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
4201
- */
4202
- PolicyIds?: Array<string>
4203
- /**
4204
- * 电子印章ID,为32位字符串。
4205
- 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
4206
- 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
4207
- 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
4208
- */
4209
- SealId?: string
4198
+ MiniAppPath?: string
4210
4199
  /**
4211
- * 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
4212
- 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4200
+ * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
4201
+
4202
+
4213
4203
  */
4214
- UserIds?: Array<string>
4204
+ ExpireTime?: number
4215
4205
  /**
4216
- * 代理企业和员工的信息。
4217
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4206
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
4218
4207
  */
4219
- Agent?: Agent
4208
+ RequestId?: string
4220
4209
  }
4221
4210
 
4222
4211
  /**
@@ -4628,7 +4617,6 @@ export interface CreateFlowSignUrlResponse {
4628
4617
  export interface RegisterInfo {
4629
4618
  /**
4630
4619
  * 法人姓名
4631
- 注意:此字段可能返回 null,表示取不到有效值。
4632
4620
  */
4633
4621
  LegalName: string
4634
4622
  /**
@@ -4639,7 +4627,6 @@ export interface RegisterInfo {
4639
4627
  Uscc?: string
4640
4628
  /**
4641
4629
  * 社会统一信用代码
4642
- 注意:此字段可能返回 null,表示取不到有效值。
4643
4630
  */
4644
4631
  UnifiedSocialCreditCode?: string
4645
4632
  }
@@ -5217,17 +5204,14 @@ export interface ExtendAuthInfo {
5217
5204
  Status?: string
5218
5205
  /**
5219
5206
  * 操作扩展服务的操作人UserId,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
5220
- 注意:此字段可能返回 null,表示取不到有效值。
5221
5207
  */
5222
5208
  OperatorUserId?: string
5223
5209
  /**
5224
5210
  * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
5225
- 注意:此字段可能返回 null,表示取不到有效值。
5226
5211
  */
5227
5212
  OperateOn?: number
5228
5213
  /**
5229
5214
  * 该扩展服务若可以授权,此参数对应授权人员的列表
5230
- 注意:此字段可能返回 null,表示取不到有效值。
5231
5215
  */
5232
5216
  HasAuthUserList?: Array<HasAuthUser>
5233
5217
  }
@@ -5509,37 +5493,30 @@ export interface ApproverComponentLimitType {
5509
5493
  export interface HasAuthOrganization {
5510
5494
  /**
5511
5495
  * 授权企业id
5512
- 注意:此字段可能返回 null,表示取不到有效值。
5513
5496
  */
5514
5497
  OrganizationId?: string
5515
5498
  /**
5516
5499
  * 授权企业名称
5517
- 注意:此字段可能返回 null,表示取不到有效值。
5518
5500
  */
5519
5501
  OrganizationName?: string
5520
5502
  /**
5521
5503
  * 被授权企业id
5522
- 注意:此字段可能返回 null,表示取不到有效值。
5523
5504
  */
5524
5505
  AuthorizedOrganizationId?: string
5525
5506
  /**
5526
5507
  * 被授权企业名称
5527
- 注意:此字段可能返回 null,表示取不到有效值。
5528
5508
  */
5529
5509
  AuthorizedOrganizationName?: string
5530
5510
  /**
5531
5511
  * 授权模板id(仅当授权方式为模板授权时有值)
5532
- 注意:此字段可能返回 null,表示取不到有效值。
5533
5512
  */
5534
5513
  TemplateId?: string
5535
5514
  /**
5536
5515
  * 授权模板名称(仅当授权方式为模板授权时有值)
5537
- 注意:此字段可能返回 null,表示取不到有效值。
5538
5516
  */
5539
5517
  TemplateName?: string
5540
5518
  /**
5541
5519
  * 授权时间,格式为时间戳,单位s
5542
- 注意:此字段可能返回 null,表示取不到有效值。
5543
5520
  */
5544
5521
  AuthorizeTime?: number
5545
5522
  }
@@ -5550,7 +5527,6 @@ export interface HasAuthOrganization {
5550
5527
  export interface RecipientComponentInfo {
5551
5528
  /**
5552
5529
  * 签署方经办人在合同流程中的参与方ID,与控件绑定,是控件的归属方
5553
- 注意:此字段可能返回 null,表示取不到有效值。
5554
5530
  */
5555
5531
  RecipientId?: string
5556
5532
  /**
@@ -5560,19 +5536,16 @@ export interface RecipientComponentInfo {
5560
5536
  <li>**0**: 未填写, 表示此参与方还没有填写合同的填写控件</li>
5561
5537
  <li>**1**: 已填写, 表示此参与方已经填写所有的填写控件</li></ul>
5562
5538
 
5563
- 注意:此字段可能返回 null,表示取不到有效值。
5564
5539
  */
5565
5540
  RecipientFillStatus?: string
5566
5541
  /**
5567
5542
  * 是否为发起方
5568
5543
  <ul><li>true-发起方</li>
5569
5544
  <li>false-参与方</li></ul>
5570
- 注意:此字段可能返回 null,表示取不到有效值。
5571
5545
  */
5572
5546
  IsPromoter?: boolean
5573
5547
  /**
5574
5548
  * 改参与方填写控件信息列表
5575
- 注意:此字段可能返回 null,表示取不到有效值。
5576
5549
  */
5577
5550
  Components?: Array<FilledComponent>
5578
5551
  }
@@ -5627,7 +5600,6 @@ export interface DetectInfoVideoData {
5627
5600
  * 活体视频的base64编码,mp4格式
5628
5601
 
5629
5602
  注:`需进行base64解码获取活体视频文件`
5630
- 注意:此字段可能返回 null,表示取不到有效值。
5631
5603
  */
5632
5604
  LiveNessVideo?: string
5633
5605
  }
@@ -6355,17 +6327,14 @@ export interface CreateReleaseFlowRequest {
6355
6327
  export interface FillError {
6356
6328
  /**
6357
6329
  * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
6358
- 注意:此字段可能返回 null,表示取不到有效值。
6359
6330
  */
6360
6331
  RecipientId?: string
6361
6332
  /**
6362
6333
  * 补充失败错误说明
6363
- 注意:此字段可能返回 null,表示取不到有效值。
6364
6334
  */
6365
6335
  ErrMessage?: string
6366
6336
  /**
6367
- * 合同流程ID,为32位字符串。
6368
- 注意:此字段可能返回 null,表示取不到有效值。
6337
+ * 合同流程ID,为32位字符串。
6369
6338
  */
6370
6339
  FlowId?: string
6371
6340
  }
@@ -6501,8 +6470,7 @@ export interface FlowDetailInfo {
6501
6470
  */
6502
6471
  FlowName?: string
6503
6472
  /**
6504
- * 合同流程的类别分类(如销售合同/入职合同等)。
6505
- 注意:此字段可能返回 null,表示取不到有效值。
6473
+ * 合同流程的类别分类(如销售合同/入职合同等)。
6506
6474
  */
6507
6475
  FlowType?: string
6508
6476
  /**
@@ -6510,13 +6478,11 @@ export interface FlowDetailInfo {
6510
6478
  */
6511
6479
  FlowStatus?: number
6512
6480
  /**
6513
- * 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
6514
- 注意:此字段可能返回 null,表示取不到有效值。
6481
+ * 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
6515
6482
  */
6516
6483
  FlowMessage?: string
6517
6484
  /**
6518
- * 合同流程描述信息。
6519
- 注意:此字段可能返回 null,表示取不到有效值。
6485
+ * 合同流程描述信息。
6520
6486
  */
6521
6487
  FlowDescription?: string
6522
6488
  /**
@@ -6532,8 +6498,7 @@ export interface FlowDetailInfo {
6532
6498
  */
6533
6499
  CcInfos?: Array<FlowApproverDetail>
6534
6500
  /**
6535
- * 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
6536
- 注意:此字段可能返回 null,表示取不到有效值。
6501
+ * 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
6537
6502
  */
6538
6503
  Creator?: string
6539
6504
  }
@@ -6673,7 +6638,6 @@ export interface SuccessCreateStaffData {
6673
6638
  UserId?: string
6674
6639
  /**
6675
6640
  * 提示,当创建已存在未实名用户时,该字段有值
6676
- 注意:此字段可能返回 null,表示取不到有效值。
6677
6641
  */
6678
6642
  Note?: string
6679
6643
  /**
@@ -6809,36 +6773,34 @@ export interface DescribeFlowEvidenceReportRequest {
6809
6773
  export interface FailedCreateRoleData {
6810
6774
  /**
6811
6775
  * 用户userId
6812
- 注意:此字段可能返回 null,表示取不到有效值。
6813
6776
  */
6814
6777
  UserId?: string
6815
6778
  /**
6816
6779
  * 角色id列表
6817
- 注意:此字段可能返回 null,表示取不到有效值。
6818
6780
  */
6819
6781
  RoleIds?: Array<string>
6820
6782
  }
6821
6783
 
6822
6784
  /**
6823
- * DescribeBillUsage请求参数结构体
6785
+ * CreateEmployeeChangeUrl请求参数结构体
6824
6786
  */
6825
- export interface DescribeBillUsageRequest {
6787
+ export interface CreateEmployeeChangeUrlRequest {
6826
6788
  /**
6827
- * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于90天
6789
+ * 代理企业和员工的信息。<br/>在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6828
6790
  */
6829
- StartTime: string
6791
+ Agent?: Agent
6830
6792
  /**
6831
- * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于90天
6793
+ * 执行本接口操作的员工信息。<br/>注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6832
6794
  */
6833
- EndTime: string
6795
+ Operator?: UserInfo
6834
6796
  /**
6835
- * 查询的套餐类型 (选填 )不传则查询所有套餐;目前支持:<ul><li>**CloudEnterprise**: 企业版合同</li><li>**SingleSignature**: 单方签章</li><li>**CloudProve**: 签署报告</li><li>**CloudOnlineSign**: 腾讯会议在线签约</li><li>**ChannelWeCard**: 微工卡</li><li>**SignFlow**: 合同套餐</li><li>**SignFace**: 签署意愿(人脸识别)</li><li>**SignPassword**: 签署意愿(密码)</li><li>**SignSMS**: 签署意愿(短信)</li><li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li><li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li><li>**OrgEssAuth**: 签署企业实名</li><li>**FlowNotify**: 短信通知</li><li>**AuthService**: 企业工商信息查询</li></ul>
6797
+ * 待修改的员工UserId
6836
6798
  */
6837
- QuotaType?: string
6799
+ UserId?: string
6838
6800
  /**
6839
- * 是否展示集团子企业的明细,默认否
6801
+ * 待修改的员工手机号
6840
6802
  */
6841
- DisplaySubEnterprise?: boolean
6803
+ NewMobile?: string
6842
6804
  }
6843
6805
 
6844
6806
  /**
@@ -6847,17 +6809,14 @@ export interface DescribeBillUsageRequest {
6847
6809
  export interface ExtendScene {
6848
6810
  /**
6849
6811
  * 印章来源类型
6850
- 注意:此字段可能返回 null,表示取不到有效值。
6851
6812
  */
6852
6813
  GenerateType?: string
6853
6814
  /**
6854
6815
  * 印章来源类型描述
6855
- 注意:此字段可能返回 null,表示取不到有效值。
6856
6816
  */
6857
6817
  GenerateTypeDesc?: string
6858
6818
  /**
6859
6819
  * 印章来源logo
6860
- 注意:此字段可能返回 null,表示取不到有效值。
6861
6820
  */
6862
6821
  GenerateTypeLogo?: string
6863
6822
  }
@@ -7172,14 +7131,12 @@ export interface Filter {
7172
7131
  export interface CreateStaffResult {
7173
7132
  /**
7174
7133
  * 创建员工的成功列表
7175
- 注意:此字段可能返回 null,表示取不到有效值。
7176
7134
  */
7177
- SuccessEmployeeData: Array<SuccessCreateStaffData>
7135
+ SuccessEmployeeData?: Array<SuccessCreateStaffData>
7178
7136
  /**
7179
7137
  * 创建员工的失败列表
7180
- 注意:此字段可能返回 null,表示取不到有效值。
7181
7138
  */
7182
- FailedEmployeeData: Array<FailedCreateStaffData>
7139
+ FailedEmployeeData?: Array<FailedCreateStaffData>
7183
7140
  }
7184
7141
 
7185
7142
  /**
@@ -7258,14 +7215,12 @@ export interface DynamicFlowApproverResult {
7258
7215
 
7259
7216
  在进行新增签署方操作时,建议记录下该签署方的角色编号。后续可以拉取流程信息,用来判断该签署方的当前状态。
7260
7217
 
7261
- 注意:此字段可能返回 null,表示取不到有效值。
7262
7218
  */
7263
7219
  RecipientId?: string
7264
7220
  /**
7265
7221
  * 签署方唯一编号,一个全局唯一的标识符,不同的流程不会出现冲突。
7266
7222
 
7267
7223
  可以使用签署方的唯一编号来生成签署链接(也可以通过RecipientId来生成签署链接)。
7268
- 注意:此字段可能返回 null,表示取不到有效值。
7269
7224
  */
7270
7225
  SignId?: string
7271
7226
  /**
@@ -7281,7 +7236,6 @@ export interface DynamicFlowApproverResult {
7281
7236
  10:填写完成
7282
7237
  15:已解除
7283
7238
  19:转他人处理
7284
- 注意:此字段可能返回 null,表示取不到有效值。
7285
7239
  */
7286
7240
  ApproverStatus?: number
7287
7241
  }
@@ -7573,28 +7527,21 @@ export interface ApproverRestriction {
7573
7527
  }
7574
7528
 
7575
7529
  /**
7576
- * CreateWebThemeConfig请求参数结构体
7530
+ * CreateFlowForwards返回参数结构体
7577
7531
  */
7578
- export interface CreateWebThemeConfigRequest {
7532
+ export interface CreateFlowForwardsResponse {
7579
7533
  /**
7580
- * 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
7534
+ * 失败的合同id以及错误详情
7581
7535
  */
7582
- Operator: UserInfo
7536
+ FailedFlows?: Array<FlowForwardResult>
7583
7537
  /**
7584
- * 主题类型,取值如下:
7585
- <ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
7586
- </ul>
7538
+ * 成功的合同id
7587
7539
  */
7588
- ThemeType: string
7540
+ SuccessFlows?: Array<string>
7589
7541
  /**
7590
- * 电子签logo是否展示,主体颜色等配置项
7591
- */
7592
- WebThemeConfig: WebThemeConfig
7593
- /**
7594
- * 代理企业和员工的信息。
7595
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
7542
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
7596
7543
  */
7597
- Agent?: Agent
7544
+ RequestId?: string
7598
7545
  }
7599
7546
 
7600
7547
  /**
@@ -7603,17 +7550,14 @@ export interface CreateWebThemeConfigRequest {
7603
7550
  export interface ApproverItem {
7604
7551
  /**
7605
7552
  * 签署方唯一编号
7606
- 注意:此字段可能返回 null,表示取不到有效值。
7607
7553
  */
7608
7554
  SignId?: string
7609
7555
  /**
7610
7556
  * 签署方角色编号
7611
- 注意:此字段可能返回 null,表示取不到有效值。
7612
7557
  */
7613
7558
  RecipientId?: string
7614
7559
  /**
7615
7560
  * 签署方角色名称
7616
- 注意:此字段可能返回 null,表示取不到有效值。
7617
7561
  */
7618
7562
  ApproverRoleName?: string
7619
7563
  }
@@ -7669,38 +7613,46 @@ UserId必须是传入合同(FlowId)中的签署人。
7669
7613
  RecipientIds?: Array<string>
7670
7614
  }
7671
7615
 
7616
+ /**
7617
+ * 合同转交相关信息
7618
+ */
7619
+ export interface FlowForwardInfo {
7620
+ /**
7621
+ * 合同流程ID,为32位字符串。此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
7622
+ */
7623
+ FlowId: string
7624
+ /**
7625
+ * 签署方经办人在合同中的参与方ID,为32位字符串。
7626
+ */
7627
+ RecipientId: string
7628
+ }
7629
+
7672
7630
  /**
7673
7631
  * 企业角色数据信息
7674
7632
  */
7675
7633
  export interface IntegrateRole {
7676
7634
  /**
7677
7635
  * 角色id
7678
- 注意:此字段可能返回 null,表示取不到有效值。
7679
7636
  */
7680
7637
  RoleId?: string
7681
7638
  /**
7682
7639
  * 角色名
7683
- 注意:此字段可能返回 null,表示取不到有效值。
7684
7640
  */
7685
7641
  RoleName?: string
7686
7642
  /**
7687
7643
  * 角色状态,1-启用,2-禁用
7688
- 注意:此字段可能返回 null,表示取不到有效值。
7689
7644
  */
7690
7645
  RoleStatus?: number
7691
7646
  /**
7692
7647
  * 是否是集团角色,true-是,false-否
7693
- 注意:此字段可能返回 null,表示取不到有效值。
7694
7648
  */
7695
7649
  IsGroupRole?: boolean
7696
7650
  /**
7697
7651
  * 管辖的子企业列表
7698
- 注意:此字段可能返回 null,表示取不到有效值。
7699
7652
  */
7700
7653
  SubOrgIdList?: Array<string>
7701
7654
  /**
7702
7655
  * 权限树
7703
- 注意:此字段可能返回 null,表示取不到有效值。
7704
7656
  */
7705
7657
  PermissionGroups?: Array<PermissionGroup>
7706
7658
  }
@@ -7826,20 +7778,40 @@ export interface SubOrgBillSummary {
7826
7778
  Usage?: Array<SubOrgBillUsage>
7827
7779
  }
7828
7780
 
7781
+ /**
7782
+ * DescribeBillUsage请求参数结构体
7783
+ */
7784
+ export interface DescribeBillUsageRequest {
7785
+ /**
7786
+ * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于90天
7787
+ */
7788
+ StartTime: string
7789
+ /**
7790
+ * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于90天
7791
+ */
7792
+ EndTime: string
7793
+ /**
7794
+ * 查询的套餐类型 (选填 )不传则查询所有套餐;目前支持:<ul><li>**CloudEnterprise**: 企业版合同</li><li>**SingleSignature**: 单方签章</li><li>**CloudProve**: 签署报告</li><li>**CloudOnlineSign**: 腾讯会议在线签约</li><li>**ChannelWeCard**: 微工卡</li><li>**SignFlow**: 合同套餐</li><li>**SignFace**: 签署意愿(人脸识别)</li><li>**SignPassword**: 签署意愿(密码)</li><li>**SignSMS**: 签署意愿(短信)</li><li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li><li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li><li>**OrgEssAuth**: 签署企业实名</li><li>**FlowNotify**: 短信通知</li><li>**AuthService**: 企业工商信息查询</li></ul>
7795
+ */
7796
+ QuotaType?: string
7797
+ /**
7798
+ * 是否展示集团子企业的明细,默认否
7799
+ */
7800
+ DisplaySubEnterprise?: boolean
7801
+ }
7802
+
7829
7803
  /**
7830
7804
  * 删除员工结果
7831
7805
  */
7832
7806
  export interface DeleteStaffsResult {
7833
7807
  /**
7834
7808
  * 删除员工的成功数据
7835
- 注意:此字段可能返回 null,表示取不到有效值。
7836
7809
  */
7837
- SuccessEmployeeData: Array<SuccessDeleteStaffData>
7810
+ SuccessEmployeeData?: Array<SuccessDeleteStaffData>
7838
7811
  /**
7839
7812
  * 删除员工的失败数据
7840
- 注意:此字段可能返回 null,表示取不到有效值。
7841
7813
  */
7842
- FailedEmployeeData: Array<FailedDeleteStaffData>
7814
+ FailedEmployeeData?: Array<FailedDeleteStaffData>
7843
7815
  }
7844
7816
 
7845
7817
  /**
@@ -8355,22 +8327,18 @@ export interface DescribeFileCounterSignResultResponse {
8355
8327
  export interface PermissionGroup {
8356
8328
  /**
8357
8329
  * 权限组名称
8358
- 注意:此字段可能返回 null,表示取不到有效值。
8359
8330
  */
8360
8331
  GroupName?: string
8361
8332
  /**
8362
8333
  * 权限组key
8363
- 注意:此字段可能返回 null,表示取不到有效值。
8364
8334
  */
8365
8335
  GroupKey?: string
8366
8336
  /**
8367
8337
  * 是否隐藏分组,0否1是
8368
- 注意:此字段可能返回 null,表示取不到有效值。
8369
8338
  */
8370
8339
  Hide?: number
8371
8340
  /**
8372
8341
  * 权限集合
8373
- 注意:此字段可能返回 null,表示取不到有效值。
8374
8342
  */
8375
8343
  Permissions?: Array<Permission>
8376
8344
  }
@@ -8694,13 +8662,11 @@ ChildrenComponent结构体定义:
8694
8662
  /**
8695
8663
  * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
8696
8664
  注意: `向左调整设置为负数, 向右调整设置成正数`
8697
- 注意:此字段可能返回 null,表示取不到有效值。
8698
8665
  */
8699
8666
  OffsetX?: number
8700
8667
  /**
8701
8668
  * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
8702
8669
  注意: `向上调整设置为负数, 向下调整设置成正数`
8703
- 注意:此字段可能返回 null,表示取不到有效值。
8704
8670
  */
8705
8671
  OffsetY?: number
8706
8672
  /**
@@ -8735,14 +8701,12 @@ ChildrenComponent结构体定义:
8735
8701
  * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
8736
8702
  <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
8737
8703
  <li>true:锁定控件值,在页面编辑控件值</li></ul>
8738
- 注意:此字段可能返回 null,表示取不到有效值。
8739
8704
  */
8740
8705
  LockComponentValue?: boolean
8741
8706
  /**
8742
8707
  * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
8743
8708
  <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
8744
8709
  <li> <b>true</b> : 可以移动和删除控件</li></ul>
8745
- 注意:此字段可能返回 null,表示取不到有效值。
8746
8710
  */
8747
8711
  ForbidMoveAndDelete?: boolean
8748
8712
  /**
@@ -8767,27 +8731,22 @@ ChildrenComponent结构体定义:
8767
8731
  export interface IntegrationDepartment {
8768
8732
  /**
8769
8733
  * 部门ID。
8770
- 注意:此字段可能返回 null,表示取不到有效值。
8771
8734
  */
8772
8735
  DeptId?: string
8773
8736
  /**
8774
8737
  * 部门名。
8775
- 注意:此字段可能返回 null,表示取不到有效值。
8776
8738
  */
8777
8739
  DeptName?: string
8778
8740
  /**
8779
8741
  * 父部门ID
8780
- 注意:此字段可能返回 null,表示取不到有效值。
8781
8742
  */
8782
8743
  ParentDeptId?: string
8783
8744
  /**
8784
8745
  * 客户系统部门ID
8785
- 注意:此字段可能返回 null,表示取不到有效值。
8786
8746
  */
8787
8747
  DeptOpenId?: string
8788
8748
  /**
8789
8749
  * 序列号。
8790
- 注意:此字段可能返回 null,表示取不到有效值。
8791
8750
  */
8792
8751
  OrderNo?: number
8793
8752
  }
@@ -9042,13 +9001,11 @@ export interface UpdateIntegrationEmployeesRequest {
9042
9001
  */
9043
9002
  export interface FlowGroupApprovers {
9044
9003
  /**
9045
- * 合同流程ID
9046
- 注意:此字段可能返回 null,表示取不到有效值。
9004
+ * 合同流程ID
9047
9005
  */
9048
9006
  FlowId?: string
9049
9007
  /**
9050
9008
  * 签署方信息,包含合同ID和角色ID用于定位RecipientId。
9051
- 注意:此字段可能返回 null,表示取不到有效值。
9052
9009
  */
9053
9010
  Approvers?: Array<ApproverItem>
9054
9011
  }
@@ -9459,14 +9416,12 @@ export interface DescribeBillUsageDetailRequest {
9459
9416
  export interface Admin {
9460
9417
  /**
9461
9418
  * 超管名
9462
- 注意:此字段可能返回 null,表示取不到有效值。
9463
9419
  */
9464
9420
  Name?: string
9465
9421
  /**
9466
9422
  * 超管手机号,打码显示
9467
9423
  示例值:138****1569
9468
9424
 
9469
- 注意:此字段可能返回 null,表示取不到有效值。
9470
9425
  */
9471
9426
  Mobile?: string
9472
9427
  }
@@ -9707,17 +9662,14 @@ export interface RelieveInfo {
9707
9662
  export interface UserFlowType {
9708
9663
  /**
9709
9664
  * 合同类型ID
9710
- 注意:此字段可能返回 null,表示取不到有效值。
9711
9665
  */
9712
9666
  UserFlowTypeId?: string
9713
9667
  /**
9714
9668
  * 合同类型名称
9715
- 注意:此字段可能返回 null,表示取不到有效值。
9716
9669
  */
9717
9670
  Name?: string
9718
9671
  /**
9719
9672
  * 合同类型说明
9720
- 注意:此字段可能返回 null,表示取不到有效值。
9721
9673
  */
9722
9674
  Description?: string
9723
9675
  }
@@ -10248,7 +10200,6 @@ export interface FileUrl {
10248
10200
  Url: string
10249
10201
  /**
10250
10202
  * 下载文件的附加信息。如果是pdf文件,会返回pdf文件每页的有效高宽
10251
- 注意:此字段可能返回 null,表示取不到有效值。
10252
10203
  */
10253
10204
  Option: string
10254
10205
  }