tencentcloud-sdk-nodejs 4.0.688 → 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 (100) hide show
  1. package/CHANGELOG.md +489 -0
  2. package/SERVICE_CHANGELOG.md +580 -389
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  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/cvm/v20170312/cvm_client.ts +6 -3
  9. package/src/services/cvm/v20170312/cvm_models.ts +1 -1
  10. package/src/services/cynosdb/v20190107/cynosdb_client.ts +8 -6
  11. package/src/services/cynosdb/v20190107/cynosdb_models.ts +214 -88
  12. package/src/services/dlc/v20210125/dlc_client.ts +41 -6
  13. package/src/services/dlc/v20210125/dlc_models.ts +773 -274
  14. package/src/services/es/v20180416/es_models.ts +5 -5
  15. package/src/services/ess/v20201111/ess_client.ts +63 -60
  16. package/src/services/ess/v20201111/ess_models.ts +264 -229
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +52 -3
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +203 -9
  19. package/src/services/facefusion/v20220927/facefusion_models.ts +5 -1
  20. package/src/services/iss/v20230517/iss_models.ts +3 -3
  21. package/src/services/lcic/v20220817/lcic_models.ts +4 -0
  22. package/src/services/lighthouse/v20200324/lighthouse_models.ts +23 -19
  23. package/src/services/live/v20180801/live_models.ts +32 -27
  24. package/src/services/mongodb/v20190725/mongodb_models.ts +46 -46
  25. package/src/services/monitor/v20180724/monitor_models.ts +6 -2
  26. package/src/services/nlp/v20190408/nlp_client.ts +0 -17
  27. package/src/services/nlp/v20190408/nlp_models.ts +0 -117
  28. package/src/services/omics/v20221128/omics_models.ts +1 -1
  29. package/src/services/postgres/v20170312/postgres_models.ts +33 -30
  30. package/src/services/rce/v20201103/rce_models.ts +42 -11
  31. package/src/services/ssa/v20180608/ssa_client.ts +16 -3
  32. package/src/services/ssa/v20180608/ssa_models.ts +94 -24
  33. package/src/services/ssl/v20191205/ssl_client.ts +26 -2
  34. package/src/services/ssl/v20191205/ssl_models.ts +64 -16
  35. package/src/services/tat/v20201028/tat_models.ts +30 -9
  36. package/src/services/tse/v20201207/tse_client.ts +82 -18
  37. package/src/services/tse/v20201207/tse_models.ts +543 -270
  38. package/src/services/vod/v20180717/vod_client.ts +3 -9
  39. package/src/services/vod/v20180717/vod_models.ts +247 -242
  40. package/src/services/vpc/v20170312/vpc_models.ts +44 -22
  41. package/src/services/waf/v20180125/waf_client.ts +92 -29
  42. package/src/services/waf/v20180125/waf_models.ts +377 -77
  43. package/tencentcloud/common/sdk_version.d.ts +1 -1
  44. package/tencentcloud/common/sdk_version.js +1 -1
  45. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +0 -4
  46. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +18 -0
  47. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +3 -0
  48. package/tencentcloud/services/cvm/v20170312/cvm_client.js +3 -0
  49. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +1 -1
  50. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -5
  51. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +4 -4
  52. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +209 -85
  53. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +9 -1
  54. package/tencentcloud/services/dlc/v20210125/dlc_client.js +12 -0
  55. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +695 -211
  56. package/tencentcloud/services/es/v20180416/es_models.d.ts +5 -5
  57. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +53 -41
  58. package/tencentcloud/services/ess/v20201111/ess_client.js +53 -43
  59. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +264 -226
  60. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -3
  61. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +31 -2
  62. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +195 -9
  63. package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +5 -1
  64. package/tencentcloud/services/iss/v20230517/iss_models.d.ts +3 -3
  65. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +4 -0
  66. package/tencentcloud/services/lighthouse/v20200324/lighthouse_models.d.ts +23 -19
  67. package/tencentcloud/services/live/v20180801/live_models.d.ts +32 -27
  68. package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +46 -46
  69. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +6 -2
  70. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +1 -7
  71. package/tencentcloud/services/nlp/v20190408/nlp_client.js +0 -8
  72. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +0 -112
  73. package/tencentcloud/services/omics/v20221128/omics_models.d.ts +1 -1
  74. package/tencentcloud/services/postgres/v20170312/postgres_models.d.ts +33 -30
  75. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +42 -11
  76. package/tencentcloud/services/ssa/v20180608/ssa_client.d.ts +5 -1
  77. package/tencentcloud/services/ssa/v20180608/ssa_client.js +6 -0
  78. package/tencentcloud/services/ssa/v20180608/ssa_models.d.ts +91 -24
  79. package/tencentcloud/services/ssl/v20191205/ssl_client.d.ts +9 -1
  80. package/tencentcloud/services/ssl/v20191205/ssl_client.js +12 -0
  81. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +60 -16
  82. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +30 -9
  83. package/tencentcloud/services/tse/v20201207/tse_client.d.ts +25 -5
  84. package/tencentcloud/services/tse/v20201207/tse_client.js +36 -6
  85. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +531 -272
  86. package/tencentcloud/services/vod/v20180717/vod_client.d.ts +1 -7
  87. package/tencentcloud/services/vod/v20180717/vod_client.js +1 -7
  88. package/tencentcloud/services/vod/v20180717/vod_models.d.ts +247 -242
  89. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +44 -22
  90. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +30 -10
  91. package/tencentcloud/services/waf/v20180125/waf_client.js +43 -13
  92. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +364 -77
  93. package/test/dlc.v20210125.test.js +20 -0
  94. package/test/ess.v20201111.test.js +2 -12
  95. package/test/essbasic.v20210526.test.js +30 -0
  96. package/test/nlp.v20190408.test.js +0 -10
  97. package/test/ssa.v20180608.test.js +10 -0
  98. package/test/ssl.v20191205.test.js +20 -0
  99. package/test/tse.v20201207.test.js +54 -4
  100. package/test/waf.v20180125.test.js +58 -8
