tencentcloud-sdk-nodejs 4.0.780 → 4.0.782

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 (37) hide show
  1. package/CHANGELOG.md +163 -0
  2. package/SERVICE_CHANGELOG.md +406 -48
  3. package/package.json +1 -1
  4. package/products.md +14 -14
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/dbbrain/v20210527/dbbrain_models.ts +15 -2
  7. package/src/services/ess/v20201111/ess_client.ts +65 -10
  8. package/src/services/ess/v20201111/ess_models.ts +68 -12
  9. package/src/services/essbasic/v20210526/essbasic_client.ts +5 -6
  10. package/src/services/essbasic/v20210526/essbasic_models.ts +53 -9
  11. package/src/services/monitor/v20180724/monitor_models.ts +2 -2
  12. package/src/services/ocr/v20181119/ocr_client.ts +21 -9
  13. package/src/services/ocr/v20181119/ocr_models.ts +72 -1
  14. package/src/services/teo/v20220901/teo_models.ts +5 -3
  15. package/src/services/tsf/v20180326/tsf_models.ts +13 -8
  16. package/src/services/wedata/v20210820/wedata_client.ts +0 -14
  17. package/src/services/wedata/v20210820/wedata_models.ts +0 -24
  18. package/tencentcloud/common/sdk_version.d.ts +1 -1
  19. package/tencentcloud/common/sdk_version.js +1 -1
  20. package/tencentcloud/services/dbbrain/v20210527/dbbrain_models.d.ts +15 -2
  21. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +64 -9
  22. package/tencentcloud/services/ess/v20201111/ess_client.js +64 -9
  23. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +68 -12
  24. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +5 -6
  25. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +5 -6
  26. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +53 -9
  27. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +2 -2
  28. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +9 -5
  29. package/tencentcloud/services/ocr/v20181119/ocr_client.js +11 -5
  30. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +70 -1
  31. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +5 -3
  32. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +13 -8
  33. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +1 -7
  34. package/tencentcloud/services/wedata/v20210820/wedata_client.js +0 -8
  35. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +0 -22
  36. package/test/ocr.v20181119.test.js +12 -2
  37. package/test/wedata.v20210820.test.js +0 -10
@@ -6967,7 +6967,7 @@ export interface RecognizeTableAccurateOCRRequest {
6967
6967
  */
6968
6968
  ImageUrl?: string
6969
6969
  /**
6970
- * 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF且IsPdf参数值为true时有效,默认值为1。
6970
+ * 需要识别的PDF页面的对应页码,仅支持PDF单页识别,当上传文件为PDF有效,默认值为1。
6971
6971
  */
6972
6972
  PdfPageNumber?: number
6973
6973
  }
@@ -8707,6 +8707,44 @@ export interface EnglishOCRResponse {
8707
8707
  RequestId?: string
8708
8708
  }
8709
8709
 
8710
+ /**
8711
+ * RecognizeForeignPermanentResidentIdCard返回参数结构体
8712
+ */
8713
+ export interface RecognizeForeignPermanentResidentIdCardResponse {
8714
+ /**
8715
+ * 中文姓名。
8716
+ */
8717
+ CnName?: string
8718
+ /**
8719
+ * 英文名。
8720
+ */
8721
+ EnName?: string
8722
+ /**
8723
+ * 性别。
8724
+ */
8725
+ Sex?: string
8726
+ /**
8727
+ * 出生日期。规范格式为 XXXX年XX月XX日。
8728
+ */
8729
+ DateOfBirth?: string
8730
+ /**
8731
+ * 国籍。
8732
+ */
8733
+ Nationality?: string
8734
+ /**
8735
+ * 有效期限。
8736
+ */
8737
+ PeriodOfValidity?: string
8738
+ /**
8739
+ * 证件号码。
8740
+ */
8741
+ No?: string
8742
+ /**
8743
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8744
+ */
8745
+ RequestId?: string
8746
+ }
8747
+
8710
8748
  /**
8711
8749
  * BusInvoiceOCR请求参数结构体
8712
8750
  */
@@ -9985,6 +10023,39 @@ export interface UsedCarPurchaseInvoice {
9985
10023
  MachineNumber?: string
9986
10024
  }
9987
10025
 
