tencentcloud-sdk-nodejs 4.0.763 → 4.0.764

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 (58) hide show
  1. package/CHANGELOG.md +205 -0
  2. package/SERVICE_CHANGELOG.md +291 -50
  3. package/package.json +1 -1
  4. package/products.md +18 -18
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/v20201229/ams_client.ts +1 -2
  7. package/src/services/ams/v20201229/ams_models.ts +67 -1
  8. package/src/services/bi/v20220105/bi_models.ts +5 -0
  9. package/src/services/ccc/v20200210/ccc_models.ts +31 -28
  10. package/src/services/cdb/v20170320/cdb_client.ts +2 -2
  11. package/src/services/cdb/v20170320/cdb_models.ts +31 -22
  12. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +5 -0
  13. package/src/services/cvm/v20170312/cvm_client.ts +3 -3
  14. package/src/services/cvm/v20170312/cvm_models.ts +11 -8
  15. package/src/services/dnspod/v20210323/dnspod_models.ts +4 -0
  16. package/src/services/dts/v20211206/dts_models.ts +1 -1
  17. package/src/services/ess/v20201111/ess_models.ts +143 -170
  18. package/src/services/essbasic/v20210526/essbasic_client.ts +3 -1
  19. package/src/services/essbasic/v20210526/essbasic_models.ts +4 -1
  20. package/src/services/faceid/v20180301/faceid_client.ts +2 -0
  21. package/src/services/faceid/v20180301/faceid_models.ts +36 -0
  22. package/src/services/redis/v20180412/redis_models.ts +23 -14
  23. package/src/services/tag/v20180813/tag_models.ts +1 -1
  24. package/src/services/trp/v20210515/trp_client.ts +20 -7
  25. package/src/services/trp/v20210515/trp_models.ts +141 -48
  26. package/src/services/vm/v20210922/vm_client.ts +1 -0
  27. package/src/services/vm/v20210922/vm_models.ts +67 -0
  28. package/src/services/vpc/v20170312/vpc_client.ts +32 -16
  29. package/tencentcloud/common/sdk_version.d.ts +1 -1
  30. package/tencentcloud/common/sdk_version.js +1 -1
  31. package/tencentcloud/services/ams/v20201229/ams_client.d.ts +0 -2
  32. package/tencentcloud/services/ams/v20201229/ams_client.js +0 -2
  33. package/tencentcloud/services/ams/v20201229/ams_models.d.ts +66 -1
  34. package/tencentcloud/services/bi/v20220105/bi_models.d.ts +5 -0
  35. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +31 -28
  36. package/tencentcloud/services/cdb/v20170320/cdb_client.d.ts +2 -2
  37. package/tencentcloud/services/cdb/v20170320/cdb_client.js +2 -2
  38. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +31 -22
  39. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +5 -0
  40. package/tencentcloud/services/cvm/v20170312/cvm_client.d.ts +3 -3
  41. package/tencentcloud/services/cvm/v20170312/cvm_client.js +3 -3
  42. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +11 -8
  43. package/tencentcloud/services/dnspod/v20210323/dnspod_models.d.ts +4 -0
  44. package/tencentcloud/services/dts/v20211206/dts_models.d.ts +1 -1
  45. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +143 -170
  46. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -1
  47. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -1
  48. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +4 -1
  49. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +34 -0
  50. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +23 -14
  51. package/tencentcloud/services/tag/v20180813/tag_models.d.ts +1 -1
  52. package/tencentcloud/services/trp/v20210515/trp_client.d.ts +7 -3
  53. package/tencentcloud/services/trp/v20210515/trp_client.js +9 -3
  54. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +138 -48
  55. package/tencentcloud/services/vm/v20210922/vm_models.d.ts +66 -0
  56. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +16 -0
  57. package/tencentcloud/services/vpc/v20170312/vpc_client.js +16 -0
  58. package/test/trp.v20210515.test.js +12 -2
@@ -5834,263 +5834,233 @@ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.
5834
5834
  */