@@ -845,7 +845,7 @@ export interface DescribeIndexMetaResponse {
845
845
  * 索引元数据字段
846
846
  注意:此字段可能返回 null,表示取不到有效值。
847
847
  */
848
- IndexMetaField: IndexMetaField;
848
+ IndexMetaField?: IndexMetaField;
849
849
  /**
850
850
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
851
851
  */
@@ -1038,7 +1038,7 @@ export interface CreateIndexRequest {
1038
1038
  */
1039
1039
  IndexName: string;
1040
1040
  /**
1041
- * 创建的索引元数据JSON,如mappings、settings
1041
+ * 【必填】创建的索引元数据JSON,如mappings、settings
1042
1042
  */
1043
1043
  IndexMetaJson?: string;
1044
1044
  /**
@@ -1230,12 +1230,12 @@ export interface DescribeIndexListResponse {
1230
1230
  * 索引元数据字段
1231
1231
  注意:此字段可能返回 null,表示取不到有效值。
1232
1232
  */
1233
- IndexMetaFields: Array<IndexMetaField>;
1233
+ IndexMetaFields?: Array<IndexMetaField>;
1234
1234
  /**
1235
1235
  * 查询总数
1236
1236
  注意:此字段可能返回 null,表示取不到有效值。
1237
1237
  */
1238
- TotalCount: number;
1238
+ TotalCount?: number;
1239
1239
  /**
1240
1240
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1241
1241
  */
@@ -1472,7 +1472,7 @@ export interface DescribeIndexListRequest {
1472
1472
  */
1473
1473
  IndexStatusList?: Array<string>;
1474
1474
  /**
1475
- * 排序顺序,支持asc、desc
1475
+ * 排序顺序,支持asc、desc,默认为desc 数据格式"asc","desc"
1476
1476
  */
1477
1477
  Order?: string;
1478
1478
  }
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, DescribeIntegrationMainOrganizationUserRequest, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, DescribeIntegrationMainOrganizationUserResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
3
+ import { CreateSealRequest, ModifyIntegrationDepartmentResponse, CancelFlowResponse, DescribeFlowEvidenceReportRequest, UpdateIntegrationEmployeesResponse, CreatePreparedPersonalEsignRequest, DescribeIntegrationDepartmentsResponse, CreateFlowApproversResponse, DescribeFileUrlsResponse, ModifyApplicationCallbackInfoResponse, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, DisableUserAutoSignResponse, CancelUserAutoSignEnableUrlResponse, BindEmployeeUserIdWithClientOpenIdResponse, CreateIntegrationEmployeesRequest, DescribeIntegrationRolesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateIntegrationRoleRequest, CreateConvertTaskApiRequest, DeleteIntegrationEmployeesResponse, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, CreateFlowGroupByFilesRequest, DescribeFlowComponentsResponse, DescribeFlowEvidenceReportResponse, CreateFlowGroupByTemplatesResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateIntegrationUserRolesResponse, CreateFlowRequest, CreateSchemeUrlRequest, DeleteIntegrationDepartmentResponse, DescribeThirdPartyAuthCodeRequest, UnbindEmployeeUserIdWithClientOpenIdResponse, CreateReleaseFlowResponse, CreateWebThemeConfigResponse, BindEmployeeUserIdWithClientOpenIdRequest, DescribeIntegrationDepartmentsRequest, CreateIntegrationDepartmentResponse, DescribeFlowTemplatesRequest, DeleteSealPoliciesResponse, DescribeUserAutoSignStatusResponse, CreatePersonAuthCertificateImageResponse, CreateBatchCancelFlowUrlResponse, CreateSealPolicyResponse, DisableUserAutoSignRequest, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, UnbindEmployeeUserIdWithClientOpenIdRequest, CreateSchemeUrlResponse, CreateUserAutoSignEnableUrlResponse, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, ModifyIntegrationRoleResponse, CreateFlowEvidenceReportResponse, CreateIntegrationRoleResponse, DescribeFlowComponentsRequest, CreateIntegrationDepartmentRequest, DeleteIntegrationRoleUsersResponse, CreateDocumentRequest, CreatePreparedPersonalEsignResponse, DescribeOrganizationSealsResponse, CreateEmbedWebUrlRequest, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, ModifyIntegrationRoleRequest, CreateFlowGroupByFilesResponse, CreateIntegrationEmployeesResponse, DeleteIntegrationRoleUsersRequest, CreateFlowByFilesRequest, CreateFlowSignUrlRequest, CreateReleaseFlowRequest, CreateIntegrationUserRolesRequest, CreatePersonAuthCertificateImageRequest, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, ModifyIntegrationDepartmentRequest, CreateUserAutoSignEnableUrlRequest, CreateOrganizationBatchSignUrlResponse, CancelUserAutoSignEnableUrlRequest, CreateWebThemeConfigRequest, DeleteSealPoliciesRequest, CreateOrganizationBatchSignUrlRequest, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, DeleteIntegrationDepartmentRequest, ModifyApplicationCallbackInfoRequest, StartFlowRequest, CreateSealResponse, CreatePrepareFlowRequest, CreateEmbedWebUrlResponse, CreateSealPolicyRequest, DescribeOrganizationSealsRequest, CancelFlowRequest, DescribeExtendedServiceAuthInfosRequest, DescribeIntegrationRolesResponse, CreateFlowRemindsRequest, UpdateIntegrationEmployeesRequest, DescribeFlowBriefsRequest, CreateFlowGroupByTemplatesRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoRequest, DescribeFlowInfoResponse, CancelMultiFlowSignQRCodeResponse, CreateFlowResponse, DescribeUserAutoSignStatusRequest, DescribeOrganizationGroupOrganizationsResponse, DescribeExtendedServiceAuthInfosResponse } from "./ess_models";
4
4
  /**
5
5
  * ess client
6
6
  * @class
@@ -77,7 +77,14 @@ export declare class Client extends AbstractClient {
77
77
  */
78
78
  CreateIntegrationRole(req: CreateIntegrationRoleRequest, cb?: (error: string, rep: CreateIntegrationRoleResponse) => void): Promise<CreateIntegrationRoleResponse>;
79
79
  /**
80
- * 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
80
+ * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
81
+ 1. 创建印章
82
+ 2. 创建模板
83
+ 3. 修改模板
84
+ 4. 预览模板
85
+ 5. 预览合同流程
86
+
87
+ 用户可以通过这些链接快速将其集成到自己的系统中。
81
88
  */
82
89
  CreateEmbedWebUrl(req: CreateEmbedWebUrlRequest, cb?: (error: string, rep: CreateEmbedWebUrlResponse) => void): Promise<CreateEmbedWebUrlResponse>;
83
90
  /**
@@ -85,7 +92,9 @@ export declare class Client extends AbstractClient {
85
92
  */
86
93
  VerifyPdf(req: VerifyPdfRequest, cb?: (error: string, rep: VerifyPdfResponse) => void): Promise<VerifyPdfResponse>;
87
94
  /**
88
- * 将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
95
+ * 此接口(UnbindEmployeeUserIdWithClientOpenId)用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
96
+
97
+ 注:`在调用此接口时,需确保OpenId已通过调用`<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>`接口与电子签系统的UserId绑定过。若OpenId未经过绑定,则无法使用此接口进行解绑操作。`
89
98
  */
90
99
  UnbindEmployeeUserIdWithClientOpenId(req: UnbindEmployeeUserIdWithClientOpenIdRequest, cb?: (error: string, rep: UnbindEmployeeUserIdWithClientOpenIdResponse) => void): Promise<UnbindEmployeeUserIdWithClientOpenIdResponse>;
91
100
  /**
@@ -95,11 +104,11 @@ export declare class Client extends AbstractClient {
95
104
  */
96
105
  CreateBatchCancelFlowUrl(req: CreateBatchCancelFlowUrlRequest, cb?: (error: string, rep: CreateBatchCancelFlowUrlResponse) => void): Promise<CreateBatchCancelFlowUrlResponse>;
97
106
  /**
98
- * 通过此接口,删除企业的部门。
107
+ * 此接口(DeleteIntegrationDepartment)用于删除企业的部门信息。
99
108
  */
100
109
  DeleteIntegrationDepartment(req: DeleteIntegrationDepartmentRequest, cb?: (error: string, rep: DeleteIntegrationDepartmentResponse) => void): Promise<DeleteIntegrationDepartmentResponse>;
101
110
  /**
102
- * 将电子签系统员工userId与客户系统员工openId进行绑定
111
+ * 此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
103
112
  */
104
113
  BindEmployeeUserIdWithClientOpenId(req: BindEmployeeUserIdWithClientOpenIdRequest, cb?: (error: string, rep: BindEmployeeUserIdWithClientOpenIdResponse) => void): Promise<BindEmployeeUserIdWithClientOpenIdResponse>;
105
114
  /**
@@ -107,30 +116,21 @@ export declare class Client extends AbstractClient {
107
116
  */
108
117
  CreatePreparedPersonalEsign(req: CreatePreparedPersonalEsignRequest, cb?: (error: string, rep: CreatePreparedPersonalEsignResponse) => void): Promise<CreatePreparedPersonalEsignResponse>;
109
118
  /**
110
- * ### 适用场景
111
- 在通过模板或者文件发起合同时,若未指定企业签署人信息,则流程发起后,可以调用此接口补充或签签署人。
112
- 同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
113
- ### 限制条件
114
- - 本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
115
- - 他方企业仅支持通过姓名+手机号补充
119
+ * 适用场景:
120
+ 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
121
+
122
+ 限制条件:
123
+ 1. 本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
124
+ 2. 本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
125
+ 3. 他方企业仅支持通过姓名+手机号进行补充。
116
126
  */
117
127
  CreateFlowApprovers(req: CreateFlowApproversRequest, cb?: (error: string, rep: CreateFlowApproversResponse) => void): Promise<CreateFlowApproversResponse>;
118
128
  /**
119
- * 通过此接口,更新企业的部门信息,支持更新部门名、客户系统部门ID、部门序列号。
129
+ * 此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。
120
130
  */
121
131
  ModifyIntegrationDepartment(req: ModifyIntegrationDepartmentRequest, cb?: (error: string, rep: ModifyIntegrationDepartmentResponse) => void): Promise<ModifyIntegrationDepartmentResponse>;
122
132
  /**
123
- * 通过此接口可以关闭个人用户自动签功能。
124
- 无需对应的用户刷脸等方式同意即可关闭。
125
-
126
- 注意:
127
-
128
- <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
129
- <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
130
- */
131
- DisableUserAutoSign(req: DisableUserAutoSignRequest, cb?: (error: string, rep: DisableUserAutoSignResponse) => void): Promise<DisableUserAutoSignResponse>;
132
- /**
133
- * 解绑员工与对应角色关系
133
+ * 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
134
134
  */
135
135
  DeleteIntegrationRoleUsers(req: DeleteIntegrationRoleUsersRequest, cb?: (error: string, rep: DeleteIntegrationRoleUsersResponse) => void): Promise<DeleteIntegrationRoleUsersResponse>;
136
136
  /**
@@ -212,8 +212,9 @@ export declare class Client extends AbstractClient {
212
212
  */
213
213
  DescribeUserAutoSignStatus(req: DescribeUserAutoSignStatusRequest, cb?: (error: string, rep: DescribeUserAutoSignStatusResponse) => void): Promise<DescribeUserAutoSignStatusResponse>;
214
214
  /**
215
- * 此接口(CreateFlowGroupByTemplates)通过多模板创建合同组签署流程。<br/>
216
- 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
215
+ * 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
216
+
217
+ 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
217
218
  */
218
219
  CreateFlowGroupByTemplates(req: CreateFlowGroupByTemplatesRequest, cb?: (error: string, rep: CreateFlowGroupByTemplatesResponse) => void): Promise<CreateFlowGroupByTemplatesResponse>;
219
220
  /**
@@ -259,11 +260,13 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
259
260
  */
260
261
  CreateSeal(req: CreateSealRequest, cb?: (error: string, rep: CreateSealResponse) => void): Promise<CreateSealResponse>;
261
262
  /**
262
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
263
+ * 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
264
+
265
+ 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
263
266
  */
264
267
  DescribeIntegrationRoles(req: DescribeIntegrationRolesRequest, cb?: (error: string, rep: DescribeIntegrationRolesResponse) => void): Promise<DescribeIntegrationRolesResponse>;
265
268
  /**
266
- * 通过此接口,创建企业的部门,支持绑定客户系统部门ID。
269
+ * 此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。
267
270
  */
268
271
  CreateIntegrationDepartment(req: CreateIntegrationDepartmentRequest, cb?: (error: string, rep: CreateIntegrationDepartmentResponse) => void): Promise<CreateIntegrationDepartmentResponse>;
269
272
  /**
@@ -278,7 +281,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
278
281
  */
279
282
  CancelMultiFlowSignQRCode(req: CancelMultiFlowSignQRCodeRequest, cb?: (error: string, rep: CancelMultiFlowSignQRCodeResponse) => void): Promise<CancelMultiFlowSignQRCodeResponse>;
280
283
  /**
281
- * 查询企业员工列表,每次返回的数据量最大为20
284
+ * 此接口(DescribeIntegrationEmployees)用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
282
285
  */
283
286
  DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
284
287
  /**
@@ -299,7 +302,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
299
302
 
300
303
  ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
301
304
 
302
- 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
305
+ 注:
306
+ <ul>
307
+ <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
308
+ <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
309
+ </ul>
303
310
  */
304
311
  CreatePersonAuthCertificateImage(req: CreatePersonAuthCertificateImageRequest, cb?: (error: string, rep: CreatePersonAuthCertificateImageResponse) => void): Promise<CreatePersonAuthCertificateImageResponse>;
305
312
  /**
@@ -321,7 +328,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
321
328
  */
322
329
  DescribeFlowBriefs(req: DescribeFlowBriefsRequest, cb?: (error: string, rep: DescribeFlowBriefsResponse) => void): Promise<DescribeFlowBriefsResponse>;
323
330
  /**
324
- * 绑定员工与对应角色
331
+ * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
325
332
  */
326
333
  CreateIntegrationUserRoles(req: CreateIntegrationUserRolesRequest, cb?: (error: string, rep: CreateIntegrationUserRolesResponse) => void): Promise<CreateIntegrationUserRolesResponse>;
327
334
  /**
@@ -363,11 +370,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
363
370
  */
364
371
  DescribeFlowComponents(req: DescribeFlowComponentsRequest, cb?: (error: string, rep: DescribeFlowComponentsResponse) => void): Promise<DescribeFlowComponentsResponse>;
365
372
  /**
366
- * 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
373
+ * 通过此接口可以关闭个人用户自动签功能。
374
+ 无需对应的用户刷脸等方式同意即可关闭。
367
375
 
368
- 通过子企业影子账号查询主企业员工账号
376
+ 注意:
377
+
378
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
379
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
369
380
  */
370
- DescribeIntegrationMainOrganizationUser(req: DescribeIntegrationMainOrganizationUserRequest, cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void): Promise<DescribeIntegrationMainOrganizationUserResponse>;
381
+ DisableUserAutoSign(req: DisableUserAutoSignRequest, cb?: (error: string, rep: DisableUserAutoSignResponse) => void): Promise<DisableUserAutoSignResponse>;
371
382
  /**
372
383
  * 通过AuthCode查询个人用户是否实名
373
384
 
@@ -390,10 +401,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
390
401
  */
391
402
  DescribeOrganizationSeals(req: DescribeOrganizationSealsRequest, cb?: (error: string, rep: DescribeOrganizationSealsResponse) => void): Promise<DescribeOrganizationSealsResponse>;
392
403
  /**
393
- * 移除员工
394
- 这里分两个场景
395
- 如果不传交接人的ReceiveUserId或者ReceiveOpenId,则会直接把这个人进行离职
396
- 如果传了交接人,会把离职人未处理完的合同交接给交接人后再离职
404
+ * 该接口(DeleteIntegrationEmployees)用于移除企业员工,同时可选择是否进行离职交接。
405
+ - 如果不设置交接人的ReceiveUserId或ReceiveOpenId,则该员工将被直接移除而不进行交接操作。
406
+ - 如果设置了ReceiveUserIdReceiveOpenId,该员工未处理的合同将会被系统交接给设置的交接人,然后再对该员工进行离职操作。
407
+
408
+ 注:`1. 超管或法人身份的员工不能被删除。2. 员工存在待处理合同且无人交接时不能被删除。`
397
409
  */
398
410
  DeleteIntegrationEmployees(req: DeleteIntegrationEmployeesRequest, cb?: (error: string, rep: DeleteIntegrationEmployeesResponse) => void): Promise<DeleteIntegrationEmployeesResponse>;
399
411
  /**
@@ -424,7 +436,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
424
436
  */
425
437
  CancelUserAutoSignEnableUrl(req: CancelUserAutoSignEnableUrlRequest, cb?: (error: string, rep: CancelUserAutoSignEnableUrlResponse) => void): Promise<CancelUserAutoSignEnableUrlResponse>;
426
438
  /**
427
- * 通过此接口,查询企业的部门,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
439
+ * 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
428
440
  */
429
441
  DescribeIntegrationDepartments(req: DescribeIntegrationDepartmentsRequest, cb?: (error: string, rep: DescribeIntegrationDepartmentsResponse) => void): Promise<DescribeIntegrationDepartmentsResponse>;
430
442
  /**
@@ -436,12 +448,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
436
448
  */
437
449
  CreateFlowGroupByFiles(req: CreateFlowGroupByFilesRequest, cb?: (error: string, rep: CreateFlowGroupByFilesResponse) => void): Promise<CreateFlowGroupByFilesResponse>;
438
450
  /**
439
- * 此API接口用户查询加入集团的成员企业
451
+ * 此API接口用来查询加入集团的成员企业信息
452
+ 适用场景:子企业在加入集团后,主企业可能通过此接口获取到所有的子企业列表,方便进行展示和统计
440
453
  */
441
454
  DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
442
455
  /**
443
- * 创建员工,此接口会发送提醒员工实名的短信,如果通过手机号发现员工已经创建,则不会重新创建,会发送短信提醒员工实名
444
- 注意:此接口支持企微组织架构的 openid 创建员工,这种场景下传递明文的企微 openid 到WeworkOpenId字段即可(企微明文的 openid 一定要在应用的可见范围内才行),通过企微创建的员工,会发送企微消息去提醒实名
456
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
445
457
  */
446
458
  CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
447
459
  /**
@@ -115,7 +115,14 @@ class Client extends abstract_client_1.AbstractClient {
115
115
  return this.request("CreateIntegrationRole", req, cb);
116
116
  }
117
117
  /**
118
- * 本接口(CreateEmbedWebUrl)用于创建嵌入web的链接 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接 进入web连接后与当前控制台操作保持一致
118
+ * 本接口(CreateEmbedWebUrl)用于创建嵌入Web的链接,支持以下类型的Web链接创建:
119
+ 1. 创建印章
120
+ 2. 创建模板
121
+ 3. 修改模板
122
+ 4. 预览模板
123
+ 5. 预览合同流程
124
+
125
+ 用户可以通过这些链接快速将其集成到自己的系统中。
119
126
  */
120
127
  async CreateEmbedWebUrl(req, cb) {
121
128
  return this.request("CreateEmbedWebUrl", req, cb);
@@ -127,7 +134,9 @@ class Client extends abstract_client_1.AbstractClient {
127
134
  return this.request("VerifyPdf", req, cb);
128
135
  }
129
136
  /**
130
- * 将存在绑定关系的电子签系统员工userId与客户系统员工openId进行解绑
137
+ * 此接口(UnbindEmployeeUserIdWithClientOpenId)用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
138
+
139
+ 注:`在调用此接口时,需确保OpenId已通过调用`<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>`接口与电子签系统的UserId绑定过。若OpenId未经过绑定,则无法使用此接口进行解绑操作。`
131
140
  */
132
141
  async UnbindEmployeeUserIdWithClientOpenId(req, cb) {
133
142
  return this.request("UnbindEmployeeUserIdWithClientOpenId", req, cb);
@@ -141,13 +150,13 @@ class Client extends abstract_client_1.AbstractClient {
141
150
  return this.request("CreateBatchCancelFlowUrl", req, cb);
142
151
  }
143
152
  /**
144
- * 通过此接口,删除企业的部门。
153
+ * 此接口(DeleteIntegrationDepartment)用于删除企业的部门信息。
145
154
  */
146
155
  async DeleteIntegrationDepartment(req, cb) {
147
156
  return this.request("DeleteIntegrationDepartment", req, cb);
148
157
  }
149
158
  /**
150
- * 将电子签系统员工userId与客户系统员工openId进行绑定
159
+ * 此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
151
160
  */
152
161
  async BindEmployeeUserIdWithClientOpenId(req, cb) {
153
162
  return this.request("BindEmployeeUserIdWithClientOpenId", req, cb);
@@ -159,36 +168,25 @@ class Client extends abstract_client_1.AbstractClient {
159
168
  return this.request("CreatePreparedPersonalEsign", req, cb);
160
169
  }
161
170
  /**
162
- * ### 适用场景
163
- 在通过模板或者文件发起合同时,若未指定企业签署人信息,则流程发起后,可以调用此接口补充或签签署人。
164
- 同一签署人可以补充多个员工作为或签签署人,最终实际签署人取决于谁先领取合同完成签署。
165
- ### 限制条件
166
- - 本企业(发起方企业)支持通过企业微信UserId 或者 姓名+手机号补充
167
- - 他方企业仅支持通过姓名+手机号补充
171
+ * 适用场景:
172
+ 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
173
+
174
+ 限制条件:
175
+ 1. 本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
176
+ 2. 本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
177
+ 3. 他方企业仅支持通过姓名+手机号进行补充。
168
178
  */
169
179
  async CreateFlowApprovers(req, cb) {
170
180
  return this.request("CreateFlowApprovers", req, cb);
171
181
  }
172
182
  /**
173
- * 通过此接口,更新企业的部门信息,支持更新部门名、客户系统部门ID、部门序列号。
183
+ * 此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。
174
184
  */
175
185
  async ModifyIntegrationDepartment(req, cb) {
176
186
  return this.request("ModifyIntegrationDepartment", req, cb);
177
187
  }
178
188
  /**
179
- * 通过此接口可以关闭个人用户自动签功能。
180
- 无需对应的用户刷脸等方式同意即可关闭。
181
-
182
- 注意:
183
-
184
- <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
185
- <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
186
- */
187
- async DisableUserAutoSign(req, cb) {
188
- return this.request("DisableUserAutoSign", req, cb);
189
- }
190
- /**
191
- * 解绑员工与对应角色关系
189
+ * 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
192
190
  */
193
191
  async DeleteIntegrationRoleUsers(req, cb) {
194
192
  return this.request("DeleteIntegrationRoleUsers", req, cb);
@@ -288,8 +286,9 @@ class Client extends abstract_client_1.AbstractClient {
288
286
  return this.request("DescribeUserAutoSignStatus", req, cb);
289
287
  }
290
288
  /**
291
- * 此接口(CreateFlowGroupByTemplates)通过多模板创建合同组签署流程。<br/>
292
- 此接口合同组中的子合同必须都是模板发起的合同。 <br/>目前最大仅支持50个子合同
289
+ * 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
290
+
291
+ 适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
293
292
  */
294
293
  async CreateFlowGroupByTemplates(req, cb) {
295
294
  return this.request("CreateFlowGroupByTemplates", req, cb);
@@ -347,13 +346,15 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
347
346
  return this.request("CreateSeal", req, cb);
348
347
  }
349
348
  /**
350
- * 分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列
349
+ * 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
350
+
351
+ 注:`法人角色是系统保留角色,因此返回列表中不含法人角色。`
351
352
  */
352
353
  async DescribeIntegrationRoles(req, cb) {
353
354
  return this.request("DescribeIntegrationRoles", req, cb);
354
355
  }
355
356
  /**
356
- * 通过此接口,创建企业的部门,支持绑定客户系统部门ID。
357
+ * 此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。
357
358
  */
358
359
  async CreateIntegrationDepartment(req, cb) {
359
360
  return this.request("CreateIntegrationDepartment", req, cb);
@@ -374,7 +375,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
374
375
  return this.request("CancelMultiFlowSignQRCode", req, cb);
375
376
  }
376
377
  /**
377
- * 查询企业员工列表,每次返回的数据量最大为20
378
+ * 此接口(DescribeIntegrationEmployees)用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
378
379
  */
379
380
  async DescribeIntegrationEmployees(req, cb) {
380
381
  return this.request("DescribeIntegrationEmployees", req, cb);
@@ -399,7 +400,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
399
400
 
400
401
  ![image](https://dyn.ess.tencent.cn/guide/capi/CreatePersonAuthCertificateImage.png)
401
402
 
402
- 注: `只能获取个人用户证明图片, 企业员工的暂不支持`
403
+ 注:
404
+ <ul>
405
+ <li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
406
+ <li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
407
+ </ul>
403
408
  */
404
409
  async CreatePersonAuthCertificateImage(req, cb) {
405
410
  return this.request("CreatePersonAuthCertificateImage", req, cb);
@@ -427,7 +432,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
427
432
  return this.request("DescribeFlowBriefs", req, cb);
428
433
  }
429
434
  /**
430
- * 绑定员工与对应角色
435
+ * 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
431
436
  */
432
437
  async CreateIntegrationUserRoles(req, cb) {
433
438
  return this.request("CreateIntegrationUserRoles", req, cb);
@@ -481,12 +486,16 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
481
486
  return this.request("DescribeFlowComponents", req, cb);
482
487
  }
483
488
  /**
484
- * 集团企业统一使用主代子进行操作,无需根据子企业账号进行转化查询,该接口需要屏蔽下线
489
+ * 通过此接口可以关闭个人用户自动签功能。
490
+ 无需对应的用户刷脸等方式同意即可关闭。
485
491
 
486
- 通过子企业影子账号查询主企业员工账号
492
+ 注意:
493
+
494
+ <ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
495
+ <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
487
496
  */
488
- async DescribeIntegrationMainOrganizationUser(req, cb) {
489
- return this.request("DescribeIntegrationMainOrganizationUser", req, cb);
497
+ async DisableUserAutoSign(req, cb) {
498
+ return this.request("DisableUserAutoSign", req, cb);
490
499
  }
491
500
  /**
492
501
  * 通过AuthCode查询个人用户是否实名
@@ -516,10 +525,11 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
516
525
  return this.request("DescribeOrganizationSeals", req, cb);
517
526
  }
518
527
  /**
519
- * 移除员工
520
- 这里分两个场景
521
- 如果不传交接人的ReceiveUserId或者ReceiveOpenId,则会直接把这个人进行离职
522
- 如果传了交接人,会把离职人未处理完的合同交接给交接人后再离职
528
+ * 该接口(DeleteIntegrationEmployees)用于移除企业员工,同时可选择是否进行离职交接。
529
+ - 如果不设置交接人的ReceiveUserId或ReceiveOpenId,则该员工将被直接移除而不进行交接操作。
530
+ - 如果设置了ReceiveUserIdReceiveOpenId,该员工未处理的合同将会被系统交接给设置的交接人,然后再对该员工进行离职操作。
531
+
532
+ 注:`1. 超管或法人身份的员工不能被删除。2. 员工存在待处理合同且无人交接时不能被删除。`
523
533
  */
524
534
  async DeleteIntegrationEmployees(req, cb) {
525
535
  return this.request("DeleteIntegrationEmployees", req, cb);
@@ -556,7 +566,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
556
566
  return this.request("CancelUserAutoSignEnableUrl", req, cb);
557
567
  }
558
568
  /**
559
- * 通过此接口,查询企业的部门,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
569
+ * 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
560
570
  */
561
571
  async DescribeIntegrationDepartments(req, cb) {
562
572
  return this.request("DescribeIntegrationDepartments", req, cb);
@@ -572,14 +582,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");<br/>
572
582
  return this.request("CreateFlowGroupByFiles", req, cb);
573
583
  }
574
584
  /**
575
- * 此API接口用户查询加入集团的成员企业
585
+ * 此API接口用来查询加入集团的成员企业信息
586
+ 适用场景:子企业在加入集团后,主企业可能通过此接口获取到所有的子企业列表,方便进行展示和统计
576
587
  */
577
588
  async DescribeOrganizationGroupOrganizations(req, cb) {
578
589
  return this.request("DescribeOrganizationGroupOrganizations", req, cb);
579
590
  }
580
591
  /**
581
- * 创建员工,此接口会发送提醒员工实名的短信,如果通过手机号发现员工已经创建,则不会重新创建,会发送短信提醒员工实名
582
- 注意:此接口支持企微组织架构的 openid 创建员工,这种场景下传递明文的企微 openid 到WeworkOpenId字段即可(企微明文的 openid 一定要在应用的可见范围内才行),通过企微创建的员工,会发送企微消息去提醒实名
592
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
583
593
  */
584
594
  async CreateIntegrationEmployees(req, cb) {
585
595
  return this.request("CreateIntegrationEmployees", req, cb);