10026
+ /**
10027
+ * RecognizeForeignPermanentResidentIdCard请求参数结构体
10028
+ */
10029
+ export interface RecognizeForeignPermanentResidentIdCardRequest {
10030
+ /**
10031
+ * 图片的 Url 地址。
10032
+ 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
10033
+ 支持的图片大小:所下载图片经 Base64 编码后不超过 7M。图片下载时间不超过 3 秒。
10034
+ 支持的图片像素:需介于20-10000px之间。
10035
+ 图片存储于腾讯云的 Url 可保障更高的下载速度和稳定性,建议图片存储于腾讯云。
10036
+ 非腾讯云存储的 Url 速度和稳定性可能受一定影响。
10037
+ 示例值:https://ocr-demo-1254418846.cos.ap-guangzhou.myqcloud.com/docume
10038
+ */
10039
+ ImageUrl?: string
10040
+ /**
10041
+ * 图片的 Base64 值。
10042
+ 支持的图片格式:PNG、JPG、JPEG,暂不支持 GIF 格式。
10043
+ 支持的图片大小:所下载图片经Base64编码后不超过 7M。图片下载时间不超过 3 秒。
10044
+ 支持的图片像素:需介于20-10000px之间。
10045
+ 图片的 ImageUrl、ImageBase64 必须提供一个,如果都提供,只使用 ImageUrl。
10046
+ */
10047
+ ImageBase64?: string
10048
+ /**
10049
+ * 是否开启PDF识别,默认值为false,开启后可同时支持图片和PDF的识别。
10050
+ */
10051
+ EnablePdf?: boolean
10052
+ /**
10053
+ * 需要识别的PDF页面的对应页码,传入时仅支持PDF单页识别,当上传文件为PDF且EnablePdf参数值为true时有效,默认值为1。
10054
+ 示例值:1
10055
+ */
10056
+ PdfPageNumber?: number
10057
+ }
10058
+
9988
10059
  /**
9989
10060
  * GeneralFastOCR返回参数结构体
9990
10061
  */
