tencentcloud-sdk-nodejs 4.0.759 → 4.0.760

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 (64) hide show
  1. package/CHANGELOG.md +270 -0
  2. package/SERVICE_CHANGELOG.md +481 -8
  3. package/package.json +1 -1
  4. package/products.md +22 -22
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/batch/v20170312/batch_models.ts +2 -2
  7. package/src/services/cdwdoris/v20211228/cdwdoris_client.ts +2 -2
  8. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +3 -3
  9. package/src/services/cls/v20201016/cls_models.ts +1 -1
  10. package/src/services/csip/v20221121/csip_client.ts +13 -0
  11. package/src/services/csip/v20221121/csip_models.ts +152 -0
  12. package/src/services/cynosdb/v20190107/cynosdb_models.ts +4 -4
  13. package/src/services/dlc/v20210125/dlc_models.ts +17 -1
  14. package/src/services/eb/v20210416/eb_models.ts +24 -15
  15. package/src/services/ess/v20201111/ess_client.ts +23 -6
  16. package/src/services/ess/v20201111/ess_models.ts +167 -28
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +41 -1
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +271 -73
  19. package/src/services/facefusion/v20220927/facefusion_models.ts +2 -2
  20. package/src/services/iai/v20180301/iai_models.ts +1 -1
  21. package/src/services/iai/v20200303/iai_models.ts +1 -1
  22. package/src/services/ioa/v20220601/ioa_client.ts +1 -0
  23. package/src/services/ioa/v20220601/ioa_models.ts +226 -0
  24. package/src/services/monitor/v20180724/monitor_client.ts +3 -2
  25. package/src/services/monitor/v20180724/monitor_models.ts +46 -10
  26. package/src/services/ssl/v20191205/ssl_models.ts +8 -0
  27. package/src/services/tat/v20201028/tat_models.ts +96 -101
  28. package/src/services/teo/v20220901/teo_models.ts +10 -10
  29. package/src/services/trtc/v20190722/trtc_models.ts +1 -1
  30. package/src/services/wedata/v20210820/wedata_models.ts +26 -8
  31. package/tencentcloud/common/sdk_version.d.ts +1 -1
  32. package/tencentcloud/common/sdk_version.js +1 -1
  33. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +2 -2
  34. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_client.d.ts +2 -2
  35. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_client.js +2 -2
  36. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +3 -3
  37. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +1 -1
  38. package/tencentcloud/services/csip/v20221121/csip_client.d.ts +5 -1
  39. package/tencentcloud/services/csip/v20221121/csip_client.js +6 -0
  40. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +149 -0
  41. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +4 -4
  42. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +17 -1
  43. package/tencentcloud/services/eb/v20210416/eb_models.d.ts +24 -15
  44. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +11 -4
  45. package/tencentcloud/services/ess/v20201111/ess_client.js +12 -3
  46. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +163 -28
  47. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +22 -1
  48. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +25 -0
  49. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +264 -73
  50. package/tencentcloud/services/facefusion/v20220927/facefusion_models.d.ts +2 -2
  51. package/tencentcloud/services/iai/v20180301/iai_models.d.ts +1 -1
  52. package/tencentcloud/services/iai/v20200303/iai_models.d.ts +1 -1
  53. package/tencentcloud/services/ioa/v20220601/ioa_models.d.ts +225 -0
  54. package/tencentcloud/services/monitor/v20180724/monitor_client.d.ts +2 -2
  55. package/tencentcloud/services/monitor/v20180724/monitor_client.js +2 -2
  56. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +45 -10
  57. package/tencentcloud/services/ssl/v20191205/ssl_models.d.ts +8 -0
  58. package/tencentcloud/services/tat/v20201028/tat_models.d.ts +95 -100
  59. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +10 -10
  60. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
  61. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +26 -8
  62. package/test/csip.v20221121.test.js +10 -0
  63. package/test/ess.v20201111.test.js +10 -0
  64. package/test/essbasic.v20210526.test.js +20 -0
@@ -462,6 +462,20 @@ export interface ChannelDisableUserAutoSignResponse {
462
462
  */
463
463
  RequestId?: string;
464
464
  }
