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
@@ -6020,263 +6020,233 @@ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.
6020
6020
  */
6021
6021
  export interface Component {
6022
6022
  /**
6023
- * 如果是Component填写控件类型,则可选的字段为:
6024
- TEXT - 普通文本控件,输入文本字符串;
6025
- MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
6026
- CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
6027
- FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
6028
- DYNAMIC_TABLE - 动态表格控件;
6029
- ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;
6030
- SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
6031
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
6032
- DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
6033
-
6034
- 如果是SignComponent签署控件类型,则可选的字段为
6035
- SIGN_SEAL - 签署印章控件;
6036
- SIGN_DATE - 签署日期控件;
6037
- SIGN_SIGNATURE - 用户签名控件;
6038
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
6039
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
6040
- SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
6041
- SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
6042
-
6043
- 表单域的控件不能作为印章和签名控件
6023
+ * **如果是Component填写控件类型,则可选的字段为**:
6024
+
6025
+ <ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
6026
+ <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
6027
+ <li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
6028
+ <li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
6029
+ <li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
6030
+ <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
6031
+ <li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
6032
+ <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
6033
+ <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
6034
+
6035
+ **如果是SignComponent签署控件类型,则可选的字段为**
6036
+
6037
+ <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
6038
+ <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
6039
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
6040
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li>
6041
+ <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
6042
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
6043
+ <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
6044
+ 注:` 表单域的控件不能作为印章和签名控件`
6044
6045
  */
6045
6046
  ComponentType: string
6046
6047
  /**
6047
- * 控件所属文件的序号(取值为:0-N)。
6048
- 目前单文件的情况下,值是0
6048
+ * <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
6049
6049
  */
6050
6050
  FileIndex: number
6051
6051
  /**
6052
- * 参数控件高度,单位pt
6052
+ * **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
6053
+
6053
6054
  */
6054
6055
  ComponentHeight: number
6055
6056
  /**
6056
- * 参数控件宽度,单位pt
6057
+ * **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
6058
+
6057
6059
  */
6058
6060
  ComponentWidth: number
6059
6061
  /**
6060
- * 参数控件所在页码,取值为:1-N
6062
+ * **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
6063
+
6064
+ 注:
6065
+ 1. 页码编号是从<font color="red">1</font>开始编号的。
6066
+ 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
6061
6067
  */
6062
6068
  ComponentPage: number
6063
6069
  /**
6064
- * 参数控件X位置,单位pt
6070
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
6065
6071
  */
6066
6072
  ComponentPosX: number
6067
6073
  /**
6068
- * 参数控件Y位置,单位pt
6074
+ * **在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
6069
6075
  */
6070
6076
  ComponentPosY: number
6071
6077
  /**
6072
6078
  * 控件唯一ID。
6073
- 或使用文件发起合同时用于GenerateMode==KEYWORD 指定关键字
6079
+
6080
+ **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
6081
+
6082
+ **在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
6083
+
6084
+ 例:
6085
+
6086
+ - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
6087
+ - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
6088
+ - 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
6089
+ - 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
6090
+
6091
+
6092
+ 注:`控件ID可以在一个PDF中不可重复`
6093
+
6074
6094
  */
6075
6095
  ComponentId?: string
6076
6096
  /**
6077
- * 控件名。
6078
- 或使用文件发起合同时用于GenerateMode==FIELD 指定表单域名称
6097
+ * **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
6098
+
6099
+ **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
6100
+
6101
+ 注:`控件名可以在一个PDF中可以重复`
6102
+
6079
6103
  */
6080
6104
  ComponentName?: string
6081
6105
  /**
6082
- * 是否必选,默认为false-非必选
6106
+ * 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
6107
+ <ul><li>false(默认):可以不填写</li>
6108
+ <li>true :必须填写此填写控件</li></ul>
6109
+ 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
6083
6110
  */
6084
6111
  ComponentRequired?: boolean
6085
6112
  /**
6086
- * 控件关联的参与方ID,对应Recipient结构体中的RecipientId
6113
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
6087
6114
  */
6088
6115
  ComponentRecipientId?: string
6089
6116
  /**
6090
- * 扩展参数:
6091
- 为JSON格式。
6092
- 不同类型的控件会有部分非通用参数
6093
-
6094
- ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
6095
- 1 Font:目前只支持黑体、宋体
6096
- 2 FontSize: 范围12-72
6097
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
6098
- 4 FontColor:字符串类型,格式为RGB颜色数字
6099
- 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
6100
-
6101
- ComponentType为FILL_IMAGE时,支持以下参数:
6102
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
6103
- FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
6104
-
6105
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
6106
- {“ComponentTypeLimit”: [“xxx”]}
6107
- xxx可以为:
6108
- HANDWRITE 手写签名
6109
- OCR_ESIGN -- AI智能识别手写签名
6110
- ESIGN -- 个人印章类型
6111
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
6112
- 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
6113
-
6114
- ComponentType为SIGN_DATE时,支持以下参数:
6115
- 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
6116
- 2 FontSize: 数字类型,范围6-72,默认值为12
6117
- 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
6118
- 4 Format: 字符串类型,日期格式,必须是以下五种之一 yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
6119
- 5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
6117
+ * **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
6118
+
6119
+ <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
6120
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体</li>
6121
+ <li> <b>FontSize</b>: 范围12 :72</li>
6122
+ <li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
6123
+ <li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>
6124
+ <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
6125
+
6126
+ <font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
6127
+ <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
6128
+ <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
6129
+
6130
+ <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
6131
+ <ul><li> <b>HANDWRITE</b> : 手写签名</li>
6132
+ <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
6133
+ <li> <b>ESIGN</b> : 个人印章类型</li>
6134
+ <li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
6135
+ <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
6136
+ <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
6137
+ 印章的对应关系参考下图
6138
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
6139
+
6140
+ <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
6141
+ <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
6142
+ <li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
6143
+ <li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
6144
+ <li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
6145
+ <li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
6120
6146
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
6121
6147
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
6122
- 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
6148
+ <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
6123
6149
 
6124
- ComponentType为SIGN_SEAL类型时,支持以下参数:
6125
- 1.PageRangesPageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
6126
- 参数样例: "ComponentExtra":"{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"
6150
+ <font color="red">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:
6151
+ <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
6152
+ <b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
6127
6153
  */
6128
6154
  ComponentExtra?: string
6129
6155
  /**
6130
- * 是否是表单域类型,默认false-不是
6156
+ * **在通过接口拉取控件信息场景下**,为出参参数,此控件是否通过表单域定位方式生成,默认false-不是,**发起合同时候不要填写此字段留空即可**
6131
6157
  注意:此字段可能返回 null,表示取不到有效值。
6132
6158
  */
6133
6159
  IsFormType?: boolean
6134
6160
  /**
6135
6161
  * 控件填充vaule,ComponentType和传入值类型对应关系:
6136
- TEXT - 文本内容
6137
- MULTI_LINE_TEXT - 文本内容
6138
- CHECK_BOX - true/false
6139
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
6140
- SELECTOR - 选项值
6141
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
6142
- DATE - 默认是格式化为xxxx年xx月xx
6143
- SIGN_SEAL - 印章ID,于控制台查询获取
6144
- SIGN_PAGING_SEAL - 可以指定印章ID,于控制台查询获取
6162
+ <ul><li> <b>TEXT</b> : 文本内容</li>
6163
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
6164
+ <li> <b>CHECK_BOX</b> : true/false</li>
6165
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
6166
+ <li> <b>SELECTOR</b> : 选项值</li>
6167
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
6168
+ <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
6169
+ <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取</li>
6170
+ <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取</li></ul>
6145
6171
 
6146
- 控件值约束说明:
6147
- 企业全称控件:
6148
- 约束:企业名称中文字符中文括号
6149
- 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
6150
6172
 
6151
- 统一社会信用代码控件:
6152
- 检查正则表达式:/^[A-Z0-9]{1,18}$/
6153
-
6154
- 法人名称控件:
6155
- 约束:最大50个字符,2到25个汉字或者1到50个字母
6156
- 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
6157
-
6158
- 签署意见控件:
6159
- 约束:签署意见最大长度为50字符
6160
-
6161
- 签署人手机号控件:
6162
- 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
6163
-
6164
- 签署人身份证控件:
6165
- 约束:合法的身份证号码检查
6166
-
6167
- 控件名称:
6168
- 约束:控件名称最大长度为20字符
6169
-
6170
- 单行文本控件:
6171
- 约束:只允许输入中文,英文,数字,中英文标点符号
6172
-
6173
- 多行文本控件:
6174
- 约束:只允许输入中文,英文,数字,中英文标点符号
6175
-
6176
- 勾选框控件:
6177
- 约束:选择填字符串true,不选填字符串false
6178
-
6179
- 选择器控件:
6180
- 约束:同单行文本控件约束,填写选择值中的字符串
6181
-
6182
- 数字控件:
6183
- 约束:请输入有效的数字(可带小数点)
6184
- 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
6185
-
6186
- 日期控件:
6187
- 约束:格式:yyyy年mm月dd日
6188
-
6189
- 附件控件:
6190
- 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
6191
-
6192
- 图片控件:
6193
- 约束:JPG或PNG图片,填写上传的图片资源ID
6194
-
6195
- 邮箱控件:
6196
- 约束:请输入有效的邮箱地址, w3c标准
6197
- 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
6198
- 参考:https://emailregex.com/
6199
-
6200
- 地址控件:
6201
- 同单行文本控件约束
6202
-
6203
- 省市区控件:
6204
- 同单行文本控件约束
6205
-
6206
- 性别控件:
6207
- 同单行文本控件约束,填写选择值中的字符串
6208
-
6209
- 学历控件:
6210
- 同单行文本控件约束,填写选择值中的字符串
6173
+ <b>控件值约束说明</b>:
6174
+ <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>
6175
+ 注: `部分特殊控件需要在控制台配置模板形式创建`
6211
6176
  */
6212
6177
  ComponentValue?: string
6213
6178
  /**
6214
6179
  * 控件生成的方式:
6215
- NORMAL - 普通控件
6216
- FIELD - 表单域
6217
- KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
6180
+ <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
6181
+ <li> <b>FIELD</b> : 表单域</li>
6182
+ <li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
6218
6183
  */
6219
6184
  GenerateMode?: string
6220
6185
  /**
6221
- * 日期签署控件的字号,默认为 12
6186
+ * <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
6222
6187
  */
6223
6188
  ComponentDateFontSize?: number
6224
6189
  /**
6225
- * 第三方应用集成平台模板控件 ID 标识
6190
+ * <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
6226
6191
  */
6227
6192
  ChannelComponentId?: string
6228
6193
  /**
6229
- * 指定关键字时横坐标偏移量,单位pt
6194
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
6195
+ 注意: `向左调整设置为负数, 向右调整设置成正数`
6230
6196
  注意:此字段可能返回 null,表示取不到有效值。
6231
6197
  */
6232
6198
  OffsetX?: number
6233
6199
  /**
6234
- * 指定关键字时纵坐标偏移量,单位pt
6200
+ * **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
6201
+ 注意: `向上调整设置为负数, 向下调整设置成正数`
6235
6202
  注意:此字段可能返回 null,表示取不到有效值。
6236
6203
  */
6237
6204
  OffsetY?: number
6238
6205
  /**
6239
- * 第三方应用集成中子客企业控件来源。
6240
- 0-平台指定;
6241
- 1-用户自定义
6206
+ * <font color="red">【暂未使用】</font>第三方应用集成中子客企业控件来源。
6207
+ <ul><li> <b>0</b> :平台指定;</li>
6208
+ <li> <b>1</b> :用户自定义</li></ul>
6242
6209
  */
6243
6210
  ChannelComponentSource?: number
6244
6211
  /**
6245
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。
6246
- 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
6247
- 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
6212
+ * **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择PositiveReverse两种排序方式。
6213
+ <ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
6214
+ <li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
6215
+
6216
+ 在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
6248
6217
  */
6249
6218
  KeywordOrder?: string
6250
6219
  /**
6251
- * 指定关键字页码。
6252
- 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
6220
+ * **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
6253
6221
  */
6254
6222
  KeywordPage?: number
6255
6223
  /**
6256
- * 关键字位置模式,
6257
- Middle-居中,
6258
- Below-正下方,
6259
- Right-正右方,
6260
- LowerRight-右上角,
6261
- UpperRight-右下角。
6224
+ * **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
6225
+ <ul><li> <b>Middle</b> :居中</li>
6226
+ <li> <b>Below</b> :正下方</li>
6227
+ <li> <b>Right</b> :正右方</li>
6228
+ <li> <b>LowerRight</b> :右上角</li>
6229
+ <li> <b>UpperRight</b> :右下角。</li></ul>
6262
6230
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
6263
6231
  */
6264
6232
  RelativeLocation?: string
6265
6233
  /**
6266
- * 关键字索引。
6267
- 如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
6268
- 示例:[0,2],说明使用PDF文件内第1个和第3个关键字位置。
6234
+ * **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
6235
+
6236
+ 注意:关键字索引是从0开始计数的
6269
6237
  */
6270
6238
  KeywordIndexes?: Array<number | bigint>
6271
6239
  /**
6272
- * 是否锁定控件值不允许编辑(嵌入式发起使用)
6273
- <br/>默认false:不锁定控件值,允许在页面编辑控件值
6240
+ * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
6241
+ <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
6242
+ <li>true:锁定控件值,在页面编辑控件值</li></ul>
6274
6243
  注意:此字段可能返回 null,表示取不到有效值。
6275
6244
  */
6276
6245
  LockComponentValue?: boolean
6277
6246
  /**
6278
- * 是否禁止移动和删除控件
6279
- <br/>默认false,不禁止移动和删除控件
6247
+ * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
6248
+ <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
6249
+ <li> <b>true</b> : 可以移动和删除控件</li></ul>
6280
6250
  注意:此字段可能返回 null,表示取不到有效值。
6281
6251
  */
6282
6252
  ForbidMoveAndDelete?: boolean
@@ -7275,7 +7245,10 @@ export interface CreateBatchQuickSignUrlRequest {
7275
7245
  /**
7276
7246
  * 指定批量签署合同的签名类型,可传递以下值:
7277
7247
  <ul><li>**0**:手写签名(默认)</li>
7278
- <li>**1**:OCR楷体</li></ul>
7248
+ <li>**1**:OCR楷体</li>
7249
+ <li>**2**:姓名印章</li>
7250
+ <li>**3**:图片印章</li>
7251
+ <li>**4**:系统签名</li></ul>
7279
7252
  注:
7280
7253
  <ul><li>默认情况下,签名类型为手写签名</li>
7281
7254
  <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
@@ -992,7 +992,9 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
992
992
  可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
993
993
  ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
994
994
 
995
- 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
995
+ 注:
996
+ 1. 支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败
997
+ 2. 只有企业的<font color="red">超管或者法人</font>才能进行合同的领取
996
998
  */
997
999
  async ChannelCreateBoundFlows(
998
1000
  req: ChannelCreateBoundFlowsRequest,
@@ -4194,7 +4194,10 @@ export interface ChannelCreateBatchQuickSignUrlRequest {
4194
4194
  /**
4195
4195
  * 指定批量签署合同的签名类型,可传递以下值:
4196
4196
  <ul><li>**0**:手写签名(默认)</li>
4197
- <li>**1**:OCR楷体</li></ul>
4197
+ <li>**1**:OCR楷体</li>
4198
+ <li>**2**:姓名印章</li>
4199
+ <li>**3**:图片印章</li>
4200
+ <li>**4**:系统签名</li></ul>
4198
4201
  注:
4199
4202
  <ul><li>默认情况下,签名类型为手写签名</li>
4200
4203
  <li>您可以传递多种值,表示可用多种签名类型。</li></ul>
@@ -19,6 +19,7 @@ import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  AttackRiskDetail,
22
+ ExtraInfo,
22
23
  CheckIdNameDateResponse,
23
24
  IdCardVerificationRequest,
24
25
  ImageRecognitionV2Response,
@@ -53,6 +54,7 @@ import {
53
54
  IntentionVerifyData,
54
55
  LivenessCompareRequest,
55
56
  DetectDetail,
57
+ RetrievalLivenessExtraInfo,
56
58
  IntentionActionConfig,
57
59
  CheckBankCardInformationRequest,
58
60
  BankCardVerificationRequest,
@@ -33,6 +33,17 @@ SuspectedWatermark:疑似存在水印
33
33
  Type?: string
34
34
  }
35
35
 
36
+ /**
37
+ * 额外的详细信息
38
+ */
39
+ export interface ExtraInfo {
40
+ /**
41
+ * 命中模板的详细信息,仅返回命中的相似度最高的模板信息
42
+ 注意:此字段可能返回 null,表示取不到有效值。
43
+ */
44
+ RetrievalLivenessExtraInfo?: Array<RetrievalLivenessExtraInfo>
45
+ }
46
+
36
47
  /**
37
48
  * CheckIdNameDate返回参数结构体
38
49
  */
@@ -1022,6 +1033,10 @@ High:高度疑似攻击
1022
1033
  此出参仅作为结果判断的参考,实际应用仍建议使用AttackRiskLevel的结果。
1023
1034
  */
1024
1035
  AttackRiskDetailList?: Array<AttackRiskDetail>
1036
+ /**
1037
+ * 额外信息
1038
+ */
1039
+ ExtraInfo?: ExtraInfo
1025
1040
  /**
1026
1041
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1027
1042
  */
@@ -1206,6 +1221,27 @@ export interface DetectDetail {
1206
1221
  LivenessMode?: number
1207
1222
  }
1208
1223
 
1224
+ /**
1225
+ * 模版检索详细信息
1226
+ */
1227
+ export interface RetrievalLivenessExtraInfo {
1228
+ /**
1229
+ * 命中的模版类型,其中Common-公共库;Auto-自动聚类库;Owner-自建模版库
1230
+ 注意:此字段可能返回 null,表示取不到有效值。
1231
+ */
1232
+ HitGroup?: string
1233
+ /**
1234
+ * 命中的相似度
1235
+ 注意:此字段可能返回 null,表示取不到有效值。
1236
+ */
1237
+ SimilarityScore?: number
1238
+ /**
1239
+ * 命中的模板id
1240
+ 注意:此字段可能返回 null,表示取不到有效值。
1241
+ */
1242
+ HitTemplate?: string
1243
+ }
1244
+
1209
1245
  /**
1210
1246
  * 意愿核身(点头确认模式)配置
1211
1247
  */
@@ -3248,61 +3248,68 @@ export interface ProductConf {
3248
3248
  - 15:Redis 6.2内存版(标准架构)。
3249
3249
  - 16:Redis 6.2内存版(集群架构)。
3250
3250
  */
3251
- Type: number
3251
+ Type?: number
3252
3252
  /**
3253
3253
  * 产品名称。包括:Redis 主从版、CKV 主从版、CKV 集群版、Redis 单机版、Redis 集群版。
3254
3254
  */
3255
- TypeName: string
3255
+ TypeName?: string
3256
3256
  /**
3257
3257
  * 购买时的最小数量。
3258
3258
  */
3259
- MinBuyNum: number
3259
+ MinBuyNum?: number
3260
3260
  /**
3261
3261
  * 购买时的最大数量。
3262
3262
  */
3263
- MaxBuyNum: number
3263
+ MaxBuyNum?: number
3264
3264
  /**
3265
3265
  * 产品是否售罄。
3266
3266
  - true:售罄。
3267
3267
  - false:未售罄。
3268
3268
  */
3269
- Saleout: boolean
3269
+ Saleout?: boolean
3270
3270
  /**
3271
3271
  * 产品引擎。包括:腾讯云 CKV与社区版 Redis。
3272
3272
  */
3273
- Engine: string
3273
+ Engine?: string
3274
3274
  /**
3275
3275
  * 兼容版本。包括:Redis-2.8、Redis-3.2、Redis-4.0、Redis-5.0、Redis-6.2。
3276
3276
  */
3277
- Version: string
3277
+ Version?: string
3278
3278
  /**
3279
3279
  * 规格总大小,单位GB。
3280
3280
  */
3281
- TotalSize: Array<string>
3281
+ TotalSize?: Array<string>
3282
3282
  /**
3283
3283
  * 每个分片大小,单位GB。
3284
3284
  */
3285
- ShardSize: Array<string>
3285
+ ShardSize?: Array<string>
3286
3286
  /**
3287
3287
  * 副本数量。
3288
3288
  */
3289
- ReplicaNum: Array<string>
3289
+ ReplicaNum?: Array<string>
3290
3290
  /**
3291
3291
  * 分片数量。
3292
3292
  */
3293
- ShardNum: Array<string>
3293
+ ShardNum?: Array<string>
3294
3294
  /**
3295
3295
  * 支持的计费模式。
3296
3296
  - 1:包年包月。
3297
3297
  - 0:按量计费。
3298
3298
  */
3299
- PayMode: string
3299
+ PayMode?: string
3300
+ /**
3301
+ * 该参数名因存在拼写不规范的问题,建议使用**EnableReplicaReadOnly**参数取代。其含义为是否支持副本只读。
3302
+ - true:支持副本只读。
3303
+ - false:不支持。
3304
+ */
3305
+ EnableRepicaReadOnly?: boolean
3300
3306
  /**
3301
3307
  * 是否支持副本只读。
3302
3308
  - true:支持副本只读。
3303
3309
  - false:不支持。
3310
+ 注意:此字段可能返回 null,表示取不到有效值。
3304
3311
  */
3305
- EnableRepicaReadOnly: boolean
3312
+ EnableReplicaReadOnly?: boolean
3306
3313
  }
3307
3314
 
3308
3315
  /**
@@ -3909,7 +3916,9 @@ export interface DescribeSlowLogRequest {
3909
3916
  */
3910
3917
  Offset?: number
3911
3918
  /**
3912
- * 节点所属角色。<ul><li>master:主节点。</li><li>slave:从节点。</li></ul>
3919
+ * 节点所属角色。
3920
+ - master:主节点。
3921
+ - slave:从节点。
3913
3922
  */
3914
3923
  Role?: string
3915
3924
  }
@@ -24,7 +24,7 @@ export interface UnTagResourcesResponse {
24
24
  解绑标签成功时,返回的FailedResources为空。
25
25
  解绑标签失败或部分失败时,返回的FailedResources会显示失败资源的详细信息。
26
26
  */
27
- FailedResources: Array<FailedResource>
27
+ FailedResources?: Array<FailedResource>
28
28
  /**
29
29
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
30
30
  */