@@ -1961,12 +1961,14 @@ export interface ApplicationProxyRule {
1961
1961
  /**
1962
1962
  * 源站类型,取值有:
1963
1963
  <li>custom:手动添加;</li>
1964
+ <li>loadbalancer:负载均衡;</li>
1964
1965
  <li>origins:源站组。</li>
1965
1966
  */
1966
1967
  OriginType: string
1967
1968
  /**
1968
1969
  * 源站信息:
1969
1970
  <li>当 OriginType 为 custom 时,表示一个或多个源站,如`["8.8.8.8","9.9.9.9"]` 或 `OriginValue=["test.com"]`;</li>
1971
+ <li>当 OriginType 为 loadbalancer 时,表示一个负载均衡,如`["lb-xdffsfasdfs"]`;</li>
1970
1972
  <li>当 OriginType 为 origins 时,要求有且仅有一个元素,表示源站组ID,如`["origin-537f5b41-162a-11ed-abaa-525400c5da15"]`。</li>
1971
1973
  */
1972
1974
  OriginValue: Array<string>
@@ -4260,12 +4262,14 @@ export interface CreateApplicationProxyRuleRequest {
4260
4262
  /**
4261
4263
  * 源站类型,取值有:
4262
4264
  <li>custom:手动添加;</li>
4265
+ <li>loadbalancer:负载均衡;</li>
4263
4266
  <li>origins:源站组。</li>
4264
4267
  */
4265
4268
  OriginType: string
4266
4269
  /**
4267
4270
  * 源站信息:
4268
4271
  <li>当 OriginType 为 custom 时,表示一个或多个源站,如`["8.8.8.8","9.9.9.9"]` 或 `OriginValue=["test.com"]`;</li>
4272
+ <li>当 OriginType 为 loadbalancer 时,表示一个负载均衡,如`["lb-xdffsfasdfs"]`;</li>
4269
4273
  <li>当 OriginType 为 origins 时,要求有且仅有一个元素,表示源站组ID,如`["origin-537f5b41-162a-11ed-abaa-525400c5da15"]`。</li>
4270
4274
  */
4271
4275
  OriginValue: Array<string>
@@ -5507,9 +5511,7 @@ export interface CreateApplicationProxyRequest {
5507
5511
  */
5508
5512
  AccelerateType: number
5509
5513
  /**
5510
- * 四层代理模式,取值有:
5511
- <li>hostname:表示子域名模式;</li>
5512
- <li>instance:表示实例模式。</li>不填写使用默认值instance。
5514
+ * 四层代理模式,取值有: <li>instance:表示实例模式。</li>不填写使用默认值instance。
5513
5515
  */
5514
5516
  ProxyType?: string
5515
5517
  /**
@@ -5308,42 +5308,47 @@ export interface LaneInfo {
5308
5308
  * 泳道ID
5309
5309
  注意:此字段可能返回 null,表示取不到有效值。
5310
5310
  */
5311
- LaneId: string
5311
+ LaneId?: string
5312
5312
  /**
5313
5313
  * 泳道名称
5314
5314
  注意:此字段可能返回 null,表示取不到有效值。
5315
5315
  */
5316
- LaneName: string
5316
+ LaneName?: string
5317
5317
  /**
5318
5318
  * 泳道备注
5319
5319
  注意:此字段可能返回 null,表示取不到有效值。
5320
5320
  */
5321
- Remark: string
5321
+ Remark?: string
5322
5322
  /**
5323
5323
  * 创建时间
5324
5324
  注意:此字段可能返回 null,表示取不到有效值。
5325
5325
  */
5326
- CreateTime: number
5326
+ CreateTime?: number
5327
5327
  /**
5328
5328
  * 更新时间
5329
5329
  注意:此字段可能返回 null,表示取不到有效值。
5330
5330
  */
5331
- UpdateTime: number
5331
+ UpdateTime?: number
5332
5332
  /**
5333
5333
  * 泳道部署组
5334
5334
  注意:此字段可能返回 null,表示取不到有效值。
5335
5335
  */
5336
- LaneGroupList: Array<LaneGroup>
5336
+ LaneGroupList?: Array<LaneGroup>
5337
5337
  /**
5338
5338
  * 是否入口应用
5339
5339
  注意:此字段可能返回 null,表示取不到有效值。
5340
5340
  */
5341
- Entrance: boolean
5341
+ Entrance?: boolean
5342
5342
  /**
5343
5343
  * 泳道已经关联部署组的命名空间列表
5344
5344
  注意:此字段可能返回 null,表示取不到有效值。
5345
5345
  */
5346
- NamespaceIdList: Array<string>
5346
+ NamespaceIdList?: Array<string>
5347
+ /**
5348
+ * 泳道部署组ID
5349
+ 注意:此字段可能返回 null,表示取不到有效值。
5350
+ */
5351
+ LaneGroupId?: string
5347
5352
  }
5348
5353
 
5349
5354
  /**
@@ -131,7 +131,6 @@ import {
131
131
  CreateInLongAgentResponse,
132
132
  RuleGroupTable,
133
133
  DescribeInstanceLogRequest,
134
- DescribeKafkaTopicInfoRequest,
135
134
  DescribeRuleGroupSubscriptionResponse,
136
135
  DescribeIntegrationStatisticsTaskStatusTrendResponse,
137
136
  DeleteResourceFileRequest,
@@ -232,7 +231,6 @@ import {
232
231
  DescribeColumnsMetaRequest,
233
232
  DescribeOrganizationalFunctionsRequest,
234
233
  DescribeRuleTemplateResponse,
235
- DescribeKafkaTopicInfoResponse,
236
234
  OpsTaskCanvasInfoList,
237
235
  DescribeDependTaskListsRequest,
238
236
  DatabaseMeta,
@@ -4013,18 +4011,6 @@ export class Client extends AbstractClient {
4013
4011
  return this.request("DescribeTableMeta", req, cb)
4014
4012
  }
4015
4013
 
4016
- /**
4017
- * 没用到
4018
-
4019
- 获取kafka的topic信息
4020
- */
4021
- async DescribeKafkaTopicInfo(
4022
- req: DescribeKafkaTopicInfoRequest,
4023
- cb?: (error: string, rep: DescribeKafkaTopicInfoResponse) => void
4024
- ): Promise<DescribeKafkaTopicInfoResponse> {
4025
- return this.request("DescribeKafkaTopicInfo", req, cb)
4026
- }
4027
-
4028
4014
  /**
4029
4015
  * 提取数据集成节点字段Schema
4030
4016
  */
@@ -3962,20 +3962,6 @@ export interface DescribeInstanceLogRequest {
3962
3962
  OriginFileName: string
3963
3963
  }
3964
3964
 
3965
- /**
3966
- * DescribeKafkaTopicInfo请求参数结构体
3967
- */
3968
- export interface DescribeKafkaTopicInfoRequest {
3969
- /**
3970
- * 数据源id
3971
- */
3972
- DatasourceId: string
3973
- /**
3974
- * 数据源类型
3975
- */
3976
- Type: string
3977
- }
3978
-
3979
3965
  /**
3980
3966
  * DescribeRuleGroupSubscription返回参数结构体
3981
3967
  */
@@ -7200,16 +7186,6 @@ export interface DescribeRuleTemplateResponse {
7200
7186
  RequestId?: string
7201
7187
  }
7202
7188
 
7203
- /**
7204
- * DescribeKafkaTopicInfo返回参数结构体
7205
- */
7206
- export interface DescribeKafkaTopicInfoResponse {
7207
- /**
7208
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7209
- */
7210
- RequestId?: string
7211
- }
7212
-
7213
7189
  /**
7214
7190
  * 画布所需的信息
7215
7191
  */
@@ -1 +1 @@
1
- export declare const sdkVersion = "4.0.780";
1
+ export declare const sdkVersion = "4.0.782";
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.sdkVersion = void 0;
4
- exports.sdkVersion = "4.0.780";
4
+ exports.sdkVersion = "4.0.782";
@@ -605,11 +605,11 @@ export interface DescribeRedisTopBigKeysResponse {
605
605
  /**
606
606
  * top key列表。
607
607
  */
608
- TopKeys: Array<RedisKeySpaceData>;
608
+ TopKeys?: Array<RedisKeySpaceData>;
609
609
  /**
610
610
  * 采集时间戳(秒)。
611
611
  */
612
- Timestamp: number;
612
+ Timestamp?: number;
613
613
  /**
614
614
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
615
615
  */
@@ -2074,6 +2074,11 @@ export interface InstanceConfs {
2074
2074
  注意:此字段可能返回 null,表示取不到有效值。
2075
2075
  */
2076
2076
  KeyDelimiters?: Array<string>;
2077
+ /**
2078
+ * 分片节点数量。
2079
+ 注意:此字段可能返回 null,表示取不到有效值。
2080
+ */
2081
+ ShardNum?: string;
2077
2082
  }
2078
2083
  /**
2079
2084
  * 接收组信息
@@ -3047,6 +3052,14 @@ export interface DescribeRedisTopBigKeysRequest {
3047
3052
  * 查询数目,默认为20,最大值为100。
3048
3053
  */
3049
3054
  Limit?: number;
3055
+ /**
3056
+ * 异步任务ID。当为空时,选择最近任务的ID。
3057
+ */
3058
+ AsyncRequestId?: number;
3059
+ /**
3060
+ * 分片节点序号列表。当列表为空时,选择所有分片节点。
3061
+ */
3062
+ ShardIds?: Array<number | bigint>;
3050
3063
  }
3051
3064
  /**
3052
3065
  * DescribeIndexRecommendInfo返回参数结构体
@@ -501,15 +501,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
501
501
  */
502
502
  DescribeIntegrationEmployees(req: DescribeIntegrationEmployeesRequest, cb?: (error: string, rep: DescribeIntegrationEmployeesResponse) => void): Promise<DescribeIntegrationEmployeesResponse>;
503
503
  /**
504
- * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
504
+ * 该接口用于发起合同后,生成用户的签署链接 <br/>
505
505
 
506
506
  **注意**
507
- 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)
508
- 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
509
- 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
510
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
507
+ 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
508
+ 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
509
+ 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
511
510
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
512
- 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
511
+ 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
513
512
  */
514
513
  CreateFlowSignUrl(req: CreateFlowSignUrlRequest, cb?: (error: string, rep: CreateFlowSignUrlResponse) => void): Promise<CreateFlowSignUrlResponse>;
515
514
  /**
@@ -735,12 +734,68 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
735
734
  */
736
735
  DeleteExtendedServiceAuthInfos(req: DeleteExtendedServiceAuthInfosRequest, cb?: (error: string, rep: DeleteExtendedServiceAuthInfosResponse) => void): Promise<DeleteExtendedServiceAuthInfosResponse>;
737
736
  /**
738
- * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
737
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。
738
+ 支持以下场景
739
+ <table style="border-collapse: collapse; width: 100%;" border="1">
740
+ <tbody>
741
+ <tr>
742
+ <td style="width: 25%;">生成端</td>
743
+ <td style="width: 25%;">入参</td>
744
+ <td style="width: 25%;">提醒方式</td>
745
+ </tr>
746
+ <tr>
747
+ <td style="width: 25%;">普通saas员工</td>
748
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
749
+ <td style="width: 25%;">短信</td>
750
+ </tr>
751
+ <tr>
752
+ <td style="width: 25%;">企微员工</td>
753
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
754
+ <td style="width: 25%;">企微内部实名消息</td>
755
+ </tr>
756
+ <tr>
757
+ <td style="width: 25%;">H5端 saas员工</td>
758
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
759
+ <td style="width: 25%;">生成H5链接</td>
760
+ </tr>
761
+ </tbody>
762
+ </table>
763
+ 注意:
764
+
765
+ - <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
766
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
739
767
  */
740
768
  CreateIntegrationEmployees(req: CreateIntegrationEmployeesRequest, cb?: (error: string, rep: CreateIntegrationEmployeesResponse) => void): Promise<CreateIntegrationEmployeesResponse>;
741
769
  /**
742
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
743
- 可进行批量操作,Employees中的userID与openID二选一必填
770
+ * 此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)
771
+ 修改手机号的时候,支持以下场景进行提醒通知
772
+ <table style="border-collapse: collapse; width: 100%;" border="1">
773
+ <tbody>
774
+ <tr>
775
+ <td style="width: 25%;">生成端</td>
776
+ <td style="width: 25%;">入参</td>
777
+ <td style="width: 25%;">提醒方式</td>
778
+ </tr>
779
+ <tr>
780
+ <td style="width: 25%;">普通saas员工</td>
781
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
782
+ <td style="width: 25%;">短信</td>
783
+ </tr>
784
+ <tr>
785
+ <td style="width: 25%;">企微员工</td>
786
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
787
+ <td style="width: 25%;">企微内部实名消息</td>
788
+ </tr>
789
+ <tr>
790
+ <td style="width: 25%;">H5端 saas员工</td>
791
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
792
+ <td style="width: 25%;">生成H5链接</td>
793
+ </tr>
794
+ </tbody>
795
+ </table>
796
+ 注意:
797
+
798
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
744
799
  */
745
800
  UpdateIntegrationEmployees(req: UpdateIntegrationEmployeesRequest, cb?: (error: string, rep: UpdateIntegrationEmployeesResponse) => void): Promise<UpdateIntegrationEmployeesResponse>;
746
801
  }
@@ -609,15 +609,14 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
609
609
  return this.request("DescribeIntegrationEmployees", req, cb);
610
610
  }