465
+ /**
466
+ * DescribeExtendedServiceAuthDetail返回参数结构体
467
+ */
468
+ export interface DescribeExtendedServiceAuthDetailResponse {
469
+ /**
470
+ * 服务授权的信息列表,根据查询类型返回特定扩展服务的开通和授权状况。
471
+ 注意:此字段可能返回 null,表示取不到有效值。
472
+ */
473
+ AuthInfoDetail?: AuthInfoDetail;
474
+ /**
475
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
476
+ */
477
+ RequestId?: string;
478
+ }
465
479
  /**
466
480
  * 第三方应用集成员工部门信息
467
481
  */
@@ -674,6 +688,41 @@ export interface DescribeResourceUrlsByFlowsRequest {
674
688
  */
675
689
  Operator?: UserInfo;
676
690
  }
691
+ /**
692
+ * 企业扩展服务授权列表详情
693
+ */
694
+ export interface AuthInfoDetail {
695
+ /**
696
+ * 扩展服务类型,和入参一致
697
+ 注意:此字段可能返回 null,表示取不到有效值。
698
+ */
699
+ Type?: string;
700
+ /**
701
+ * 扩展服务名称
702
+ 注意:此字段可能返回 null,表示取不到有效值。
703
+ */
704
+ Name?: string;
705
+ /**
706
+ * 授权员工列表
707
+ 注意:此字段可能返回 null,表示取不到有效值。
708
+ */
709
+ HasAuthUserList?: Array<HasAuthUser>;
710
+ /**
711
+ * 授权企业列表(企业自动签时,该字段有值)
712
+ 注意:此字段可能返回 null,表示取不到有效值。
713
+ */
714
+ HasAuthOrganizationList?: Array<HasAuthOrganization>;
715
+ /**
716
+ * 授权员工列表总数
717
+ 注意:此字段可能返回 null,表示取不到有效值。
718
+ */
719
+ AuthUserTotal?: number;
720
+ /**
721
+ * 授权企业列表总数
722
+ 注意:此字段可能返回 null,表示取不到有效值。
723
+ */
724
+ AuthOrganizationTotal?: number;
725
+ }
677
726
  /**
678
727
  * CreateChannelOrganizationInfoChangeUrl返回参数结构体
679
728
  */
@@ -721,6 +770,18 @@ export interface ChannelCreateFlowSignUrlResponse {
721
770
  */
722
771
  RequestId?: string;
723
772
  }
773
+ /**
774
+ * 被授权的用户信息
775
+ */
776
+ export interface HasAuthUser {
777
+ /**
778
+ * 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
779
+
780
+
781
+ 注意:此字段可能返回 null,表示取不到有效值。
782
+ */
783
+ OpenId?: string;
784
+ }
724
785
  /**
725
786
  * ChannelCreateBatchSignUrl返回参数结构体
726
787
  */
