tencentcloud-sdk-nodejs 4.0.689 → 4.0.690

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 (50) hide show
  1. package/CHANGELOG.md +225 -0
  2. package/SERVICE_CHANGELOG.md +309 -135
  3. package/package.json +1 -1
  4. package/products.md +16 -16
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/batch/v20170312/batch_models.ts +0 -4
  7. package/src/services/bi/v20220105/bi_models.ts +18 -0
  8. package/src/services/cynosdb/v20190107/cynosdb_models.ts +24 -14
  9. package/src/services/dlc/v20210125/dlc_client.ts +28 -5
  10. package/src/services/dlc/v20210125/dlc_models.ts +679 -221
  11. package/src/services/ess/v20201111/ess_client.ts +20 -17
  12. package/src/services/ess/v20201111/ess_models.ts +163 -106
  13. package/src/services/facefusion/v20220927/facefusion_models.ts +5 -1
  14. package/src/services/iss/v20230517/iss_models.ts +3 -3
  15. package/src/services/live/v20180801/live_models.ts +32 -27
  16. package/src/services/rce/v20201103/rce_models.ts +42 -11
  17. package/src/services/tat/v20201028/tat_models.ts +30 -9
  18. package/src/services/tse/v20201207/tse_client.ts +82 -18
  19. package/src/services/tse/v20201207/tse_models.ts +543 -270
  20. package/src/services/vod/v20180717/vod_models.ts +4 -3
  21. package/src/services/vpc/v20170312/vpc_models.ts +4 -0
  22. package/src/services/waf/v20180125/waf_client.ts +51 -3
  23. package/src/services/waf/v20180125/waf_models.ts +171 -38
  24. package/tencentcloud/common/sdk_version.d.ts +1 -1
  25. package/tencentcloud/common/sdk_version.js +1 -1
  26. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +0 -4
  27. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +18 -0
  28. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +24 -14
  29. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  30. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  31. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +663 -218
  32. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +17 -14
  33. package/tencentcloud/services/ess/v20201111/ess_client.js +17 -14
  34. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +163 -106
  35. package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +5 -1
  36. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +3 -3
  37. package/tencentcloud/services/live/v20180801/live_models.d.ts +32 -27
  38. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +42 -11
  39. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +30 -9
  40. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +25 -5
  41. package/tencentcloud/services/tse/v20201207/tse_client.js +36 -6
  42. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +531 -272
  43. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +4 -3
  44. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +4 -0
  45. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +18 -2
  46. package/tencentcloud/services/waf/v20180125/waf_client.js +25 -1
  47. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +163 -38
  48. package/test/dlc.v20210125.test.js +10 -0
  49. package/test/tse.v20201207.test.js +54 -4
  50. package/test/waf.v20180125.test.js +40 -0
@@ -143,15 +143,15 @@ export interface UpdateIntegrationEmployeesResponse {
143
143
  RequestId?: string;
144
144
  }
145
145
  /**
146
- * 集成版员工部门信息
146
+ * 集成版员工部门信息。
147
147
  */
148
148
  export interface Department {
149
149
  /**
150
- * 部门id
150
+ * 部门ID。
151
151
  */
152
152
  DepartmentId?: string;
153
153
  /**
154
- * 部门名称
154
+ * 部门名称。
155
155
  */
156
156
  DepartmentName?: string;
157
157
  }