611
611
  /**
612
- * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
612
+ * 该接口用于发起合同后,生成用户的签署链接 <br/>
613
613
 
614
614
  **注意**
615
- 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)
616
- 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
617
- 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
618
- 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
615
+ 1. 该接口可生成签署链接的签署人必须仅有手写签名、时间类型和印章类型的签署控件,**不支持填写控件**
616
+ 2. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
617
+ 3. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
619
618
  跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
620
- 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
619
+ 4. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
621
620
  */
622
621
  async CreateFlowSignUrl(req, cb) {
623
622
  return this.request("CreateFlowSignUrl", req, cb);
@@ -893,14 +892,70 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
893
892
  return this.request("DeleteExtendedServiceAuthInfos", req, cb);
894
893
  }
895
894
  /**
896
- * 此接口(CreateIntegrationEmployees)用于创建企业员工。调用成功后会给员工发送提醒员工实名的短信。若通过手机号发现员工已经创建,则不会重新创建,但会发送短信提醒员工实名。另外,此接口还支持通过企微组织架构的openid 创建员工(将WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内),该场景下,员工会接收到提醒实名的企微消息。
895
+ * 此接口(CreateIntegrationEmployees)用于创建企业员工。
896
+ 支持以下场景
897
+ <table style="border-collapse: collapse; width: 100%;" border="1">
898
+ <tbody>
899
+ <tr>
900
+ <td style="width: 25%;">生成端</td>
901
+ <td style="width: 25%;">入参</td>
902
+ <td style="width: 25%;">提醒方式</td>
903
+ </tr>
904
+ <tr>
905
+ <td style="width: 25%;">普通saas员工</td>
906
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
907
+ <td style="width: 25%;">短信</td>
908
+ </tr>
909
+ <tr>
910
+ <td style="width: 25%;">企微员工</td>
911
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
912
+ <td style="width: 25%;">企微内部实名消息</td>
913
+ </tr>
914
+ <tr>
915
+ <td style="width: 25%;">H5端 saas员工</td>
916
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
917
+ <td style="width: 25%;">生成H5链接</td>
918
+ </tr>
919
+ </tbody>
920
+ </table>
921
+ 注意:
922
+
923
+ - <b>若通过手机号发现员工已经创建,则不会重复创建,但会发送短信或者生成链接提醒员工实名。</b>
924
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
897
925
  */