@@ -1014,7 +1075,6 @@ export interface BaseFlowInfo {
1014
1075
  /**
1015
1076
  * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1016
1077
 
1017
- 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
1018
1078
  */
1019
1079
  CcInfos?: Array<CcInfo>;
1020
1080
  /**
@@ -2819,9 +2879,9 @@ export interface Permission {
2819
2879
  Children?: Array<Permission>;
2820
2880
  }
2821
2881
  /**
2822
- * DescribeTemplates请求参数结构体
2882
+ * DescribeExtendedServiceAuthDetail请求参数结构体
2823
2883
  */
2824
- export interface DescribeTemplatesRequest {
2884
+ export interface DescribeExtendedServiceAuthDetailRequest {
2825
2885
  /**
2826
2886
  * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2827
2887
 
@@ -2835,83 +2895,22 @@ export interface DescribeTemplatesRequest {
2835
2895
  */
2836
2896
  Agent: Agent;
2837
2897
  /**
2838
- * 合同模板ID,为32位字符串。
2839
-
2840
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
2841
- */
2842
- TemplateId?: string;
2843
- /**
2844
- * 查询模板的内容
2845
-
2846
- <ul><li>**0**:(默认)模板列表及详情</li>
2847
- <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
2848
- */
2849
- ContentType?: number;
2850
- /**
2851
- * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
2852
-
2853
- 注意:
2854
- 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
2855
- 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
2856
- 4. `若传递此参数,分页参数(Limit,Offset)无效`
2898
+ * 要查询的扩展服务类型。
2899
+ 如下所示:
2900
+ <ul><li> AUTO_SIGN:企业静默签署</li>
2901
+ <li>BATCH_SIGN:批量签署</li>
2902
+ </ul>
2857
2903
 
2858
2904
  */
2859
- TemplateIds?: Array<string>;
2905
+ ExtendServiceType: string;
2860
2906
  /**
2861
- * 指定每页返回的数据条数,和Offset参数配合使用。
2862
-
2863
- 注:`1.默认值为20,单页做大值为200。`
2907
+ * 指定每页返回的数据条数,和Offset参数配合使用。 注:`1.默认值为20,单页做大值为200。`
2864
2908
  */
2865
2909
  Limit?: number;
2866
2910
  /**
2867
- * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
2868
-
2869
- 注:`1.offset从0开始,即第一页为0。`
2870
- `2.默认从第一页返回。`
2911
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。 注:`1.offset从0开始,即第一页为0。` `2.默认从第一页返回。`
2871
2912
  */
2872
2913
  Offset?: number;
2873
- /**
2874
- * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
2875
- */
2876
- TemplateName?: string;
2877
- /**
2878
- * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
2879
- */
2880
- ChannelTemplateId?: string;
2881
- /**
2882
- * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
2883
-
2884
- <ul><li>**false**:(默认)只返回发起方控件</li>
2885
- <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
2886
- */
2887
- QueryAllComponents?: boolean;
2888
- /**
2889
- * 是否获取模板预览链接。
2890
-
2891
- <ul><li>**false**:不获取(默认)</li>
2892
- <li>**true**:获取</li></ul>
2893
-
2894
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
2895
-
2896
- 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
2897
- */
2898
- WithPreviewUrl?: boolean;
2899
- /**
2900
- * 是否获取模板的PDF文件链接。
2901
-
2902
- <ul><li>**false**:不获取(默认)</li>
2903
- <li>**true**:获取</li></ul>
2904
-
2905
- 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
2906
-
2907
- 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
2908
- */
2909
- WithPdfUrl?: boolean;
2910
- /**
2911
- * 操作者的信息
2912
- * @deprecated
2913
- */
2914
- Operator?: UserInfo;
2915
2914
  }
2916
2915
  /**
2917
2916
  * 企业批量注册链接信息
@@ -3753,6 +3752,29 @@ export interface DescribeChannelSealPolicyWorkflowUrlRequest {
3753
3752
  */
3754
3753
  Endpoint?: string;
3755
3754
  }
3755
+ /**
3756
+ * CreatePartnerAutoSignAuthUrl返回参数结构体
3757
+ */
3758
+ export interface CreatePartnerAutoSignAuthUrlResponse {
3759
+ /**
3760
+ * 授权链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
3761
+ 注意:此字段可能返回 null,表示取不到有效值。
3762
+ */
3763
+ Url?: string;
3764
+ /**
3765
+ * 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
3766
+
3767
+ */
3768
+ MiniAppPath?: string;
3769
+ /**
3770
+ * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
3771
+ */
3772
+ ExpireTime?: number;
3773
+ /**
3774
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3775
+ */
3776
+ RequestId?: string;
3777
+ }
3756
3778
  /**
3757
3779
  * 此结构体 (FlowInfo) 用于描述签署流程信息。
3758
3780
  */
@@ -3958,6 +3980,36 @@ export interface ApproverComponentLimitType {
3958
3980
  */
3959
3981
  Values?: Array<string>;
3960
3982
  }
3983
+ /**
3984
+ * 授权企业列表(目前仅用于“企业自动签 -> 合作企业授权”)
3985
+ */
3986
+ export interface HasAuthOrganization {
3987
+ /**
3988
+ * 授权企业openid,
3989
+ 注意:此字段可能返回 null,表示取不到有效值。
3990
+ */
3991
+ OrganizationOpenId?: string;
3992
+ /**
3993
+ * 授权企业名称
3994
+ 注意:此字段可能返回 null,表示取不到有效值。
3995
+ */
3996
+ OrganizationName?: string;
3997
+ /**
3998
+ * 被授权企业openid,
3999
+ 注意:此字段可能返回 null,表示取不到有效值。
4000
+ */
4001
+ AuthorizedOrganizationOpenId?: string;
4002
+ /**
4003
+ * 被授权企业名称
4004
+ 注意:此字段可能返回 null,表示取不到有效值。
4005
+ */
4006
+ AuthorizedOrganizationName?: string;
4007
+ /**
4008
+ * 授权时间,格式为时间戳,单位s
4009
+ 注意:此字段可能返回 null,表示取不到有效值。
4010
+ */
4011
+ AuthorizeTime?: number;
4012
+ }
3961
4013
  /**
3962
4014
  * 资源链接信息
3963
4015
  */
@@ -4027,6 +4079,14 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
4027
4079
  <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
4028
4080
  */
4029
4081
  ApproverSignTypes?: Array<number | bigint>;
4082
+ /**
4083
+ * 生成H5签署链接时,你可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
4084
+ <ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
4085
+ <li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
4086
+ 注:
4087
+ `不指定该值时,默认为签署方自行选择。`
4088
+ */
4089
+ SignTypeSelector?: number;
4030
4090
  }