5835
5835
  export interface Component {
5836
5836
  /**
5837
- * 如果是Component填写控件类型,则可选的字段为:
5838
- TEXT - 普通文本控件,输入文本字符串;
5839
- MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
5840
- CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
5841
- FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
5842
- DYNAMIC_TABLE - 动态表格控件;
5843
- ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;
5844
- SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
5845
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
5846
- DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
5847
-
5848
- 如果是SignComponent签署控件类型,则可选的字段为
5849
- SIGN_SEAL - 签署印章控件;
5850
- SIGN_DATE - 签署日期控件;
5851
- SIGN_SIGNATURE - 用户签名控件;
5852
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
5853
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
5854
- SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
5855
- SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
5856
-
5857
- 表单域的控件不能作为印章和签名控件
5837
+ * **如果是Component填写控件类型,则可选的字段为**:
5838
+
5839
+ <ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
5840
+ <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
5841
+ <li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
5842
+ <li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
5843
+ <li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
5844
+ <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
5845
+ <li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
5846
+ <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
5847
+ <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
5848
+
5849
+ **如果是SignComponent签署控件类型,则可选的字段为**
5850
+
5851
+ <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
5852
+ <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
5853
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
5854
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li>
5855
+ <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
5856
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
5857
+ <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
5858
+ 注:` 表单域的控件不能作为印章和签名控件`
5858
5859
  */
5859
5860
  ComponentType: string;
5860
5861
  /**
5861
- * 控件所属文件的序号(取值为:0-N)。
5862
- 目前单文件的情况下,值是0
5862
+ * <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
5863
5863
  */
5864
5864
  FileIndex: number;
5865
5865
  /**
5866
- * 参数控件高度,单位pt
5866
+ * **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
5867
+
5867
5868
  */
5868
5869
  ComponentHeight: number;
5869
5870
  /**
5870
- * 参数控件宽度,单位pt
5871
+ * **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
5872
+
5871
5873
  */
5872
5874
  ComponentWidth: number;
5873
5875
  /**
5874
- * 参数控件所在页码,取值为:1-N
5876
+ * **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
5877
+
5878
+ 注:
5879
+ 1. 页码编号是从<font color="red">1</font>开始编号的。
5880
+ 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
5875
5881
  */
5876
5882
  ComponentPage: number;
5877
5883
  /**
5878
- * 参数控件X位置,单位pt
5884
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
5879
5885
  */
5880
5886
  ComponentPosX: number;
5881
5887
  /**
5882
- * 参数控件Y位置,单位pt
5888
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
5883
5889
  */
5884
5890
  ComponentPosY: number;
5885
5891
  /**
5886
5892
  * 控件唯一ID。
5887
- 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
5893
+
5894
+ **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
5895
+
5896
+ **在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
5897
+
5898
+ 例:
5899
+
5900
+ - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
5901
+ - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
5902
+ - 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
5903
+ - 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
5904
+
5905
+
5906
+ 注:`控件ID可以在一个PDF中不可重复`
5907
+
5888
5908
  */
5889
5909
  ComponentId?: string;
5890
5910
  /**
5891
- * 控件名。
5892
- 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
5911
+ * **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
5912
+
5913
+ **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
5914
+
5915
+ 注:`控件名可以在一个PDF中可以重复`
5916
+
5893
5917
  */
5894
5918
  ComponentName?: string;
5895
5919
  /**
5896
- * 是否必选,默认为false-非必选
5920
+ * 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
5921
+ <ul><li>false(默认):可以不填写</li>
5922
+ <li>true :必须填写此填写控件</li></ul>
5923
+ 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
5897
5924
  */
5898
5925
  ComponentRequired?: boolean;
5899
5926
  /**
5900
- * 控件关联的参与方ID,对应Recipient结构体中的RecipientId
5927
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
5901
5928
  */
5902
5929
  ComponentRecipientId?: string;
5903
5930
  /**
5904
- * 扩展参数:
5905
- 为JSON格式。
5906
- 不同类型的控件会有部分非通用参数
5907
-
5908
- ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
5909
- 1 Font:目前只支持黑体、宋体
5910
- 2 FontSize: 范围12-72
5911
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
5912
- 4 FontColor:字符串类型,格式为RGB颜色数字
5913
- 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
5914
-
5915
- ComponentType为FILL_IMAGE时,支持以下参数:
5916
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
5917
- FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
5918
-
5919
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
5920
- {“ComponentTypeLimit”: [“xxx”]}
5921
- xxx可以为:
5922
- HANDWRITE 手写签名
5923
- OCR_ESIGN -- AI智能识别手写签名
5924
- ESIGN -- 个人印章类型
5925
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
5926
- 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
5927
-
5928
- ComponentType为SIGN_DATE时,支持以下参数:
5929
- 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
5930
- 2 FontSize: 数字类型,范围6-72,默认值为12
5931
- 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
5932
- 4 Format: 字符串类型,日期格式,必须是以下五种之一 yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
5933
- 5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
5931
+ * **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
5932
+
5933
+ <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
5934
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体</li>
5935
+ <li> <b>FontSize</b>: 范围12 :72</li>
5936
+ <li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
5937
+ <li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>
5938
+ <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
5939
+
5940
+ <font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
5941
+ <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
5942
+ <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
5943
+
5944
+ <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
5945
+ <ul><li> <b>HANDWRITE</b> : 手写签名</li>
5946
+ <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
5947
+ <li> <b>ESIGN</b> : 个人印章类型</li>
5948
+ <li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
5949
+ <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
5950
+ <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
5951
+ 印章的对应关系参考下图
5952
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
5953
+
5954
+ <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
5955
+ <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
5956
+ <li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
5957
+ <li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
5958
+ <li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
5959
+ <li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
5934
5960
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
5935
5961
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
5936
- 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
5962
+ <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
5937
5963
 
5938
- ComponentType为SIGN_SEAL类型时,支持以下参数:
5939
- 1.PageRangesPageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
5940
- 参数样例: "ComponentExtra":"{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"
5964
+ <font color="red">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:
5965
+ <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
5966
+ <b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
5941
5967
  */
5942
5968
  ComponentExtra?: string;
5943
5969
  /**
5944
- * 是否是表单域类型,默认false-不是
5970
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,**发起合同时候不要填写此字段留空即可**
5945
5971
  注意:此字段可能返回 null,表示取不到有效值。
5946
5972
  */
5947
5973
  IsFormType?: boolean;
5948
5974
  /**
5949
5975
  * 控件填充vaule,ComponentType和传入值类型对应关系:
5950
- TEXT - 文本内容
5951
- MULTI_LINE_TEXT - 文本内容
5952
- CHECK_BOX - true/false
5953
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
5954
- SELECTOR - 选项值
5955
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
5956
- DATE - 默认是格式化为xxxx年xx月xx
5957
- SIGN_SEAL - 印章ID,于控制台查询获取
5958
- SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
5976
+ <ul><li> <b>TEXT</b> : 文本内容</li>
5977
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
5978
+ <li> <b>CHECK_BOX</b> : true/false</li>
5979
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
5980
+ <li> <b>SELECTOR</b> : 选项值</li>
5981
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
5982
+ <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
5983
+ <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取</li>
5984
+ <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取</li></ul>
5959
5985
 
5960
- 控件值约束说明:
5961
- 企业全称控件:
5962
- 约束:企业名称中文字符中文括号
5963
- 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
5964
5986
 
5965
- 统一社会信用代码控件:
5966
- 检查正则表达式:/^[A-Z0-9]{1,18}$/
5967
-
5968
- 法人名称控件:
5969
- 约束:最大50个字符,2到25个汉字或者1到50个字母
5970
- 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
5971
-
5972
- 签署意见控件:
5973
- 约束:签署意见最大长度为50字符
5974
-
5975
- 签署人手机号控件:
5976
- 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
5977
-
5978
- 签署人身份证控件:
5979
- 约束:合法的身份证号码检查
5980
-
5981
- 控件名称:
5982
- 约束:控件名称最大长度为20字符
5983
-
5984
- 单行文本控件:
5985
- 约束:只允许输入中文,英文,数字,中英文标点符号
5986
-
5987
- 多行文本控件:
5988
- 约束:只允许输入中文,英文,数字,中英文标点符号
5989
-
5990
- 勾选框控件:
5991
- 约束:选择填字符串true,不选填字符串false
5992
-
5993
- 选择器控件:
5994
- 约束:同单行文本控件约束,填写选择值中的字符串
5995
-
5996
- 数字控件:
5997
- 约束:请输入有效的数字(可带小数点)
5998
- 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
5999
-
6000
- 日期控件:
6001
- 约束:格式:yyyy年mm月dd日
6002
-
6003
- 附件控件:
6004
- 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
6005
-
6006
- 图片控件:
6007
- 约束:JPG或PNG图片,填写上传的图片资源ID
6008
-
6009
- 邮箱控件:
6010
- 约束:请输入有效的邮箱地址, w3c标准
6011
- 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
6012
- 参考:https://emailregex.com/
6013
-
6014
- 地址控件:
6015
- 同单行文本控件约束
6016
-
6017
- 省市区控件:
6018
- 同单行文本控件约束
6019
-
6020
- 性别控件:
6021
- 同单行文本控件约束,填写选择值中的字符串
6022
-
6023
- 学历控件:
6024
- 同单行文本控件约束,填写选择值中的字符串
5987
+ <b>控件值约束说明</b>:
5988
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
5989
+ 注: `部分特殊控件需要在控制台配置模板形式创建`
6025
5990
  */
6026
5991
  ComponentValue?: string;
6027
5992
  /**
6028
5993
  * 控件生成的方式:
6029
- NORMAL - 普通控件
6030
- FIELD - 表单域
6031
- KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
5994
+ <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
5995
+ <li> <b>FIELD</b> : 表单域</li>
5996
+ <li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
6032
5997
  */
6033
5998
  GenerateMode?: string;
6034
5999
  /**
6035
- * 日期签署控件的字号,默认为 12
6000
+ * <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
6036
6001
  */
6037
6002
  ComponentDateFontSize?: number;
6038
6003
  /**
6039
- * 第三方应用集成平台模板控件 ID 标识
6004
+ * <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
6040
6005
  */
6041
6006
  ChannelComponentId?: string;
6042
6007
  /**
6043
- * 指定关键字时横坐标偏移量,单位pt
6008
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
6009
+ 注意: `向左调整设置为负数, 向右调整设置成正数`
6044
6010
  注意:此字段可能返回 null,表示取不到有效值。
6045
6011
  */
6046
6012
  OffsetX?: number;
6047
6013
  /**
6048
- * 指定关键字时纵坐标偏移量,单位pt
6014
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
6015
+ 注意: `向上调整设置为负数, 向下调整设置成正数`
6049
6016
  注意:此字段可能返回 null,表示取不到有效值。
6050
6017
  */
6051
6018
  OffsetY?: number;
6052
6019
  /**
6053
- * 第三方应用集成中子客企业控件来源。
6054
- 0-平台指定;
6055
- 1-用户自定义
6020
+ * <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
6021
+ <ul><li> <b>0</b> :平台指定;</li>
6022
+ <li> <b>1</b> :用户自定义</li></ul>
6056
6023
  */
6057
6024
  ChannelComponentSource?: number;
6058
6025
  /**
6059
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。
6060
- 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
6061
- 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
6026
+ * **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择PositiveReverse两种排序方式。
6027
+ <ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
6028
+ <li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
6029
+
6030
+ 在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
6062
6031
  */
6063
6032
  KeywordOrder?: string;
6064
6033
  /**
6065
- * 指定关键字页码。
6066
- 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
6034
+ * **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
6067
6035
  */
6068
6036
  KeywordPage?: number;
6069
6037
  /**
6070
- * 关键字位置模式,
6071
- Middle-居中,
6072
- Below-正下方,
6073
- Right-正右方,
6074
- LowerRight-右上角,
6075
- UpperRight-右下角。
6038
+ * **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
6039
+ <ul><li> <b>Middle</b> :居中</li>
6040
+ <li> <b>Below</b> :正下方</li>
6041
+ <li> <b>Right</b> :正右方</li>
6042
+ <li> <b>LowerRight</b> :右上角</li>
6043
+ <li> <b>UpperRight</b> :右下角。</li></ul>
6076
6044
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
6077
6045
  */
6078
6046
  RelativeLocation?: string;
6079
6047
  /**
6080
- * 关键字索引。
6081
- 如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
6082
- 示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
6048
+ * **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
6049
+
6050
+ 注意:关键字索引是从0开始计数的
6083
6051
  */
6084
6052
  KeywordIndexes?: Array<number | bigint>;
6085
6053
  /**
6086
- * 是否锁定控件值不允许编辑(嵌入式发起使用)
6087
- <br/>默认false:不锁定控件值,允许在页面编辑控件值
6054
+ * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
6055
+ <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
6056
+ <li>true:锁定控件值,在页面编辑控件值</li></ul>
6088
6057
  注意:此字段可能返回 null,表示取不到有效值。
6089
6058
  */
6090
6059
  LockComponentValue?: boolean;
6091
6060
  /**
6092
- * 是否禁止移动和删除控件
6093
- <br/>默认false,不禁止移动和删除控件
6061
+ * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
6062
+ <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
6063
+ <li> <b>true</b> : 可以移动和删除控件</li></ul>
6094
6064
  注意:此字段可能返回 null,表示取不到有效值。
6095
6065
  */
6096
6066
  ForbidMoveAndDelete?: boolean;
@@ -7056,7 +7026,10 @@ export interface CreateBatchQuickSignUrlRequest {
7056
7026
  /**
7057
7027
  * 指定批量签署合同的签名类型,可传递以下值:
7058
7028
  <ul><li>**0**:手写签名(默认)</li>
7059
- <li>**1**:OCR楷体</li></ul>
7029
+ <li>**1**:OCR楷体</li>
7030
+ <li>**2**:姓名印章</li>
7031
+ <li>**3**:图片印章</li>
7032
+ <li>**4**:系统签名</li></ul>
7060
7033
  注:
7061
7034
  <ul><li>默认情况下,签名类型为手写签名</li>
7062
7035
  <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
@@ -555,7 +555,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
555
555
  可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
556
556
  ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
557
557
 
558
- 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
558
+ 注:
559
+ 1. 支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败
560
+ 2. 只有企业的<font color="red">超管或者法人</font>才能进行合同的领取
559
561
  */
560
562
  ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
561
563
  /**
@@ -645,7 +645,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
645
645
  可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
646
646
  ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
647
647
 
648
- 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
648
+ 注:
649
+ 1. 支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败
650
+ 2. 只有企业的<font color="red">超管或者法人</font>才能进行合同的领取
649
651
  */
650
652
  async ChannelCreateBoundFlows(req, cb) {
651
653
  return this.request("ChannelCreateBoundFlows", req, cb);
@@ -4074,7 +4074,10 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
4074
4074
  /**
4075
4075
  * 指定批量签署合同的签名类型,可传递以下值:
4076
4076
  <ul><li>**0**:手写签名(默认)</li>
4077
- <li>**1**:OCR楷体</li></ul>
4077
+ <li>**1**:OCR楷体</li>
4078
+ <li>**2**:姓名印章</li>
4079
+ <li>**3**:图片印章</li>
4080
+ <li>**4**:系统签名</li></ul>
4078
4081
  注:
4079
4082
  <ul><li>默认情况下,签名类型为手写签名</li>
4080
4083
  <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
@@ -15,6 +15,16 @@ export interface AttackRiskDetail {
15
15
  */
16
16
  Type?: string;
17
17
  }
18
+ /**
19
+ * 额外的详细信息
20
+ */
21
+ export interface ExtraInfo {
22
+ /**
23
+ * 命中模板的详细信息,仅返回命中的相似度最高的模板信息
24
+ 注意:此字段可能返回 null,表示取不到有效值。
25
+ */
26
+ RetrievalLivenessExtraInfo?: Array<RetrievalLivenessExtraInfo>;
27
+ }
18
28
  /**
19
29
  * CheckIdNameDate返回参数结构体
20
30
  */
@@ -974,6 +984,10 @@ export interface DetectAIFakeFacesResponse {
974
984
  此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
975
985
  */
976
986
  AttackRiskDetailList?: Array<AttackRiskDetail>;
987
+ /**
988
+ * 额外信息
989
+ */
990
+ ExtraInfo?: ExtraInfo;
977
991
  /**
978
992
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
979
993
  */
@@ -1154,6 +1168,26 @@ export interface DetectDetail {
1154
1168
  */
1155
1169
  LivenessMode?: number;
1156
1170
  }
1171
+ /**
1172
+ * 模版检索详细信息
1173
+ */
1174
+ export interface RetrievalLivenessExtraInfo {
1175
+ /**
1176
+ * 命中的模版类型,其中Common-公共库;Auto-自动聚类库;Owner-自建模版库
1177
+ 注意:此字段可能返回 null,表示取不到有效值。
1178
+ */
1179
+ HitGroup?: string;
1180
+ /**
1181
+ * 命中的相似度
1182
+ 注意:此字段可能返回 null,表示取不到有效值。
1183
+ */
1184
+ SimilarityScore?: number;
1185
+ /**
1186
+ * 命中的模板id
1187
+ 注意:此字段可能返回 null,表示取不到有效值。
1188
+ */
1189
+ HitTemplate?: string;
1190
+ }
1157
1191
  /**
1158
1192
  * 意愿核身(点头确认模式)配置
1159
1193
  */
@@ -3091,61 +3091,68 @@ export interface ProductConf {
3091
3091
  - 15:Redis 6.2内存版(标准架构)。
3092
3092
  - 16:Redis 6.2内存版(集群架构)。
3093
3093
  */
3094
- Type: number;
3094
+ Type?: number;
3095
3095
  /**
3096
3096
  * 产品名称。包括:Redis 主从版、CKV 主从版、CKV 集群版、Redis 单机版、Redis 集群版。
3097
3097
  */
3098
- TypeName: string;
3098
+ TypeName?: string;
3099
3099
  /**
3100
3100
  * 购买时的最小数量。
3101
3101
  */
3102
- MinBuyNum: number;
3102
+ MinBuyNum?: number;
3103
3103
  /**
3104
3104
  * 购买时的最大数量。
3105
3105
  */
3106
- MaxBuyNum: number;
3106
+ MaxBuyNum?: number;
3107
3107
  /**
3108
3108
  * 产品是否售罄。
3109
3109
  - true:售罄。
3110
3110
  - false:未售罄。
3111
3111
  */
3112
- Saleout: boolean;
3112
+ Saleout?: boolean;
3113
3113
  /**
3114
3114
  * 产品引擎。包括:腾讯云 CKV与社区版 Redis。
3115
3115
  */
3116
- Engine: string;
3116
+ Engine?: string;
3117
3117
  /**
3118
3118
  * 兼容版本。包括:Redis-2.8、Redis-3.2、Redis-4.0、Redis-5.0、Redis-6.2。
3119
3119
  */
3120
- Version: string;
3120
+ Version?: string;
3121
3121
  /**
3122
3122
  * 规格总大小,单位GB。
3123
3123
  */
3124
- TotalSize: Array<string>;
3124
+ TotalSize?: Array<string>;
3125
3125
  /**
3126
3126
  * 每个分片大小,单位GB。
3127
3127
  */
3128
- ShardSize: Array<string>;
3128
+ ShardSize?: Array<string>;
3129
3129
  /**
3130
3130
  * 副本数量。
3131
3131
  */
3132
- ReplicaNum: Array<string>;
3132
+ ReplicaNum?: Array<string>;
3133
3133
  /**
3134
3134
  * 分片数量。
3135
3135
  */
3136
- ShardNum: Array<string>;
3136
+ ShardNum?: Array<string>;
3137
3137
  /**
3138
3138
  * 支持的计费模式。
3139
3139
  - 1:包年包月。
3140
3140
  - 0:按量计费。
3141
3141
  */
3142
- PayMode: string;
3142
+ PayMode?: string;
3143
+ /**
3144
+ * 该参数名因存在拼写不规范的问题,建议使用**EnableReplicaReadOnly**参数取代。其含义为是否支持副本只读。
3145
+ - true:支持副本只读。
3146
+ - false:不支持。
3147
+ */
3148
+ EnableRepicaReadOnly?: boolean;
3143
3149
  /**
3144
3150
  * 是否支持副本只读。
3145
3151
  - true:支持副本只读。
3146
3152
  - false:不支持。
3153
+ 注意:此字段可能返回 null,表示取不到有效值。
3147
3154
  */
3148
- EnableRepicaReadOnly: boolean;
3155
+ EnableReplicaReadOnly?: boolean;
3149
3156
  }
3150
3157
  /**
3151
3158
  * ModifyConnectionConfig请求参数结构体
@@ -3731,7 +3738,9 @@ export interface DescribeSlowLogRequest {
3731
3738
  */
3732
3739
  Offset?: number;
3733
3740
  /**
3734
- * 节点所属角色。<ul><li>master:主节点。</li><li>slave:从节点。</li></ul>
3741
+ * 节点所属角色。
3742
+ - master:主节点。
3743
+ - slave:从节点。
3735
3744
  */
3736
3745
  Role?: string;
3737
3746
  }
@@ -7,7 +7,7 @@ export interface UnTagResourcesResponse {
7
7
  解绑标签成功时,返回的FailedResources为空。
8
8
  解绑标签失败或部分失败时,返回的FailedResources会显示失败资源的详细信息。
9
9
  */
10
- FailedResources: Array<FailedResource>;
10
+ FailedResources?: Array<FailedResource>;
11
11
  /**
12
12
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
13
13
  */