@@ -239,7 +239,7 @@ export interface CreatePreparedPersonalEsignRequest {
239
239
  */
240
240
  export interface DescribeIntegrationDepartmentsResponse {
241
241
  /**
242
- * 部门列表
242
+ * 部门信息列表。部门信息根据部门排序号OrderNo降序排列,根据部门创建时间升序排列。
243
243
  */
244
244
  Departments?: Array<IntegrationDepartment>;
245
245
  /**
@@ -404,7 +404,8 @@ export interface CancelUserAutoSignEnableUrlResponse {
404
404
  */
405
405
  export interface BindEmployeeUserIdWithClientOpenIdResponse {
406
406
  /**
407
- * 绑定是否成功,1表示成功,0表示失败
407
+ * 绑定是否成功。
408
+ <ul><li>**0**:失败</li><li>**1**:成功</li></ul>
408
409
  */
409
410
  Status?: number;
410
411
  /**
@@ -417,17 +418,19 @@ export interface BindEmployeeUserIdWithClientOpenIdResponse {
417
418
  */
418
419
  export interface CreateIntegrationEmployeesRequest {
419
420
  /**
420
- * 操作人信息,userId必填
421
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
422
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
421
423
  */
422
424
  Operator: UserInfo;
423
425
  /**
424
- * 待创建员工的信息,不超过20个。
425
- 所有类型的企业支持的入参:Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
426
- 企微类型的企业特有支持的入参:WeworkOpenId,传入此字段无需在传入其他信息
426
+ * 待创建员工的信息,最多不超过20个。
427
+ 其中入参Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持设置。
428
+ 在创建企微企业员工场景下,只需传入WeworkOpenId,无需再传其他信息。
427
429
  */
428
430
  Employees: Array<Staff>;
429
431
  /**
430
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
432
+ * 代理企业和员工的信息。
433
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
431
434
  */
432
435
  Agent?: Agent;
433
436
  }
@@ -635,16 +638,16 @@ export interface SealInfo {
635
638
  SealName?: string;
636
639
  }
637
640
  /**
638
- * 集成版企业角色信息
641
+ * 集成版企业角色信息。
639
642
  */
640
643
  export interface StaffRole {
641
644
  /**
642
- * 角色id
645
+ * 角色ID。
643
646
  注意:此字段可能返回 null,表示取不到有效值。
644
647
  */
645
648
  RoleId?: string;
646
649
  /**
647
- * 角色名称
650
+ * 角色名称。
648
651
  注意:此字段可能返回 null,表示取不到有效值。
649
652
  */
650
653
  RoleName?: string;
@@ -747,7 +750,9 @@ export interface CreateConvertTaskApiRequest {
747
750
  */
748
751
  export interface DeleteIntegrationEmployeesResponse {
749
752
  /**
750
- * 员工删除数据
753
+ * 员工删除结果。包含成功数据与失败数据。
754
+ <ul><li>**成功数据**:展示员工姓名、手机号与电子签平台UserId</li>
755
+ <li>**失败数据**:展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
751
756
  */
752
757
  DeleteEmployeeResult?: DeleteStaffsResult;
753
758
  /**
@@ -773,15 +778,16 @@ export interface CreateFlowRemindsResponse {
773
778
  */
774
779
  export interface DescribeOrganizationGroupOrganizationsRequest {
775
780
  /**
776
- * 操作人信息,userId必填
781
+ * 执行本接口操作的员工信息,userId必填。
782
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
777
783
  */
778
784
  Operator: UserInfo;
779
785
  /**
780
- * 指定每页多少条数据,单页最大1000
786
+ * 指定分页每页返回的数据条数,单页最大1000
781
787
  */
782
788
  Limit: number;
783
789
  /**
784
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0
790
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
785
791
  */
786
792
  Offset: number;
787
793
  /**
@@ -789,15 +795,23 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
789
795
  */
790
796
  Name?: string;
791
797
  /**
792
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
798
+ * 成员企业加入集团的当前状态
799
+ <ul><li> **1**:待授权</li>
800
+ <li> **2**:已授权待激活</li>
801
+ <li> **3**:拒绝授权</li>
802
+ <li> **4**:已解除</li>
803
+ <li> **5**:已加入</li>
804
+ </ul>
793
805
  */
794
806
  Status?: number;
795
807
  /**
796
808
  * 是否导出当前成员企业数据
809
+ <ul><li> **false**:不导出(默认值)</li>
810
+ <li> **true**:导出</li></ul>
797
811
  */
798
812
  Export?: boolean;
799
813
  /**
800
- * 成员企业机构 ID,在PC控制台 集团管理可获取
814
+ * 成员企业机构 ID,32 位字符串,在PC控制台 集团管理可获取
801
815
  */
802
816
  Id?: string;
803
817
  }
@@ -1163,26 +1177,33 @@ export interface CreateDocumentResponse {
1163
1177
  */
1164
1178
  export interface DescribeIntegrationEmployeesRequest {
1165
1179
  /**
1166
- * 操作人信息,userId必填
1180
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
1181
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1167
1182
  */
1168
1183
  Operator: UserInfo;
1169
1184
  /**
1170
- * 指定每页多少条数据,单页最大20
1185
+ * 指定分页每页返回的数据条数,单页最大支持 20
1171
1186
  */
1172
1187
  Limit: number;
1173
1188
  /**
1174
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1189
+ * 代理企业和员工的信息。
1190
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1175
1191
  */
1176
1192
  Agent?: Agent;
1177
1193
  /**
1178
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
1179
- 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
1180
- 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
1181
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1194
+ * 查询的关键字段,支持Key-Values查询。可选键值如下:
1195
+ <ul>
1196
+ <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
1197
+ <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["NotVerified"]**:查询未实名的员工</li></ul></li>
1198
+ <li>Key:**"DepartmentId"**,根据部门ID查询部门下的员工,Values为指定的部门ID:**["DepartmentId"]**</li>
1199
+ <li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
1200
+ <li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
1201
+ <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
1202
+ </ul>
1182
1203
  */
1183
1204
  Filters?: Array<Filter>;
1184
1205
  /**
1185
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
1206
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
1186
1207
  */
1187
1208
  Offset?: number;
1188
1209
  }
@@ -1469,7 +1490,9 @@ export interface DescribeThirdPartyAuthCodeRequest {
1469
1490
  */
1470
1491
  export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1471
1492
  /**
1472
- * 解绑是否成功,1表示成功,0表示失败
1493
+ * 解绑是否成功。
1494
+ <ul><li> **0**:失败 </li>
1495
+ <li> **1**:成功 </li></ul>
1473
1496
  */
1474
1497
  Status?: number;
1475
1498
  /**
@@ -1506,19 +1529,22 @@ export interface CreateWebThemeConfigResponse {
1506
1529
  */
1507
1530
  export interface BindEmployeeUserIdWithClientOpenIdRequest {
1508
1531
  /**
1509
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定。(参数参考示例)
1532
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
1533
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1510
1534
  */
1511
1535
  Operator: UserInfo;
1512
1536
  /**
1513
- * 电子签系统员工UserId
1537
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
1538
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID);或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
1514
1539
  */
1515
1540
  UserId: string;
1516
1541
  /**
1517
- * 客户系统OpenId
1542
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
1518
1543
  */
1519
1544
  OpenId: string;
1520
1545
  /**
1521
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1546
+ * 代理企业和员工的信息。
1547
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1522
1548
  */
1523
1549
  Agent?: Agent;
1524
1550
  }
@@ -1532,7 +1558,9 @@ export interface DescribeIntegrationDepartmentsRequest {
1532
1558
  */
1533
1559
  Operator: UserInfo;
1534
1560
  /**
1535
- * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
1561
+ * 查询类型,支持以下类型:
1562
+ <ul><li>**0**:查询单个部门节点列表,不包含子节点部门信息</li>
1563
+ <li>**1**:查询单个部门节点级一级子节点部门信息列表</li></ul>
1536
1564
  */
1537
1565
  QueryType: number;
1538
1566
  /**
@@ -1541,11 +1569,13 @@ export interface DescribeIntegrationDepartmentsRequest {
1541
1569
  */
1542
1570
  Agent?: Agent;
1543
1571
  /**
1544
- * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
1572
+ * 查询的部门ID
1573
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1545
1574
  */
1546
1575
  DeptId?: string;
1547
1576
  /**
1548
- * 客户系统部门ID,与DeptId二选一,优先DeptId,都为空时获取根节点数据
1577
+ * 查询的客户系统部门ID
1578
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1549
1579
  */
1550
1580
  DeptOpenId?: string;
1551
1581
  }
@@ -1642,7 +1672,7 @@ export interface ComponentLimit {
1642
1672
  */
1643
1673
  export interface CreateIntegrationDepartmentResponse {
1644
1674
  /**
1645
- * 电子签部门ID
1675
+ * 电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。
1646
1676
  */
1647
1677
  DeptId?: string;
1648
1678
  /**
@@ -2087,21 +2117,21 @@ export interface DisableUserAutoSignRequest {
2087
2117
  */
2088
2118
  export interface DescribeIntegrationEmployeesResponse {
2089
2119
  /**
2090
- * 员工数据列表
2120
+ * 员工信息列表。
2091
2121
  注意:此字段可能返回 null,表示取不到有效值。
2092
2122
  */
2093
2123
  Employees?: Array<Staff>;
2094
2124
  /**
2095
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
2125
+ * 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
2096
2126
  注意:此字段可能返回 null,表示取不到有效值。
2097
2127
  */
2098
2128
  Offset?: number;
2099
2129
  /**
2100
- * 指定每页多少条数据,单页最大20
2130
+ * 指定分页每页返回的数据条数,单页最大支持 20
2101
2131
  */
2102
2132
  Limit?: number;
2103
2133
  /**
2104
- * 符合条件的员工数量
2134
+ * 符合条件的员工数量。
2105
2135
  */
2106
2136
  TotalCount?: number;
2107
2137
  /**
@@ -2188,19 +2218,23 @@ export interface CreateFlowSignReviewRequest {
2188
2218
  */
2189
2219
  export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
2190
2220
  /**
2191
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定(参数用法参考示例)
2221
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
2222
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2192
2223
  */
2193
2224
  Operator: UserInfo;
2194
2225
  /**
2195
- * 电子签系统员工UserId
2226
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2227
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
2196
2228
  */
2197
2229
  UserId: string;
2198
2230
  /**
2199
- * 客户系统OpenId
2231
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
2232
+ 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
2200
2233
  */
2201
2234
  OpenId: string;
2202
2235
  /**
2203
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2236
+ * 代理企业和员工的信息。
2237
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2204
2238
  */
2205
2239
  Agent?: Agent;
2206
2240
  }
@@ -2903,78 +2937,80 @@ export interface FlowCreateApprover {
2903
2937
  ApproverSignTypes?: Array<number | bigint>;
2904
2938
  }
2905
2939
  /**
2906
- * 企业员工信息
2940
+ * 企业员工信息。
2907
2941
  */
2908
2942
  export interface Staff {
2909
2943
  /**
2910
- * 用户在电子签平台的id
2911
- 注:创建和更新场景无需填写
2944
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2945
+ 注:`创建和更新场景无需填写。`
2912
2946
  */
2913
2947
  UserId?: string;
2914
2948
  /**
2915
- * 显示的用户名/昵称
2949
+ * 显示的用户名/昵称。
2916
2950
  */
2917
2951
  DisplayName?: string;
2918
2952
  /**
2919
- * 用户手机号
2953
+ * 用户手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
2920
2954
  */
2921
2955
  Mobile?: string;
2922
2956
  /**
2923
- * 用户邮箱
2957
+ * 用户邮箱。
2924
2958
  注意:此字段可能返回 null,表示取不到有效值。
2925
2959
  */
2926
2960
  Email?: string;
2927
2961
  /**
2928
- * 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
2962
+ * 用户在第三方平台ID。
2963
+ 注:`如需在此接口提醒员工实名,该参数不传。`
2929
2964
  注意:此字段可能返回 null,表示取不到有效值。
2930
2965
  */
2931
2966
  OpenId?: string;
2932
2967
  /**
2933
- * 员工角色
2934
- 注:创建和更新场景无需填写
2968
+ * 员工角色信息。
2969
+ 注:`创建和更新场景无需填写。`
2935
2970
  注意:此字段可能返回 null,表示取不到有效值。
2936
2971
  */
2937
2972
  Roles?: Array<StaffRole>;
2938
2973
  /**
2939
- * 员工部门
2974
+ * 员工部门信息。
2940
2975
  注意:此字段可能返回 null,表示取不到有效值。
2941
2976
  */
2942
2977
  Department?: Department;
2943
2978
  /**
2944
- * 员工是否实名
2945
- 注:创建和更新场景无需填写
2979
+ * 员工是否实名。
2980
+ 注:`创建和更新场景无需填写。`
2946
2981
  */
2947
2982
  Verified?: boolean;
2948
2983
  /**
2949
- * 员工创建时间戳,单位秒
2950
- 注:创建和更新场景无需填写
2984
+ * 员工创建时间戳,单位秒。
2985
+ 注:`创建和更新场景无需填写。`
2951
2986
  */
2952
2987
  CreatedOn?: number;
2953
2988
  /**
2954
- * 员工实名时间戳,单位秒
2955
- 注:创建和更新场景无需填写
2989
+ * 员工实名时间戳,单位秒。
2990
+ 注:`创建和更新场景无需填写。`
2956
2991
  注意:此字段可能返回 null,表示取不到有效值。
2957
2992
  */
2958
2993
  VerifiedOn?: number;
2959
2994
  /**
2960
- * 员工是否离职:0-未离职,1-离职
2961
- 注:创建和更新场景无需填写
2995
+ * 员工是否离职:
2996
+ <ul><li>**0**:未离职</li><li>**1**:离职</li></ul>
2997
+ 注:`创建和更新场景无需填写。`
2962
2998
  注意:此字段可能返回 null,表示取不到有效值。
2963
2999
  */
2964
3000
  QuiteJob?: number;
2965
3001
  /**
2966
- * 员工离职交接人用户id
2967
- 注:创建和更新场景无需填写
3002
+ * 员工离职交接人用户ID。
3003
+ 注:`创建和更新场景无需填写。`
2968
3004
  */
2969
3005
  ReceiveUserId?: string;
2970
3006
  /**
2971
- * 员工离职交接人用户OpenId
2972
- 注:创建和更新场景无需填写
3007
+ * 员工离职交接人用户OpenId
3008
+ 注:`创建和更新场景无需填写。`
2973
3009
  */
2974
3010
  ReceiveOpenId?: string;
2975
3011
  /**
2976
- * 企业微信用户账号ID
2977
- 注:仅企微类型的企业创建员工接口支持该字段
3012
+ * 企业微信用户账号ID
3013
+ 注:`仅企微类型的企业创建员工接口支持该字段。`
2978
3014
  注意:此字段可能返回 null,表示取不到有效值。
2979
3015
  */
2980
3016
  WeworkOpenId?: string;
@@ -3075,28 +3111,29 @@ export interface CreateIntegrationDepartmentRequest {
3075
3111
  */
3076
3112
  Operator: UserInfo;
3077
3113
  /**
3078
- * 部门名称,不超过50个字符
3114
+ * 部门名称,最大长度为50个字符。
3079
3115
  */
3080
3116
  DeptName: string;
3081
3117
  /**
3082
- * 代理企业和员工的信息。
3083
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3118
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3084
3119
  */
3085
3120
  Agent?: Agent;
3086
3121
  /**
3087
- * 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3122
+ * 电子签父部门ID
3123
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3088
3124
  */
3089
3125
  ParentDeptId?: string;
3090
3126
  /**
3091
- * 第三方平台中父部门ID,与ParentDeptId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3127
+ * 第三方平台中父部门ID
3128
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3092
3129
  */
3093
3130
  ParentDeptOpenId?: string;
3094
3131
  /**
3095
- * 客户系统部门ID,不超过64个字符
3132
+ * 客户系统部门ID,最大长度为64个字符。
3096
3133
  */
3097
3134
  DeptOpenId?: string;
3098
3135
  /**
3099
- * 排序号,1~30000范围内
3136
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
3100
3137
  */
3101
3138
  OrderNo?: number;
3102
3139
  }
@@ -3115,17 +3152,24 @@ export interface GroupOrganization {
3115
3152
  */
3116
3153
  Alias?: string;
3117
3154
  /**
3118
- * 成员企业id
3155
+ * 成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取
3119
3156
  注意:此字段可能返回 null,表示取不到有效值。
3120
3157
  */
3121
3158
  OrganizationId?: string;
3122
3159
  /**
3123
- * 更新时间,时间戳,单位秒
3160
+ * 记录更新时间, unix时间戳,单位秒
3124
3161
  注意:此字段可能返回 null,表示取不到有效值。
3125
3162
  */
3126
3163
  UpdateTime?: number;
3127
3164
  /**
3128
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
3165
+ * 成员企业加入集团的当前状态
3166
+ <ul><li> **1**:待授权</li>
3167
+ <li> **2**:已授权待激活</li>
3168
+ <li> **3**:拒绝授权</li>
3169
+ <li> **4**:已解除</li>
3170
+ <li> **5**:已加入</li>
3171
+ </ul>
3172
+
3129
3173
  注意:此字段可能返回 null,表示取不到有效值。
3130
3174
  */
3131
3175
  Status?: number;
@@ -3145,22 +3189,24 @@ export interface GroupOrganization {
3145
3189
  */
3146
3190
  AdminInfo?: Admin;
3147
3191
  /**
3148
- * 企业许可证
3192
+ * 企业许可证Id,此字段暂时不需要关注
3149
3193
  注意:此字段可能返回 null,表示取不到有效值。
3150
3194
  */
3151
3195
  License?: string;
3152
3196
  /**
3153
- * 企业许可证过期时间,时间戳,单位秒
3197
+ * 企业许可证过期时间,unix时间戳,单位秒
3154
3198
  注意:此字段可能返回 null,表示取不到有效值。
3155
3199
  */
3156
3200
  LicenseExpireTime?: number;
3157
3201
  /**
3158
- * 成员企业加入集团时间,时间戳,单位秒
3202
+ * 成员企业加入集团时间,unix时间戳,单位秒
3159
3203
  注意:此字段可能返回 null,表示取不到有效值。
3160
3204
  */
3161
3205
  JoinTime?: number;
3162
3206
  /**
3163
- * 是否使用自建审批流引擎(即不是企微审批流引擎),true-是,false-否
3207
+ * 是否使用自建审批流引擎(即不是企微审批流引擎)
3208
+ <ul><li> **true**:是</li>
3209
+ <li> **false**:否</li></ul>
3164
3210
  注意:此字段可能返回 null,表示取不到有效值。
3165
3211
  */
3166
3212
  FlowEngineEnable?: boolean;
@@ -3325,15 +3371,19 @@ export interface CreateEmbedWebUrlRequest {
3325
3371
  */
3326
3372
  export interface DeleteIntegrationEmployeesRequest {
3327
3373
  /**
3328
- * 操作人信息,userId必填
3374
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
3375
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3329
3376
  */
3330
3377
  Operator: UserInfo;
3331
3378
  /**
3332
- * 待移除员工的信息,userId和openId二选一,必填一个,如果需要指定交接人的话,ReceiveUserId或者ReceiveOpenId字段二选一
3379
+ * 待移除员工的信息。应符合以下规则:
3380
+ <ul><li>UserId和OpenId不可同时为空。</li>
3381
+ <li>若需要进行离职交接,交接人信息ReceiveUserId和ReceiveOpenId不可同时为空。否则视为不进行离职交接。</li></ul>
3333
3382
  */
3334
3383
  Employees: Array<Staff>;
3335
3384
  /**
3336
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
3385
+ * 代理企业和员工的信息。
3386
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3337
3387
  */
3338
3388
  Agent?: Agent;
3339
3389
  }
@@ -3346,7 +3396,7 @@ export interface FailedUpdateStaffData {
3346
3396
  */
3347
3397
  DisplayName?: string;
3348
3398
  /**
3349
- * 用户传入的手机号
3399
+ * 用户传入的手机号,明文展示
3350
3400
  */
3351
3401
  Mobile?: string;
3352
3402
  /**
@@ -3354,7 +3404,8 @@ export interface FailedUpdateStaffData {
3354
3404
  */
3355
3405
  Reason?: string;
3356
3406
  /**
3357
- * 用户Id
3407
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3408
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3358
3409
  */
3359
3410
  UserId?: string;
3360
3411
  /**
@@ -3469,7 +3520,7 @@ export interface CreateFlowGroupByFilesResponse {
3469
3520
  */
3470
3521
  export interface CreateIntegrationEmployeesResponse {
3471
3522
  /**
3472
- * 创建员工的结果
3523
+ * 创建员工的结果。包含创建成功的数据与创建失败数据。
3473
3524
  */
3474
3525
  CreateEmployeeResult?: CreateStaffResult;
3475
3526
  /**
@@ -3819,11 +3870,12 @@ export interface SuccessUpdateStaffData {
3819
3870
  */
3820
3871
  DisplayName?: string;
3821
3872
  /**
3822
- * 传入的手机号
3873
+ * 传入的手机号,没有打码
3823
3874
  */
3824
3875
  Mobile?: string;
3825
3876
  /**
3826
- * 用户Id
3877
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3878
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3827
3879
  */
3828
3880
  UserId?: string;
3829
3881
  }
@@ -4188,7 +4240,7 @@ export interface ModifyIntegrationDepartmentRequest {
4188
4240
  */
4189
4241
  Operator: UserInfo;
4190
4242
  /**
4191
- * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
4243
+ * 电子签部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4192
4244
  */
4193
4245
  DeptId: string;
4194
4246
  /**
@@ -4197,19 +4249,19 @@ export interface ModifyIntegrationDepartmentRequest {
4197
4249
  */
4198
4250
  Agent?: Agent;
4199
4251
  /**
4200
- * 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
4252
+ * 电子签父部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4201
4253
  */
4202
4254
  ParentDeptId?: string;
4203
4255
  /**
4204
- * 部门名称,不超过50个字符
4256
+ * 部门名称,最大长度为50个字符。
4205
4257
  */
4206
4258
  DeptName?: string;
4207
4259
  /**
4208
- * 客户系统部门ID,不超过64个字符
4260
+ * 客户系统部门ID,最大长度为64个字符。
4209
4261
  */
4210
4262
  DeptOpenId?: string;
4211
4263
  /**
4212
- * 排序号,1~30000范围内
4264
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
4213
4265
  */
4214
4266
  OrderNo?: number;
4215
4267
  }
@@ -4598,7 +4650,7 @@ export interface DeleteIntegrationDepartmentRequest {
4598
4650
  */
4599
4651
  Operator: UserInfo;
4600
4652
  /**
4601
- * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
4653
+ * 电子签中的部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口可获得。
4602
4654
  */
4603
4655
  DeptId: string;
4604
4656
  /**
@@ -4607,7 +4659,8 @@ export interface DeleteIntegrationDepartmentRequest {
4607
4659
  */
4608
4660
  Agent?: Agent;
4609
4661
  /**
4610
- * 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
4662
+ * 交接部门ID
4663
+ 待删除部门中的合同、印章和模板数据,将会被交接至该部门ID下;若未填写则交接至公司根部门。
4611
4664
  */
4612
4665
  ReceiveDeptId?: string;
4613
4666
  }
@@ -5236,12 +5289,12 @@ export interface Component {
5236
5289
  */
5237
5290
  export interface IntegrationDepartment {
5238
5291
  /**
5239
- * 部门ID
5292
+ * 部门ID
5240
5293
  注意:此字段可能返回 null,表示取不到有效值。
5241
5294
  */
5242
5295
  DeptId?: string;
5243
5296
  /**
5244
- * 部门名
5297
+ * 部门名。
5245
5298
  注意:此字段可能返回 null,表示取不到有效值。
5246
5299
  */
5247
5300
  DeptName?: string;
@@ -5256,7 +5309,7 @@ export interface IntegrationDepartment {
5256
5309
  */
5257
5310
  DeptOpenId?: string;
5258
5311
  /**
5259
- * 序列号
5312
+ * 序列号。
5260
5313
  注意:此字段可能返回 null,表示取不到有效值。
5261
5314
  */
5262
5315
  OrderNo?: number;
@@ -5336,7 +5389,8 @@ export interface CreateFlowRemindsRequest {
5336
5389
  */
5337
5390
  export interface UpdateIntegrationEmployeesRequest {
5338
5391
  /**
5339
- * 当前用户信息,UserId必填
5392
+ * 执行本接口操作的员工信息,UserId必填。
5393
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5340
5394
  */
5341
5395
  Operator: UserInfo;
5342
5396
  /**
@@ -5346,7 +5400,8 @@ export interface UpdateIntegrationEmployeesRequest {
5346
5400
  */
5347
5401
  Employees: Array<Staff>;
5348
5402
  /**
5349
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
5403
+ * 代理企业和员工的信息。
5404
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5350
5405
  */
5351
5406
  Agent?: Agent;
5352
5407
  }
@@ -5484,7 +5539,9 @@ export interface Admin {
5484
5539
  */
5485
5540
  Name?: string;
5486
5541
  /**
5487
- * 超管手机号
5542
+ * 超管手机号,打码显示
5543
+ 示例值:138****1569
5544
+
5488
5545
  注意:此字段可能返回 null,表示取不到有效值。
5489
5546
  */
5490
5547
  Mobile?: string;
@@ -5952,12 +6009,12 @@ export interface FlowBrief {
5952
6009
  */
5953
6010
  export interface DescribeOrganizationGroupOrganizationsResponse {
5954
6011
  /**
5955
- * 查询到的符合条件的成员企业总数量
6012
+ * 符合查询条件的资源实例总数量。
5956
6013
  注意:此字段可能返回 null,表示取不到有效值。
5957
6014
  */
5958
6015
  Total?: number;
5959
6016
  /**
5960
- * 已授权待激活的企业数量
6017
+ * 已授权待激活的子企业总数量
5961
6018
  注意:此字段可能返回 null,表示取不到有效值。
5962
6019
  */
5963
6020
  JoinedTotal?: number;
@@ -5978,7 +6035,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
5978
6035
  */
5979
6036
  List?: Array<GroupOrganization>;
5980
6037
  /**
5981
- * 已加入的企业数量
6038
+ * 已加入的子企业总数量
5982
6039
  注意:此字段可能返回 null,表示取不到有效值。
5983
6040
  */
5984
6041
  ActivatedTotal?: number;