898
926
  async CreateIntegrationEmployees(req, cb) {
899
927
  return this.request("CreateIntegrationEmployees", req, cb);
900
928
  }
901
929
  /**
902
- * 更新员工信息(姓名,手机号,邮件、部门),用户实名后无法更改姓名与手机号。
903
- 可进行批量操作,Employees中的userID与openID二选一必填
930
+ * 此接口(UpdateIntegrationEmployees)用于修改未实名企业员工信息(姓名,手机号,邮件、部门)
931
+ 修改手机号的时候,支持以下场景进行提醒通知
932
+ <table style="border-collapse: collapse; width: 100%;" border="1">
933
+ <tbody>
934
+ <tr>
935
+ <td style="width: 25%;">生成端</td>
936
+ <td style="width: 25%;">入参</td>
937
+ <td style="width: 25%;">提醒方式</td>
938
+ </tr>
939
+ <tr>
940
+ <td style="width: 25%;">普通saas员工</td>
941
+ <td style="width: 25%;">不需要传递 InvitationNotifyType</td>
942
+ <td style="width: 25%;">短信</td>
943
+ </tr>
944
+ <tr>
945
+ <td style="width: 25%;">企微员工</td>
946
+ <td style="width: 25%;">不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
947
+ <td style="width: 25%;">企微内部实名消息</td>
948
+ </tr>
949
+ <tr>
950
+ <td style="width: 25%;">H5端 saas员工</td>
951
+ <td style="width: 25%;">传递 InvitationNotifyType = H5,不支持企微</td>
952
+ <td style="width: 25%;">生成H5链接</td>
953
+ </tr>
954
+ </tbody>
955
+ </table>
956
+ 注意:
957
+
958
+ - jumpUrl 仅支持H5的邀请方式,回跳的url,使用前请联系对接的客户经理沟通,进行域名的配置。
904
959
  */