4031
4091
  /**
4032
4092
  * ChannelCreateBoundFlows请求参数结构体
@@ -4683,6 +4743,14 @@ export interface FlowApproverInfo {
4683
4743
  注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
4684
4744
  */
4685
4745
  ApproverRoleName?: string;
4746
+ /**
4747
+ * 生成H5签署链接时,你可以指定签署方签署合同的认证校验方式的选择模式,可传递一下值:
4748
+ <ul><li>**0**:签署方自行选择,签署方可以从预先指定的认证方式中自由选择;</li>
4749
+ <li>**1**:自动按顺序首位推荐,签署方无需选择,系统会优先推荐使用第一种认证方式。</li></ul>
4750
+ 注:
4751
+ `不指定该值时,默认为签署方自行选择。`
4752
+ */
4753
+ SignTypeSelector?: number;
4686
4754
  }
4687
4755
  /**
4688
4756
  * ChannelCreateUserAutoSignEnableUrl返回参数结构体
@@ -5376,6 +5444,33 @@ export interface ChannelCreateBatchQuickSignUrlResponse {
5376
5444
  */
5377
5445
  RequestId?: string;
5378
5446
  }
5447
+ /**
5448
+ * CreatePartnerAutoSignAuthUrl请求参数结构体
5449
+ */
5450
+ export interface CreatePartnerAutoSignAuthUrlRequest {
5451
+ /**
5452
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5453
+
5454
+ 此接口下面信息必填。
5455
+ <ul>
5456
+ <li>渠道应用标识: Agent.AppId</li>
5457
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5458
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5459
+ </ul>
5460
+ 第三方平台子客企业和员工必须已经经过实名认证
5461
+ */
5462
+ Agent: Agent;
5463
+ /**
5464
+ * 被授企业id,和AuthorizedOrganizationName二选一,不能同时为空
5465
+ 注:`被授权企业必须和当前企业在同一应用号下`
5466
+ */
5467
+ AuthorizedOrganizationId?: string;
5468
+ /**
5469
+ * 被授权企业名,和AuthorizedOrganizationId二选一,不能同时为空
5470
+ 注:`被授权企业必须和当前企业在同一应用号下`
5471
+ */
5472
+ AuthorizedOrganizationName?: string;
5473
+ }
5379
5474
  /**
5380
5475
  * ChannelCreateBatchCancelFlowUrl请求参数结构体
5381
5476
  */
@@ -6915,7 +7010,8 @@ export interface CreateSealByImageRequest {
6915
7010
  * 印章尺寸取值描述, 可以选择的尺寸如下:
6916
7011
  <ul><li> **42_42**: 圆形企业公章直径42mm, 当SealStyle是圆形的时候才有效</li>
6917
7012
  <li> **40_40**: 圆形企业印章直径40mm, 当SealStyle是圆形的时候才有效</li>
6918
- <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
7013
+ <li> **45_30**: 椭圆形印章45mm x 30mm, 当SealStyle是椭圆的时候才有效</li>
7014
+ <li> **40_30**: 椭圆形印章40mm x 30mm, 当SealStyle是椭圆的时候才有效</li></ul>
6919
7015
  */
6920
7016
  SealSize?: string;
6921
7017
  /**
@@ -7017,6 +7113,101 @@ export interface ChannelCreateFlowSignUrlRequest {
7017
7113
  */
7018
7114
  JumpUrl?: string;
7019
7115
  }
