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
@@ -165,15 +165,15 @@ export interface UpdateIntegrationEmployeesResponse {
165
165
  }
166
166
 
167
167
  /**
168
- * 集成版员工部门信息
168
+ * 集成版员工部门信息。
169
169
  */
170
170
  export interface Department {
171
171
  /**
172
- * 部门id
172
+ * 部门ID。
173
173
  */
174
174
  DepartmentId?: string
175
175
  /**
176
- * 部门名称
176
+ * 部门名称。
177
177
  */
178
178
  DepartmentName?: string
179
179
  }
@@ -263,7 +263,7 @@ true:做透明化处理和颜色增强。
263
263
  */
264
264
  export interface DescribeIntegrationDepartmentsResponse {
265
265
  /**
266
- * 部门列表
266
+ * 部门信息列表。部门信息根据部门排序号OrderNo降序排列,根据部门创建时间升序排列。
267
267
  */
268
268
  Departments?: Array<IntegrationDepartment>
269
269
  /**
@@ -439,7 +439,8 @@ export interface CancelUserAutoSignEnableUrlResponse {
439
439
  */
440
440
  export interface BindEmployeeUserIdWithClientOpenIdResponse {
441
441
  /**
442
- * 绑定是否成功,1表示成功,0表示失败
442
+ * 绑定是否成功。
443
+ <ul><li>**0**:失败</li><li>**1**:成功</li></ul>
443
444
  */
444
445
  Status?: number
445
446
  /**
@@ -453,17 +454,19 @@ export interface BindEmployeeUserIdWithClientOpenIdResponse {
453
454
  */
454
455
  export interface CreateIntegrationEmployeesRequest {
455
456
  /**
456
- * 操作人信息,userId必填
457
+ * 执行本接口操作的员工信息。使用此接口时,必须填写userId
458
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
457
459
  */
458
460
  Operator: UserInfo
459
461
  /**
460
- * 待创建员工的信息,不超过20个。
461
- 所有类型的企业支持的入参:Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持。
462
- 企微类型的企业特有支持的入参:WeworkOpenId,传入此字段无需在传入其他信息
462
+ * 待创建员工的信息,最多不超过20个。
463
+ 其中入参Mobile和DisplayName必填,OpenId、Email和Department.DepartmentId选填,其他字段暂不支持设置。
464
+ 在创建企微企业员工场景下,只需传入WeworkOpenId,无需再传其他信息。
463
465
  */
464
466
  Employees: Array<Staff>
465
467
  /**
466
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
468
+ * 代理企业和员工的信息。
469
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
467
470
  */
468
471
  Agent?: Agent
469
472
  }
@@ -678,16 +681,16 @@ CONTRACT:合同专用章
678
681
  }
679
682
 
680
683
  /**
681
- * 集成版企业角色信息
684
+ * 集成版企业角色信息。
682
685
  */
683
686
  export interface StaffRole {
684
687
  /**
685
- * 角色id
688
+ * 角色ID。
686
689
  注意:此字段可能返回 null,表示取不到有效值。
687
690
  */
688
691
  RoleId?: string
689
692
  /**
690
- * 角色名称
693
+ * 角色名称。
691
694
  注意:此字段可能返回 null,表示取不到有效值。
692
695
  */
693
696
  RoleName?: string
@@ -794,7 +797,9 @@ export interface CreateConvertTaskApiRequest {
794
797
  */
795
798
  export interface DeleteIntegrationEmployeesResponse {
796
799
  /**
797
- * 员工删除数据
800
+ * 员工删除结果。包含成功数据与失败数据。
801
+ <ul><li>**成功数据**:展示员工姓名、手机号与电子签平台UserId</li>
802
+ <li>**失败数据**:展示员工电子签平台UserId、第三方平台OpenId和失败原因</li></ul>
798
803
  */
799
804
  DeleteEmployeeResult?: DeleteStaffsResult
800
805
  /**
@@ -822,15 +827,16 @@ export interface CreateFlowRemindsResponse {
822
827
  */
823
828
  export interface DescribeOrganizationGroupOrganizationsRequest {
824
829
  /**
825
- * 操作人信息,userId必填
830
+ * 执行本接口操作的员工信息,userId必填。
831
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
826
832
  */
827
833
  Operator: UserInfo
828
834
  /**
829
- * 指定每页多少条数据,单页最大1000
835
+ * 指定分页每页返回的数据条数,单页最大1000
830
836
  */
831
837
  Limit: number
832
838
  /**
833
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0
839
+ * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
834
840
  */
835
841
  Offset: number
836
842
  /**
@@ -838,15 +844,23 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
838
844
  */
839
845
  Name?: string
840
846
  /**
841
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
847
+ * 成员企业加入集团的当前状态
848
+ <ul><li> **1**:待授权</li>
849
+ <li> **2**:已授权待激活</li>
850
+ <li> **3**:拒绝授权</li>
851
+ <li> **4**:已解除</li>
852
+ <li> **5**:已加入</li>
853
+ </ul>
842
854
  */
843
855
  Status?: number
844
856
  /**
845
857
  * 是否导出当前成员企业数据
858
+ <ul><li> **false**:不导出(默认值)</li>
859
+ <li> **true**:导出</li></ul>
846
860
  */
847
861
  Export?: boolean
848
862
  /**
849
- * 成员企业机构 ID,在PC控制台 集团管理可获取
863
+ * 成员企业机构 ID,32 位字符串,在PC控制台 集团管理可获取
850
864
  */
851
865
  Id?: string
852
866
  }
@@ -1222,26 +1236,33 @@ export interface CreateDocumentResponse {
1222
1236
  */
1223
1237
  export interface DescribeIntegrationEmployeesRequest {
1224
1238
  /**
1225
- * 操作人信息,userId必填
1239
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
1240
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1226
1241
  */
1227
1242
  Operator: UserInfo
1228
1243
  /**
1229
- * 指定每页多少条数据,单页最大20
1244
+ * 指定分页每页返回的数据条数,单页最大支持 20
1230
1245
  */
1231
1246
  Limit: number
1232
1247
  /**
1233
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1248
+ * 代理企业和员工的信息。
1249
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1234
1250
  */
1235
1251
  Agent?: Agent
1236
1252
  /**
1237
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
1238
- 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
1239
- 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
1240
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
1253
+ * 查询的关键字段,支持Key-Values查询。可选键值如下:
1254
+ <ul>
1255
+ <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
1256
+ <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["NotVerified"]**:查询未实名的员工</li></ul></li>
1257
+ <li>Key:**"DepartmentId"**,根据部门ID查询部门下的员工,Values为指定的部门ID:**["DepartmentId"]**</li>
1258
+ <li>Key:**"UserId"**,根据用户ID查询员工,Values为指定的用户ID:**["UserId"]**</li>
1259
+ <li>Key:**"UserWeWorkOpenId"**,根据用户企微账号ID查询员工,Values为指定用户的企微账号ID:**["UserWeWorkOpenId"]**</li>
1260
+ <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
1261
+ </ul>
1241
1262
  */
1242
1263
  Filters?: Array<Filter>
1243
1264
  /**
1244
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
1265
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
1245
1266
  */
1246
1267
  Offset?: number
1247
1268
  }
@@ -1535,7 +1556,9 @@ export interface DescribeThirdPartyAuthCodeRequest {
1535
1556
  */
1536
1557
  export interface UnbindEmployeeUserIdWithClientOpenIdResponse {
1537
1558
  /**
1538
- * 解绑是否成功,1表示成功,0表示失败
1559
+ * 解绑是否成功。
1560
+ <ul><li> **0**:失败 </li>
1561
+ <li> **1**:成功 </li></ul>
1539
1562
  */
1540
1563
  Status?: number
1541
1564
  /**
@@ -1575,19 +1598,22 @@ export interface CreateWebThemeConfigResponse {
1575
1598
  */
1576
1599
  export interface BindEmployeeUserIdWithClientOpenIdRequest {
1577
1600
  /**
1578
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定。(参数参考示例)
1601
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
1602
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1579
1603
  */
1580
1604
  Operator: UserInfo
1581
1605
  /**
1582
- * 电子签系统员工UserId
1606
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
1607
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID);或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
1583
1608
  */
1584
1609
  UserId: string
1585
1610
  /**
1586
- * 客户系统OpenId
1611
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
1587
1612
  */
1588
1613
  OpenId: string
1589
1614
  /**
1590
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1615
+ * 代理企业和员工的信息。
1616
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1591
1617
  */
1592
1618
  Agent?: Agent
1593
1619
  }
@@ -1602,7 +1628,9 @@ export interface DescribeIntegrationDepartmentsRequest {
1602
1628
  */
1603
1629
  Operator: UserInfo
1604
1630
  /**
1605
- * 查询类型 0-查询单个部门节点 1-单个部门节点及一级子节点部门列表
1631
+ * 查询类型,支持以下类型:
1632
+ <ul><li>**0**:查询单个部门节点列表,不包含子节点部门信息</li>
1633
+ <li>**1**:查询单个部门节点级一级子节点部门信息列表</li></ul>
1606
1634
  */
1607
1635
  QueryType: number
1608
1636
  /**
@@ -1611,11 +1639,13 @@ export interface DescribeIntegrationDepartmentsRequest {
1611
1639
  */
1612
1640
  Agent?: Agent
1613
1641
  /**
1614
- * 部门ID,与DeptOpenId二选一,优先DeptId,都为空时获取根节点数据
1642
+ * 查询的部门ID
1643
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1615
1644
  */
1616
1645
  DeptId?: string
1617
1646
  /**
1618
- * 客户系统部门ID,与DeptId二选一,优先DeptId,都为空时获取根节点数据
1647
+ * 查询的客户系统部门ID
1648
+ 注:`如果同时指定了DeptId与DeptOpenId参数,系统将优先使用DeptId参数进行查询。当二者都未指定时,系统将返回根节点部门数据。`
1619
1649
  */
1620
1650
  DeptOpenId?: string
1621
1651
  }
@@ -1715,7 +1745,7 @@ export interface ComponentLimit {
1715
1745
  */
1716
1746
  export interface CreateIntegrationDepartmentResponse {
1717
1747
  /**
1718
- * 电子签部门ID
1748
+ * 电子签部门ID。建议开发者保存此部门ID,方便后续查询或修改部门信息。
1719
1749
  */
1720
1750
  DeptId?: string
1721
1751
  /**
@@ -2175,21 +2205,21 @@ export interface DisableUserAutoSignRequest {
2175
2205
  */
2176
2206
  export interface DescribeIntegrationEmployeesResponse {
2177
2207
  /**
2178
- * 员工数据列表
2208
+ * 员工信息列表。
2179
2209
  注意:此字段可能返回 null,表示取不到有效值。
2180
2210
  */
2181
2211
  Employees?: Array<Staff>
2182
2212
  /**
2183
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
2213
+ * 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
2184
2214
  注意:此字段可能返回 null,表示取不到有效值。
2185
2215
  */
2186
2216
  Offset?: number
2187
2217
  /**
2188
- * 指定每页多少条数据,单页最大20
2218
+ * 指定分页每页返回的数据条数,单页最大支持 20
2189
2219
  */
2190
2220
  Limit?: number
2191
2221
  /**
2192
- * 符合条件的员工数量
2222
+ * 符合条件的员工数量。
2193
2223
  */
2194
2224
  TotalCount?: number
2195
2225
  /**
@@ -2280,19 +2310,23 @@ CreateReview:发起审核
2280
2310
  */
2281
2311
  export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
2282
2312
  /**
2283
- * 用户信息,OpenId与UserId二选一必填一个,OpenId是第三方客户ID,userId是用户实名后的电子签生成的ID,当传入客户系统openId,传入的openId需与电子签员工userId绑定,且参数Channel必填,Channel值为INTEGRATE;当传入参数UserId,Channel无需指定(参数用法参考示例)
2313
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId
2314
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2284
2315
  */
2285
2316
  Operator: UserInfo
2286
2317
  /**
2287
- * 电子签系统员工UserId
2318
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2319
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
2288
2320
  */
2289
2321
  UserId: string
2290
2322
  /**
2291
- * 客户系统OpenId
2323
+ * 员工在贵司业务系统中的唯一身份标识,用于与腾讯电子签账号进行映射,确保在同一企业内不会出现重复。
2324
+ 该标识最大长度为64位字符串,仅支持包含26个英文字母和数字0-9的字符。
2292
2325
  */
2293
2326
  OpenId: string
2294
2327
  /**
2295
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2328
+ * 代理企业和员工的信息。
2329
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2296
2330
  */
2297
2331
  Agent?: Agent
2298
2332
  }
@@ -3007,78 +3041,80 @@ export interface FlowCreateApprover {
3007
3041
  }
3008
3042
 
3009
3043
  /**
3010
- * 企业员工信息
3044
+ * 企业员工信息。
3011
3045
  */
3012
3046
  export interface Staff {
3013
3047
  /**
3014
- * 用户在电子签平台的id
3015
- 注:创建和更新场景无需填写
3048
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3049
+ 注:`创建和更新场景无需填写。`
3016
3050
  */
3017
3051
  UserId?: string
3018
3052
  /**
3019
- * 显示的用户名/昵称
3053
+ * 显示的用户名/昵称。
3020
3054
  */
3021
3055
  DisplayName?: string
3022
3056
  /**
3023
- * 用户手机号
3057
+ * 用户手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
3024
3058
  */
3025
3059
  Mobile?: string
3026
3060
  /**
3027
- * 用户邮箱
3061
+ * 用户邮箱。
3028
3062
  注意:此字段可能返回 null,表示取不到有效值。
3029
3063
  */
3030
3064
  Email?: string
3031
3065
  /**
3032
- * 用户在第三方平台id,如需在此接口提醒员工实名,该参数不传
3066
+ * 用户在第三方平台ID。
3067
+ 注:`如需在此接口提醒员工实名,该参数不传。`
3033
3068
  注意:此字段可能返回 null,表示取不到有效值。
3034
3069
  */
3035
3070
  OpenId?: string
3036
3071
  /**
3037
- * 员工角色
3038
- 注:创建和更新场景无需填写
3072
+ * 员工角色信息。
3073
+ 注:`创建和更新场景无需填写。`
3039
3074
  注意:此字段可能返回 null,表示取不到有效值。
3040
3075
  */
3041
3076
  Roles?: Array<StaffRole>
3042
3077
  /**
3043
- * 员工部门
3078
+ * 员工部门信息。
3044
3079
  注意:此字段可能返回 null,表示取不到有效值。
3045
3080
  */
3046
3081
  Department?: Department
3047
3082
  /**
3048
- * 员工是否实名
3049
- 注:创建和更新场景无需填写
3083
+ * 员工是否实名。
3084
+ 注:`创建和更新场景无需填写。`
3050
3085
  */
3051
3086
  Verified?: boolean
3052
3087
  /**
3053
- * 员工创建时间戳,单位秒
3054
- 注:创建和更新场景无需填写
3088
+ * 员工创建时间戳,单位秒。
3089
+ 注:`创建和更新场景无需填写。`
3055
3090
  */
3056
3091
  CreatedOn?: number
3057
3092
  /**
3058
- * 员工实名时间戳,单位秒
3059
- 注:创建和更新场景无需填写
3093
+ * 员工实名时间戳,单位秒。
3094
+ 注:`创建和更新场景无需填写。`
3060
3095
  注意:此字段可能返回 null,表示取不到有效值。
3061
3096
  */
3062
3097
  VerifiedOn?: number
3063
3098
  /**
3064
- * 员工是否离职:0-未离职,1-离职
3065
- 注:创建和更新场景无需填写
3099
+ * 员工是否离职:
3100
+ <ul><li>**0**:未离职</li><li>**1**:离职</li></ul>
3101
+ 注:`创建和更新场景无需填写。`
3066
3102
  注意:此字段可能返回 null,表示取不到有效值。
3067
3103
  */
3068
3104
  QuiteJob?: number
3069
3105
  /**
3070
- * 员工离职交接人用户id
3071
- 注:创建和更新场景无需填写
3106
+ * 员工离职交接人用户ID。
3107
+ 注:`创建和更新场景无需填写。`
3072
3108
  */
3073
3109
  ReceiveUserId?: string
3074
3110
  /**
3075
- * 员工离职交接人用户OpenId
3076
- 注:创建和更新场景无需填写
3111
+ * 员工离职交接人用户OpenId
3112
+ 注:`创建和更新场景无需填写。`
3077
3113
  */
3078
3114
  ReceiveOpenId?: string
3079
3115
  /**
3080
- * 企业微信用户账号ID
3081
- 注:仅企微类型的企业创建员工接口支持该字段
3116
+ * 企业微信用户账号ID
3117
+ 注:`仅企微类型的企业创建员工接口支持该字段。`
3082
3118
  注意:此字段可能返回 null,表示取不到有效值。
3083
3119
  */
3084
3120
  WeworkOpenId?: string
@@ -3184,28 +3220,29 @@ export interface CreateIntegrationDepartmentRequest {
3184
3220
  */
3185
3221
  Operator: UserInfo
3186
3222
  /**
3187
- * 部门名称,不超过50个字符
3223
+ * 部门名称,最大长度为50个字符。
3188
3224
  */
3189
3225
  DeptName: string
3190
3226
  /**
3191
- * 代理企业和员工的信息。
3192
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3227
+ * 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3193
3228
  */
3194
3229
  Agent?: Agent
3195
3230
  /**
3196
- * 电子签父部门ID,与ParentDeptOpenId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3231
+ * 电子签父部门ID
3232
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3197
3233
  */
3198
3234
  ParentDeptId?: string
3199
3235
  /**
3200
- * 第三方平台中父部门ID,与ParentDeptId二选一,优先ParentDeptId,都为空时自动填充至根节点下
3236
+ * 第三方平台中父部门ID
3237
+ 注:`如果同时指定了ParentDeptId与ParentDeptOpenId参数,系统将优先使用ParentDeptId。当二者都未指定时,创建的新部门将自动填充至根节点部门下。`
3201
3238
  */
3202
3239
  ParentDeptOpenId?: string
3203
3240
  /**
3204
- * 客户系统部门ID,不超过64个字符
3241
+ * 客户系统部门ID,最大长度为64个字符。
3205
3242
  */
3206
3243
  DeptOpenId?: string
3207
3244
  /**
3208
- * 排序号,1~30000范围内
3245
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
3209
3246
  */
3210
3247
  OrderNo?: number
3211
3248
  }
@@ -3225,17 +3262,24 @@ export interface GroupOrganization {
3225
3262
  */
3226
3263
  Alias?: string
3227
3264
  /**
3228
- * 成员企业id
3265
+ * 成员企业id,为 32 位字符串,可在电子签PC 控制台,企业设置->企业电子签账号 获取
3229
3266
  注意:此字段可能返回 null,表示取不到有效值。
3230
3267
  */
3231
3268
  OrganizationId?: string
3232
3269
  /**
3233
- * 更新时间,时间戳,单位秒
3270
+ * 记录更新时间, unix时间戳,单位秒
3234
3271
  注意:此字段可能返回 null,表示取不到有效值。
3235
3272
  */
3236
3273
  UpdateTime?: number
3237
3274
  /**
3238
- * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
3275
+ * 成员企业加入集团的当前状态
3276
+ <ul><li> **1**:待授权</li>
3277
+ <li> **2**:已授权待激活</li>
3278
+ <li> **3**:拒绝授权</li>
3279
+ <li> **4**:已解除</li>
3280
+ <li> **5**:已加入</li>
3281
+ </ul>
3282
+
3239
3283
  注意:此字段可能返回 null,表示取不到有效值。
3240
3284
  */
3241
3285
  Status?: number
@@ -3255,22 +3299,24 @@ export interface GroupOrganization {
3255
3299
  */
3256
3300
  AdminInfo?: Admin
3257
3301
  /**
3258
- * 企业许可证
3302
+ * 企业许可证Id,此字段暂时不需要关注
3259
3303
  注意:此字段可能返回 null,表示取不到有效值。
3260
3304
  */
3261
3305
  License?: string
3262
3306
  /**
3263
- * 企业许可证过期时间,时间戳,单位秒
3307
+ * 企业许可证过期时间,unix时间戳,单位秒
3264
3308
  注意:此字段可能返回 null,表示取不到有效值。
3265
3309
  */
3266
3310
  LicenseExpireTime?: number
3267
3311
  /**
3268
- * 成员企业加入集团时间,时间戳,单位秒
3312
+ * 成员企业加入集团时间,unix时间戳,单位秒
3269
3313
  注意:此字段可能返回 null,表示取不到有效值。
3270
3314
  */
3271
3315
  JoinTime?: number
3272
3316
  /**
3273
- * 是否使用自建审批流引擎(即不是企微审批流引擎),true-是,false-否
3317
+ * 是否使用自建审批流引擎(即不是企微审批流引擎)
3318
+ <ul><li> **true**:是</li>
3319
+ <li> **false**:否</li></ul>
3274
3320
  注意:此字段可能返回 null,表示取不到有效值。
3275
3321
  */
3276
3322
  FlowEngineEnable?: boolean
@@ -3442,15 +3488,19 @@ export interface CreateEmbedWebUrlRequest {
3442
3488
  */
3443
3489
  export interface DeleteIntegrationEmployeesRequest {
3444
3490
  /**
3445
- * 操作人信息,userId必填
3491
+ * 执行本接口操作的员工信息。使用此接口时,必须填写UserId。
3492
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3446
3493
  */
3447
3494
  Operator: UserInfo
3448
3495
  /**
3449
- * 待移除员工的信息,userId和openId二选一,必填一个,如果需要指定交接人的话,ReceiveUserId或者ReceiveOpenId字段二选一
3496
+ * 待移除员工的信息。应符合以下规则:
3497
+ <ul><li>UserId和OpenId不可同时为空。</li>
3498
+ <li>若需要进行离职交接,交接人信息ReceiveUserId和ReceiveOpenId不可同时为空。否则视为不进行离职交接。</li></ul>
3450
3499
  */
3451
3500
  Employees: Array<Staff>
3452
3501
  /**
3453
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
3502
+ * 代理企业和员工的信息。
3503
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3454
3504
  */
3455
3505
  Agent?: Agent
3456
3506
  }
@@ -3464,7 +3514,7 @@ export interface FailedUpdateStaffData {
3464
3514
  */
3465
3515
  DisplayName?: string
3466
3516
  /**
3467
- * 用户传入的手机号
3517
+ * 用户传入的手机号,明文展示
3468
3518
  */
3469
3519
  Mobile?: string
3470
3520
  /**
@@ -3472,7 +3522,8 @@ export interface FailedUpdateStaffData {
3472
3522
  */
3473
3523
  Reason?: string
3474
3524
  /**
3475
- * 用户Id
3525
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3526
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3476
3527
  */
3477
3528
  UserId?: string
3478
3529
  /**
@@ -3592,7 +3643,7 @@ export interface CreateFlowGroupByFilesResponse {
3592
3643
  */
3593
3644
  export interface CreateIntegrationEmployeesResponse {
3594
3645
  /**
3595
- * 创建员工的结果
3646
+ * 创建员工的结果。包含创建成功的数据与创建失败数据。
3596
3647
  */
3597
3648
  CreateEmployeeResult?: CreateStaffResult
3598
3649
  /**
@@ -3949,11 +4000,12 @@ export interface SuccessUpdateStaffData {
3949
4000
  */
3950
4001
  DisplayName?: string
3951
4002
  /**
3952
- * 传入的手机号
4003
+ * 传入的手机号,没有打码
3953
4004
  */
3954
4005
  Mobile?: string
3955
4006
  /**
3956
- * 用户Id
4007
+ * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
4008
+ 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3957
4009
  */
3958
4010
  UserId?: string
3959
4011
  }
@@ -4328,7 +4380,7 @@ export interface ModifyIntegrationDepartmentRequest {
4328
4380
  */
4329
4381
  Operator: UserInfo
4330
4382
  /**
4331
- * 电子签部门ID,通过DescribeIntegrationDepartments接口可以获取
4383
+ * 电子签部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4332
4384
  */
4333
4385
  DeptId: string
4334
4386
  /**
@@ -4337,19 +4389,19 @@ export interface ModifyIntegrationDepartmentRequest {
4337
4389
  */
4338
4390
  Agent?: Agent
4339
4391
  /**
4340
- * 电子签父部门ID,通过DescribeIntegrationDepartments接口可以获取
4392
+ * 电子签父部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口获得。
4341
4393
  */
4342
4394
  ParentDeptId?: string
4343
4395
  /**
4344
- * 部门名称,不超过50个字符
4396
+ * 部门名称,最大长度为50个字符。
4345
4397
  */
4346
4398
  DeptName?: string
4347
4399
  /**
4348
- * 客户系统部门ID,不超过64个字符
4400
+ * 客户系统部门ID,最大长度为64个字符。
4349
4401
  */
4350
4402
  DeptOpenId?: string
4351
4403
  /**
4352
- * 排序号,1~30000范围内
4404
+ * 排序号,支持设置的数值范围为1~30000。同一父部门下,排序号越大,部门顺序越靠前。
4353
4405
  */
4354
4406
  OrderNo?: number
4355
4407
  }
@@ -4754,7 +4806,7 @@ export interface DeleteIntegrationDepartmentRequest {
4754
4806
  */
4755
4807
  Operator: UserInfo
4756
4808
  /**
4757
- * 电子签中的部门id,通过DescribeIntegrationDepartments接口可获得
4809
+ * 电子签中的部门ID,通过<a href="https://qian.tencent.com/developers/companyApis/organizations/DescribeIntegrationDepartments" target="_blank">DescribeIntegrationDepartments</a>接口可获得。
4758
4810
  */
4759
4811
  DeptId: string
4760
4812
  /**
@@ -4763,7 +4815,8 @@ export interface DeleteIntegrationDepartmentRequest {
4763
4815
  */
4764
4816
  Agent?: Agent
4765
4817
  /**
4766
- * 交接部门ID。待删除部门中的合同、印章和模板数据,交接至该部门ID下,未填写交接至公司根部门。
4818
+ * 交接部门ID
4819
+ 待删除部门中的合同、印章和模板数据,将会被交接至该部门ID下;若未填写则交接至公司根部门。
4767
4820
  */
4768
4821
  ReceiveDeptId?: string
4769
4822
  }
@@ -5406,12 +5459,12 @@ UpperRight-右下角。
5406
5459
  */
5407
5460
  export interface IntegrationDepartment {
5408
5461
  /**
5409
- * 部门ID
5462
+ * 部门ID
5410
5463
  注意:此字段可能返回 null,表示取不到有效值。
5411
5464
  */
5412
5465
  DeptId?: string
5413
5466
  /**
5414
- * 部门名
5467
+ * 部门名。
5415
5468
  注意:此字段可能返回 null,表示取不到有效值。
5416
5469
  */
5417
5470
  DeptName?: string
@@ -5426,7 +5479,7 @@ export interface IntegrationDepartment {
5426
5479
  */
5427
5480
  DeptOpenId?: string
5428
5481
  /**
5429
- * 序列号
5482
+ * 序列号。
5430
5483
  注意:此字段可能返回 null,表示取不到有效值。
5431
5484
  */
5432
5485
  OrderNo?: number
@@ -5510,7 +5563,8 @@ export interface CreateFlowRemindsRequest {
5510
5563
  */
5511
5564
  export interface UpdateIntegrationEmployeesRequest {
5512
5565
  /**
5513
- * 当前用户信息,UserId必填
5566
+ * 执行本接口操作的员工信息,UserId必填。
5567
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5514
5568
  */
5515
5569
  Operator: UserInfo
5516
5570
  /**
@@ -5520,7 +5574,8 @@ export interface UpdateIntegrationEmployeesRequest {
5520
5574
  */
5521
5575
  Employees: Array<Staff>
5522
5576
  /**
5523
- * 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId需填充子企业Id
5577
+ * 代理企业和员工的信息。
5578
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5524
5579
  */
5525
5580
  Agent?: Agent
5526
5581
  }
@@ -5665,7 +5720,9 @@ export interface Admin {
5665
5720
  */
5666
5721
  Name?: string
5667
5722
  /**
5668
- * 超管手机号
5723
+ * 超管手机号,打码显示
5724
+ 示例值:138****1569
5725
+
5669
5726
  注意:此字段可能返回 null,表示取不到有效值。
5670
5727
  */
5671
5728
  Mobile?: string
@@ -6150,12 +6207,12 @@ export interface FlowBrief {
6150
6207
  */
6151
6208
  export interface DescribeOrganizationGroupOrganizationsResponse {
6152
6209
  /**
6153
- * 查询到的符合条件的成员企业总数量
6210
+ * 符合查询条件的资源实例总数量。
6154
6211
  注意:此字段可能返回 null,表示取不到有效值。
6155
6212
  */
6156
6213
  Total?: number
6157
6214
  /**
6158
- * 已授权待激活的企业数量
6215
+ * 已授权待激活的子企业总数量
6159
6216
  注意:此字段可能返回 null,表示取不到有效值。
6160
6217
  */
6161
6218
  JoinedTotal?: number
@@ -6176,7 +6233,7 @@ export interface DescribeOrganizationGroupOrganizationsResponse {
6176
6233
  */
6177
6234
  List?: Array<GroupOrganization>
6178
6235
  /**
6179
- * 已加入的企业数量
6236
+ * 已加入的子企业总数量
6180
6237
  注意:此字段可能返回 null,表示取不到有效值。
6181
6238
  */
6182
6239
  ActivatedTotal?: number