905
960
  async UpdateIntegrationEmployees(req, cb) {
906
961
  return this.request("UpdateIntegrationEmployees", req, cb);
@@ -755,6 +755,19 @@ export interface CreateIntegrationEmployeesRequest {
755
755
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
756
756
  */
757
757
  Agent?: Agent;
758
+ /**
759
+ * 员工邀请方式
760
+ 如果是来自H5的,参数需要传递H5
761
+ 短信或者企微 请传递SMS,或者不传递
762
+ */
763
+ InvitationNotifyType?: string;
764
+ /**
765
+ * 回跳地址,
766
+ 在认证成功之后,进行回跳,请保证回跳地址的可用性。
767
+ 使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置
768
+
769
+ */
770
+ JumpUrl?: string;
758
771
  }
759
772
  /**
760
773
  * 创建合同个性化参数
@@ -4545,14 +4558,6 @@ export interface CreateFlowSignUrlRequest {
4545
4558
  可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4546
4559
  */
4547
4560
  FlowId: string;
4548
- /**
4549
- * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
4550
-
4551
- 注:
4552
- `1. ApproverType目前只支持个人类型的签署人。`
4553
- `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4554
- */
4555
- FlowApproverInfos: Array<FlowCreateApprover>;
4556
4561
  /**
4557
4562
  * 执行本接口操作的员工信息。
4558
4563
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
@@ -4563,6 +4568,14 @@ export interface CreateFlowSignUrlRequest {
4563
4568
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4564
4569
  */
4565
4570
  Agent?: Agent;
4571
+ /**
4572
+ * 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,企业签署人则需传OrganizationName,其他可不传。
4573
+
4574
+ 注:
4575
+ `1. 签署人只能有手写签名、时间类型和印章类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4576
+ `2. 生成发起方预览链接时,该字段(FlowApproverInfos)传空或者不传`
4577
+ */
4578
+ FlowApproverInfos?: Array<FlowCreateApprover>;
4566
4579
  /**
4567
4580
  * 机构信息,暂未开放
4568
4581
  * @deprecated
@@ -4572,6 +4585,15 @@ export interface CreateFlowSignUrlRequest {
4572
4585
  * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
4573
4586
  */
4574
4587
  JumpUrl?: string;
4588
+ /**
4589
+ * 链接类型,支持指定以下类型
4590
+ <ul><li>0 : 签署链接 (默认值)</li>
4591
+ <li>1 : 预览链接</li></ul>
4592
+ 注:
4593
+ `1. 当指定链接类型为1时,链接为预览链接,打开链接无法签署仅支持预览以及查看当前合同状态。`
4594
+ `2. 如需生成发起方预览链接,则签署方信息传空,即FlowApproverInfos传空或者不传。`
4595
+ */
4596
+ UrlType?: number;
4575
4597
  }