7116
+ /**
7117
+ * DescribeTemplates请求参数结构体
7118
+ */
7119
+ export interface DescribeTemplatesRequest {
7120
+ /**
7121
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7122
+
7123
+ 此接口下面信息必填。
7124
+ <ul>
7125
+ <li>渠道应用标识: Agent.AppId</li>
7126
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7127
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
7128
+ </ul>
7129
+ 第三方平台子客企业和员工必须已经经过实名认证
7130
+ */
7131
+ Agent: Agent;
7132
+ /**
7133
+ * 合同模板ID,为32位字符串。
7134
+
7135
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
7136
+ */
7137
+ TemplateId?: string;
7138
+ /**
7139
+ * 查询模板的内容
7140
+
7141
+ <ul><li>**0**:(默认)模板列表及详情</li>
7142
+ <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
7143
+ */
7144
+ ContentType?: number;
7145
+ /**
7146
+ * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
7147
+
7148
+ 注意:
7149
+ 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
7150
+ 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
7151
+ 4. `若传递此参数,分页参数(Limit,Offset)无效`
7152
+
7153
+ */
7154
+ TemplateIds?: Array<string>;
7155
+ /**
7156
+ * 指定每页返回的数据条数,和Offset参数配合使用。
7157
+
7158
+ 注:`1.默认值为20,单页做大值为200。`
7159
+ */
7160
+ Limit?: number;
7161
+ /**
7162
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
7163
+
7164
+ 注:`1.offset从0开始,即第一页为0。`
7165
+ `2.默认从第一页返回。`
7166
+ */
7167
+ Offset?: number;
7168
+ /**
7169
+ * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
7170
+ */
7171
+ TemplateName?: string;
7172
+ /**
7173
+ * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
7174
+ */
7175
+ ChannelTemplateId?: string;
7176
+ /**
7177
+ * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
7178
+
7179
+ <ul><li>**false**:(默认)只返回发起方控件</li>
7180
+ <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
7181
+ */
7182
+ QueryAllComponents?: boolean;
7183
+ /**
7184
+ * 是否获取模板预览链接。
7185
+
7186
+ <ul><li>**false**:不获取(默认)</li>
7187
+ <li>**true**:获取</li></ul>
7188
+
7189
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
7190
+
7191
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
7192
+ */
7193
+ WithPreviewUrl?: boolean;
7194
+ /**
7195
+ * 是否获取模板的PDF文件链接。
7196
+
7197
+ <ul><li>**false**:不获取(默认)</li>
7198
+ <li>**true**:获取</li></ul>
7199
+
7200
+ 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
7201
+
7202
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
7203
+ */
7204
+ WithPdfUrl?: boolean;
7205
+ /**
7206
+ * 操作者的信息
7207
+ * @deprecated
7208
+ */
7209
+ Operator?: UserInfo;
7210
+ }
7020
7211
  /**
7021
7212
  * DescribeExtendedServiceAuthInfo返回参数结构体
7022
7213
  */
@@ -118,11 +118,11 @@ export interface MergeInfo {
118
118
  */
119
119
  InputImageFaceRect?: FaceRect;
120
120
  /**
121
- * 控制台上传的素材人脸ID,不填默认取最大人脸。此字段仅适用于控制台上传素材的有素材场景。
121
+ * 素材人脸ID,不填默认取最大人脸。
122
122
  */
123
123
  TemplateFaceID?: string;
124
124
  /**
125
- * 模版图片人脸位置信息(人脸框),不填默认取最大人脸。此字段仅适用于自定义模版素材场景。
125
+ * 模版中人脸位置信息(人脸框),不填默认取最大人脸。此字段仅适用于图片融合自定义模版素材场景。
126
126
  */
127
127
  TemplateFaceRect?: FaceRect;
128
128
  }
@@ -214,7 +214,7 @@ export interface CreateFaceResponse {
214
214
  */
215
215
  SucFaceIds?: Array<string>;
216
216
  /**
217
- * 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,
217
+ * 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,-1109 代表图片尺寸过大或者过小,
218
218
  -1601代表不符合图片质量控制要求, -1604 代表人脸相似度没有超过FaceMatchThreshold。
219
219
  其他非 0 值代表算法服务异常。
220
220
  RetCode的顺序和入参中 Images 或 Urls 的顺序一致。
@@ -216,7 +216,7 @@ export interface CreateFaceResponse {
216
216
  */
217
217
  SucFaceIds?: Array<string>;
218
218
  /**
219
- * 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,
219
+ * 每张人脸图片添加结果,-1101 代表未检测到人脸,-1102 代表图片解码失败,-1109 代表图片尺寸过大或者过小,
220
220
  -1601代表不符合图片质量控制要求, -1604 代表人脸相似度没有超过FaceMatchThreshold。
221
221
  其他非 0 值代表算法服务异常。
222
222
  RetCode的顺序和入参中 Images 或 Urls 的顺序一致。