4576
4598
  /**
4577
4599
  * CreateReleaseFlow请求参数结构体
@@ -4689,7 +4711,9 @@ export interface FlowDetailInfo {
4689
4711
  Creator?: string;
4690
4712
  }
4691
4713
  /**
4692
- * 更新员工信息成功返回的数据信息
4714
+ * 更新员工信息成功返回的数据信息, 仅支持未实名的用户进行更新
4715
+ 会通过短信、企微消息或者H5Url 链接
4716
+ 如果是通过H5邀请加入的方式,会返回H5 链接
4693
4717
  */
4694
4718
  export interface SuccessUpdateStaffData {
4695
4719
  /**
@@ -4705,6 +4729,12 @@ export interface SuccessUpdateStaffData {
4705
4729
  可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
4706
4730
  */
4707
4731
  UserId?: string;
4732
+ /**
4733
+ * H5端员工实名链接
4734
+
4735
+ 只有入参 InvitationNotifyType = H5的时候才会进行返回。
4736
+ */
4737
+ Url?: string;
4708
4738
  }
4709
4739
  /**
4710
4740
  * CreatePersonAuthCertificateImage请求参数结构体
@@ -4794,7 +4824,8 @@ export interface UploadFilesResponse {
4794
4824
  RequestId?: string;
4795
4825
  }
4796
4826
  /**
4797
- * 创建员工的成功数据
4827
+ * 创建员工成功返回的信息
4828
+ 支持saas/企微/H5端进行加入。
4798
4829
  */
4799
4830
  export interface SuccessCreateStaffData {
4800
4831
  /**
@@ -4818,6 +4849,12 @@ export interface SuccessCreateStaffData {
4818
4849
  * 传入的企微账号id
4819
4850
  */
4820
4851
  WeworkOpenId?: string;
4852
+ /**
4853
+ * H5端员工加入\实名链接
4854
+
4855
+ 只有入参 InvitationNotifyType = H5的时候才会进行返回。
4856
+ */
4857
+ Url?: string;
4821
4858
  }
4822
4859
  /**
4823
4860
  * 流程中参与方的信息结构
@@ -6001,8 +6038,9 @@ export interface Component {
6001
6038
  <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
6002
6039
  <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
6003
6040
 
6004
- **如果是SignComponent签署控件类型,则可选的字段为**
6005
-
6041
+ **如果是SignComponent签署控件类型,
6042
+ 需要根据签署人的类型可选的字段为**
6043
+ * 企业方
6006
6044
  <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
6007
6045
  <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6008
6046
  <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
@@ -6010,6 +6048,12 @@ export interface Component {
6010
6048
  <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
6011
6049
  <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
6012
6050
  <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
6051
+
6052
+ * 个人方
6053
+ <ul><li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6054
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
6055
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li></ul>
6056
+
6013
6057
  注:` 表单域的控件不能作为印章和签名控件`
6014
6058
  */
6015
6059
  ComponentType: string;
@@ -6436,6 +6480,18 @@ export interface UpdateIntegrationEmployeesRequest {
6436
6480
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6437
6481
  */
6438
6482
  Agent?: Agent;
6483
+ /**
6484
+ * 员工邀请方式
6485
+ 如果是来自H5的,参数需要传递H5
6486
+ 短信或者企微 请传递SMS,或者不传递
6487
+ */
6488
+ InvitationNotifyType?: string;
6489
+ /**
6490
+ * 回跳地址,
6491
+ 在认证成功之后,进行回跳,请保证回跳地址的可用性。
6492
+ 使用前请联系对接的客户经理沟通,提供回跳地址的域名,进行域名配置。
6493
+ */
6494
+ JumpUrl?: string;
6439
6495
  }
6440
6496
  /**
6441
6497
  * DescribeFlowBriefs请求参数结构体