tencentcloud-sdk-ess 3.0.654 → 3.0.656

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 (5) hide show
  1. checksums.yaml +4 -4
  2. data/lib/VERSION +1 -1
  3. data/lib/v20201111/client.rb +41 -16
  4. data/lib/v20201111/models.rb +301 -179
  5. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 90650f8b1eec263cc67d24f0ff357e4cd2e016f6
4
- data.tar.gz: a10db0ff77eafecbfc95fa7c8466d39f31c493fd
3
+ metadata.gz: 8f9b6ac1e67e0e1ff834c6f218d0caac5ec68d6d
4
+ data.tar.gz: fa6f05f00450a8405c3f924b7a5c6f5f0c085e14
5
5
  SHA512:
6
- metadata.gz: e4955ae8ef02e37a87975f409f59069096d1ecce298865676a6dcbad63b72c3260b762b042dd2985a6e91a2e893afe3a25cb4b8c4f629e0dc5a1af6af5b51944
7
- data.tar.gz: 657cd55f59e9f092da384a2389af53f733a94d74645ecfadba743d4470add5d96e1ba6174a2fb04a698f1be2ce72f5b117a69ea633278bffcf37a3d7f17cff01
6
+ metadata.gz: e90c630b3276311411c515dbe63a214dcc86a7cf504dd5797a87dee3179d092f39a39bf8bbcae880b93488bdc7681a14265bda45b479b7efa6e0de9ed619a3ba
7
+ data.tar.gz: 447ff4c821bba7e132091114a224e8c5da05e1aa0bbf728eee657e134af20d2ca0729c293a7a0e950ae92a8224471452c5ce94cfc47725347add3d0e15523509
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.654
1
+ 3.0.656
data/lib/v20201111/client.rb CHANGED
@@ -105,9 +105,11 @@ module TencentCloud
105
105
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
106
106
  end
107
107
 
108
- # 此接口（CancelUserAutoSignEnableUrl）用来撤销发送给个人用户的自动签开通链接，撤销后对应的个人用户开通链接失效。若个人用户已经完成开通，将无法撤销。（处方单场景专用，使用此接口请与客户经理确认）
108
+ # 用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接，撤销生成的链接失效。
109
109
 
110
- # 注: `在调用此接口时，请确保指定的用户已生成自动签开通链接并且未完成开通，否则无法撤销`
110
+ # 注:
111
+ # <ul><li>若个人用户已经用生成的完成自动签署的开通，撤销链接无效不会对开通结果产生影响(此情况接口会报错)。</li>
112
+ # <li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li></ul>
111
113
 
112
114
  # @param request: Request instance for CancelUserAutoSignEnableUrl.
113
115
  # @type request: :class:`Tencentcloud::ess::V20201111::CancelUserAutoSignEnableUrlRequest`
@@ -187,7 +189,14 @@ module TencentCloud
187
189
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
188
190
  end
189
191
 
190
- # 上传了word、excel、图片文件后，通过该接口发起文件转换任务，将word、excel、图片文件转换为pdf文件。
192
+ # 此接口（CreateConvertTaskApi）用来将word、excel、图片、txt类型文件转换为PDF文件。<br />
193
+ # 前提条件：源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传，并得到了源文件的资源Id。<br />
194
+ # 适用场景1：已经上传了一个word文件，希望将该word文件转换成pdf文件后发起合同
195
+ # 适用场景2：已经上传了一个jpg图片文件，希望将该图片文件转换成pdf文件后发起合同<br />
196
+ # 转换文件是一个耗时操作，若想查看转换任务是否完成，可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
197
+ # 注:
198
+ # 1. `支持的文件类型有doc、docx、xls、xlsx、jpg、jpeg、png、bmp、txt`
199
+ # 2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
191
200
 
192
201
  # @param request: Request instance for CreateConvertTaskApi.
193
202
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateConvertTaskApiRequest`
@@ -213,7 +222,9 @@ module TencentCloud
213
222
 
214
223
  # 创建签署流程电子文档
215
224
  # 适用场景：见创建签署流程接口。
216
- # 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。是“发起流程”接口的前置接口。
225
+ # 注：该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用, 具体逻辑可以参考下图:
226
+
227
+ # <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
217
228
 
218
229
  # @param request: Request instance for CreateDocument.
219
230
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateDocumentRequest`
@@ -262,9 +273,11 @@ module TencentCloud
262
273
  end
263
274
 
264
275
  # 通过模板创建签署流程<br/>
265
- # 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。<br/>
266
- # 注：该接口是通过模板生成合同流程的前置接口，先创建一个不包含签署文件的流程。<br/>
267
- # 配合“创建电子文档”接口和“发起流程”接口使用。<br/>
276
+ # 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
277
+
278
+ # 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
279
+
280
+ # <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
268
281
 
269
282
  # @param request: Request instance for CreateFlow.
270
283
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowRequest`
@@ -480,10 +493,11 @@ module TencentCloud
480
493
 
481
494
  # 该接口用于发起合同后，生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
482
495
 
483
- # 注：
484
- # `1. 该接口目前仅支持签署人类型是个人签署方的场景（PERSON）`
485
- # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 `
486
- # `3. 该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。跳转到小程序的实现，参考微信官方文档（分为<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>
496
+ # `注意：`<br/>
497
+ # `1. 该接口目前仅支持签署人类型是个人签署方的场景（PERSON）。` <br/>
498
+ # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件，不支持填写控件 。` <br/>
499
+ # `3. 该接口返回的签署链接是用于APP集成的场景，支持APP打开或浏览器直接打开，不支持微信小程序嵌入`。<br/>
500
+ # 跳转到小程序的实现，参考微信官方文档（分为<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>
487
501
 
488
502
  # @param request: Request instance for CreateFlowSignUrl.
489
503
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignUrlRequest`
@@ -867,7 +881,9 @@ module TencentCloud
867
881
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
868
882
  end
869
883
 
870
- # 企业方可以通过此接口获取个人用户开启自动签的跳转链接（处方单场景专用，使用此接口请与客户经理确认）
884
+ # 获取个人用户自动签的开通链接。
885
+
886
+ # 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
871
887
 
872
888
  # @param request: Request instance for CreateUserAutoSignEnableUrl.
873
889
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateUserAutoSignEnableUrlRequest`
@@ -1374,7 +1390,9 @@ module TencentCloud
1374
1390
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1375
1391
  end
1376
1392
 
1377
- # 企业方可以通过此接口查询个人用户自动签开启状态。（处方单场景专用，使用此接口请与客户经理确认）
1393
+ # 通过此接口获取个人用户自动签的开通状态。
1394
+
1395
+ # 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`
1378
1396
 
1379
1397
  # @param request: Request instance for DescribeUserAutoSignStatus.
1380
1398
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeUserAutoSignStatusRequest`
@@ -1398,7 +1416,13 @@ module TencentCloud
1398
1416
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1399
1417
  end
1400
1418
 
1401
- # 企业方可以通过此接口关闭个人的自动签功能（处方单场景专用，使用此接口请与客户经理确认）
1419
+ # 通过此接口可以关闭个人用户自动签功能。
1420
+ # 无需对应的用户刷脸等方式同意即可关闭。
1421
+
1422
+ # 注意:
1423
+
1424
+ # <ul><li>处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。</li>
1425
+ # <li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
1402
1426
 
1403
1427
  # @param request: Request instance for DisableUserAutoSign.
1404
1428
  # @type request: :class:`Tencentcloud::ess::V20201111::DisableUserAutoSignRequest`
@@ -1532,8 +1556,9 @@ module TencentCloud
1532
1556
  end
1533
1557
 
1534
1558
  # 此接口用于启动流程。它是模板发起合同的最后一步。
1535
- # 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于激活包含完整合同信息（模板及内容信息）的流程。
1536
- # 流程激活后，将生成一份待签署的电子合同。
1559
+ # 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
1560
+
1561
+ # <svg id="SvgjsSvg1077" width="304" height="505" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1078"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1096" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1097" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1108" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1109" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1120" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1121" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker><marker id="SvgjsMarker1140" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1141" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="304" height="505" fill="transparent"></rect><rect id="SvgjsRect1080" width="304" height="505" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1081" width="304" height="505" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1082" transform="translate(58,121)"><path id="SvgjsPath1083" d="M 0 0L 221 0L 221 262L 0 262Z" stroke-dasharray="3,4" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1084"><text id="SvgjsText1085" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="201px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="120.375" transform="rotate(0)"></text></g></g><g id="SvgjsG1086" transform="translate(88,140.00000000000006)"><path id="SvgjsPath1087" d="M 0 0L 161 0L 161 48L 0 48Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1088"><text id="SvgjsText1089" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="141px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="4.875" transform="rotate(0)"><tspan id="SvgjsTspan1090" dy="16" x="80.5"><tspan id="SvgjsTspan1091" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlow</tspan></tspan><tspan id="SvgjsTspan1092" dy="16" x="80.5"><tspan id="SvgjsTspan1093" style="text-decoration:;">创建签署流程</tspan></tspan></text></g></g><g id="SvgjsG1094"><path id="SvgjsPath1095" d="M168.5 188.50000000000006L168.5 200.83333333333337L168.5 200.83333333333337L168.5 211.86666666666667" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1096)"></path></g><g id="SvgjsG1098" transform="translate(104.25,213.66666666666669)"><path id="SvgjsPath1099" d="M 0 0L 128.5 0L 128.5 55L 0 55Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1100"><text id="SvgjsText1101" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="109px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1102" dy="16" x="64.5"><tspan id="SvgjsTspan1103" style="text-decoration:;fill: rgb(28, 30, 33);">CreateDocument</tspan></tspan><tspan id="SvgjsTspan1104" dy="16" x="64.5"><tspan id="SvgjsTspan1105" style="text-decoration:;">创建电子文档</tspan></tspan></text></g></g><g id="SvgjsG1106"><path id="SvgjsPath1107" d="M168.5 269.16666666666674L168.5 281.5L168.5 281.5L168.5 292.5333333333334" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1108)"></path></g><g id="SvgjsG1110" transform="translate(96.75,294.33333333333337)"><path id="SvgjsPath1111" d="M 0 0L 143.5 0L 143.5 65L 0 65Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1112"><text id="SvgjsText1113" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="124px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="13.375" transform="rotate(0)"><tspan id="SvgjsTspan1114" dy="16" x="72"><tspan id="SvgjsTspan1115" style="text-decoration:;fill: rgb(28, 30, 33);">StartFlow</tspan></tspan><tspan id="SvgjsTspan1116" dy="16" x="72"><tspan id="SvgjsTspan1117" style="text-decoration:;">发起签署流程</tspan></tspan></text></g></g><g id="SvgjsG1118"><path id="SvgjsPath1119" d="M168.5 359.83333333333337L168.5 392.16666666666674L168.5 392.16666666666674L168.5 423.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1120)"></path></g><g id="SvgjsG1122" transform="translate(106.25,425)"><path id="SvgjsPath1123" d="M 0 0L 124.5 0L 124.5 55L 0 55Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1124"><text id="SvgjsText1125" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="105px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="8.375" transform="rotate(0)"><tspan id="SvgjsTspan1126" dy="16" x="62.5"><tspan id="SvgjsTspan1127" style="text-decoration:;">开始签署</tspan></tspan><tspan id="SvgjsTspan1128" dy="16" x="62.5"><tspan id="SvgjsTspan1129" style="text-decoration:;">(小程序/H5等)</tspan></tspan></text></g></g><g id="SvgjsG1130" transform="translate(120.5,25)"><path id="SvgjsPath1131" d="M 0 0L 96 0L 96 54L 0 54Z" stroke="rgba(33,41,48,1)" stroke-width="1" fill-opacity="1" fill="#ffffff"></path><g id="SvgjsG1132"><text id="SvgjsText1133" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="76px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="7.875" transform="rotate(0)"><tspan id="SvgjsTspan1134" dy="16" x="48"><tspan id="SvgjsTspan1135" style="text-decoration:;">控制台创建</tspan></tspan><tspan id="SvgjsTspan1136" dy="16" x="48"><tspan id="SvgjsTspan1137" style="text-decoration:;">模板</tspan></tspan></text></g></g><g id="SvgjsG1138"><path id="SvgjsPath1139" d="M168.5 79.5L168.5 109.5L168.5 109.5L168.5 138.20000000000005" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1140)"></path></g><g id="SvgjsG1142" transform="translate(25,114)"><path id="SvgjsPath1143" d="M 0 0L 100 0L 100 40L 0 40Z" stroke="none" fill="none"></path><g id="SvgjsG1144"><text id="SvgjsText1145" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="100px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="9.375" transform="rotate(0)"><tspan id="SvgjsTspan1146" dy="16" x="50"><tspan id="SvgjsTspan1147" style="text-decoration:;">API</tspan></tspan></text></g></g></svg>
1537
1562
 
1538
1563
  # @param request: Request instance for StartFlow.
1539
1564
  # @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`
data/lib/v20201111/models.rb CHANGED
@@ -301,48 +301,49 @@ module TencentCloud
301
301
 
302
302
  # 自动签开启、签署相关配置
303
303
  class AutoSignConfig < TencentCloud::Common::AbstractModel
304
- # @param UserInfo: 自动签开通个人用户的三要素
304
+ # @param UserInfo: 自动签开通个人用户信息, 包括名字,身份证等
305
305
  # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
306
- # @param CallbackUrl: 接受回调URL地址。支持http://或者https://协议
307
-
308
- # Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
309
- # @type CallbackUrl: String
310
- # @param CertInfoCallback: 是否回调证书信息
311
- # false-不需要 (默认值)
312
- # true-需要
306
+ # @param CertInfoCallback: 是否回调证书信息:
307
+ # <ul><li>**false**: 不需要(默认)</li>
308
+ # <li>**true**:需要</li></ul>
313
309
  # @type CertInfoCallback: Boolean
314
- # @param UserDefineSeal: 是否支持用户自定义签名印章
315
- # false-不需要(默认)
316
- # true-需要
310
+ # @param UserDefineSeal: 是否支持用户自定义签名印章:
311
+ # <ul><li>**false**: 不能自己定义(默认)</li>
312
+ # <li>**true**: 可以自己定义</li></ul>
317
313
  # @type UserDefineSeal: Boolean
318
- # @param SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64
319
-
320
- # false-不需要(默认)
321
- # true-需要
314
+ # @param SealImgCallback: 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
315
+ # <ul><li>**false**: 不需要(默认)</li>
316
+ # <li>**true**: 需要</li></ul>
322
317
  # @type SealImgCallback: Boolean
323
- # @param VerifyChannels: 开通时候的验证方式, 分布为
324
-
325
- # WEIXINAPP : 微信人脸识别
326
- # INSIGHT : 慧眼人脸认别
327
- # TELECOM : 运营商三要素验证
328
-
329
- # 如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。
330
-
331
- # 如果是 H5 开通链接，支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
318
+ # @param CallbackUrl: 执行结果的回调URL，该URL仅支持HTTP或HTTPS协议，建议采用HTTPS协议以保证数据传输的安全性。
319
+ # 腾讯电子签服务器将通过POST方式，application/json格式通知执行结果，请确保外网可以正常访问该URL。
320
+ # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
321
+ # @type CallbackUrl: String
322
+ # @param VerifyChannels: 开通时候的身份验证方式, 取值为：
323
+ # <ul><li>**WEIXINAPP** : 微信人脸识别</li>
324
+ # <li>**INSIGHT** : 慧眼人脸认别</li>
325
+ # <li>**TELECOM** : 运营商三要素验证</li></ul>
326
+ # 注：
327
+ # <ul><li>如果是小程序开通链接，支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
328
+ # <li>如果是 H5 开通链接，支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
332
329
  # @type VerifyChannels: Array
333
- # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。
334
- # 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
335
- # 1-不绑定，发起合同时将按标准合同套餐进行扣减
330
+ # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
331
+
332
+ # <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
333
+ # <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
336
334
  # @type LicenseType: Integer
337
335
 
338
- attr_accessor :UserInfo, :CallbackUrl, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :VerifyChannels, :LicenseType
336
+ attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType
337
+ extend Gem::Deprecate
338
+ deprecate :CallbackUrl, :none, 2023, 9
339
+ deprecate :CallbackUrl=, :none, 2023, 9
339
340
 
340
- def initialize(userinfo=nil, callbackurl=nil, certinfocallback=nil, userdefineseal=nil, sealimgcallback=nil, verifychannels=nil, licensetype=nil)
341
+ def initialize(userinfo=nil, certinfocallback=nil, userdefineseal=nil, sealimgcallback=nil, callbackurl=nil, verifychannels=nil, licensetype=nil)
341
342
  @UserInfo = userinfo
342
- @CallbackUrl = callbackurl
343
343
  @CertInfoCallback = certinfocallback
344
344
  @UserDefineSeal = userdefineseal
345
345
  @SealImgCallback = sealimgcallback
346
+ @CallbackUrl = callbackurl
346
347
  @VerifyChannels = verifychannels
347
348
  @LicenseType = licensetype
348
349
  end
@@ -352,10 +353,10 @@ module TencentCloud
352
353
  @UserInfo = UserThreeFactor.new
353
354
  @UserInfo.deserialize(params['UserInfo'])
354
355
  end
355
- @CallbackUrl = params['CallbackUrl']
356
356
  @CertInfoCallback = params['CertInfoCallback']
357
357
  @UserDefineSeal = params['UserDefineSeal']
358
358
  @SealImgCallback = params['SealImgCallback']
359
+ @CallbackUrl = params['CallbackUrl']
359
360
  @VerifyChannels = params['VerifyChannels']
360
361
  @LicenseType = params['LicenseType']
361
362
  end
@@ -587,12 +588,12 @@ module TencentCloud
587
588
  # @param Operator: 执行本接口操作的员工信息。
588
589
  # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
589
590
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
590
- # @param SceneKey: 企业开通用户自动签场景，例如电子处方。
591
- # <ul>
592
- # <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
593
- # </ul>
591
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
592
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
593
+
594
+ # 注: `现在仅支持电子处方场景`
594
595
  # @type SceneKey: String
595
- # @param UserInfo: 指定撤销链接的用户指定撤销链接的用户信息，包含姓名、证件类型、证件号码。
596
+ # @param UserInfo: 预撤销链接的用户信息，包含姓名、证件类型、证件号码等信息。
596
597
  # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
597
598
  # @param Agent: 代理企业和员工的信息。
598
599
  # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -1055,15 +1056,31 @@ module TencentCloud
1055
1056
 
1056
1057
  # CreateConvertTaskApi请求参数结构体
1057
1058
  class CreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
1058
- # @param ResourceType: 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
1059
+ # @param ResourceType: 需要进行转换的资源文件类型
1060
+ # 支持的文件类型如下：
1061
+ # <ul><li>doc</li>
1062
+ # <li>docx</li>
1063
+ # <li>xls</li>
1064
+ # <li>xlsx</li>
1065
+ # <li>jpg</li>
1066
+ # <li>jpeg</li>
1067
+ # <li>png</li>
1068
+ # <li>bmp</li>
1069
+ # <li>txt</li></ul>
1059
1070
  # @type ResourceType: String
1060
- # @param ResourceName: 资源名称，长度限制为256字符
1071
+ # @param ResourceName: 需要进行转换操作的文件资源名称，带资源后缀名。
1072
+
1073
+ # 注: `资源名称长度限制为256个字符`
1061
1074
  # @type ResourceName: String
1062
- # @param ResourceId: 文件Id，通过UploadFiles获取
1075
+ # @param ResourceId: 需要进行转换操作的文件资源Id，通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
1076
+
1077
+ # 注: `目前，此接口仅支持单个文件进行转换。`
1063
1078
  # @type ResourceId: String
1064
- # @param Operator: 调用方用户信息，userId 必填
1079
+ # @param Operator: 执行本接口操作的员工信息。
1080
+ # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。
1065
1081
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1066
- # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
1082
+ # @param Agent: 代理企业和员工的信息。
1083
+ # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
1067
1084
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1068
1085
  # @param Organization: 暂未开放
1069
1086
  # @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
@@ -1103,7 +1120,7 @@ module TencentCloud
1103
1120
 
1104
1121
  # CreateConvertTaskApi返回参数结构体
1105
1122
  class CreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel
1106
- # @param TaskId: 转换任务Id
1123
+ # @param TaskId: 接口返回的文件转换任务Id，可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
1107
1124
  # @type TaskId: String
1108
1125
  # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1109
1126
  # @type RequestId: String
@@ -1125,22 +1142,29 @@ module TencentCloud
1125
1142
  class CreateDocumentRequest < TencentCloud::Common::AbstractModel
1126
1143
  # @param Operator: 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
1127
1144
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1128
- # @param FlowId: 签署流程编号,由CreateFlow接口返回
1145
+ # @param FlowId: 合同流程ID，为32位字符串。
1146
+ # 此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
1129
1147
  # @type FlowId: String
1130
- # @param TemplateId: 用户上传的模板ID
1148
+ # @param TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
1149
+ # 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
1131
1150
  # @type TemplateId: String
1132
1151
  # @param FileNames: 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
1133
1152
  # @type FileNames: Array
1134
- # @param FormFields: 内容控件信息数组
1153
+ # @param FormFields: 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
1135
1154
  # @type FormFields: Array
1136
- # @param NeedPreview: 是否需要生成预览文件 默认不生成；
1137
- # 预览链接有效期300秒；
1155
+ # @param NeedPreview: 是否为预览模式，取值如下：
1156
+ # <ul><li> **false**：非预览模式（默认），会产生合同流程并返回合同流程编号FlowId。</li>
1157
+ # <li> **true**：预览模式，不产生合同流程，不返回合同流程编号FlowId，而是返回预览链接PreviewUrl，有效期为300秒，用于查看真实发起后合同的样子。</li></ul>
1138
1158
  # @type NeedPreview: Boolean
1139
- # @param PreviewType: 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
1159
+ # @param PreviewType: 预览模式下产生的预览链接类型
1160
+ # <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
1161
+ # <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
1162
+ # 注: `此参数在NeedPreview 为true时有效`
1140
1163
  # @type PreviewType: Integer
1141
- # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1164
+ # @param Agent: 代理企业和员工的信息。
1165
+ # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
1142
1166
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1143
- # @param ClientToken: 客户端Token，保持接口幂等性,最大长度64个字符
1167
+ # @param ClientToken: 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
1144
1168
  # @type ClientToken: String
1145
1169
 
1146
1170
  attr_accessor :Operator, :FlowId, :TemplateId, :FileNames, :FormFields, :NeedPreview, :PreviewType, :Agent, :ClientToken
@@ -1185,9 +1209,14 @@ module TencentCloud
1185
1209
 
1186
1210
  # CreateDocument返回参数结构体
1187
1211
  class CreateDocumentResponse < TencentCloud::Common::AbstractModel
1188
- # @param DocumentId: 签署流程电子文档ID
1212
+ # @param DocumentId: 合同流程的底层电子文档ID，为32位字符串。
1213
+
1214
+ # 注:
1215
+ # 后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>，合同才能进入签署环节
1189
1216
  # @type DocumentId: String
1190
- # @param PreviewFileUrl: 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
1217
+ # @param PreviewFileUrl: 合同预览链接URL。
1218
+
1219
+ # 注：如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
1191
1220
  # 注意：此字段可能返回 null，表示取不到有效值。
1192
1221
  # @type PreviewFileUrl: String
1193
1222
  # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1912,45 +1941,74 @@ module TencentCloud
1912
1941
 
1913
1942
  # CreateFlow请求参数结构体
1914
1943
  class CreateFlowRequest < TencentCloud::Common::AbstractModel
1915
- # @param Operator: 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
1944
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时，必须填写userId。
1945
+ # 支持填入集团子公司经办人 userId 代发合同。
1946
+
1947
+ # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
1916
1948
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1917
- # @param FlowName: 签署流程名称,最大长度200个字符
1949
+ # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
1950
+
1951
+ # 该名称还将用于合同签署完成后的下载文件名。
1918
1952
  # @type FlowName: String
1919
- # @param Approvers: 签署流程参与者信息，最大限制50方
1920
- # 注意 approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效。
1953
+ # @param Approvers: 合同流程的参与方列表，最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，具体定义可以参考开发者中心的ApproverInfo结构体。
1954
+
1955
+ # 注: `approver中的顺序需要和模板中的顺序保持一致， 否则会导致模板中配置的信息无效`
1921
1956
  # @type Approvers: Array
1922
- # @param FlowDescription: 签署流程描述,最大长度1000个字符
1957
+ # @param FlowDescription: 合同流程描述信息(可自定义此描述)，最大长度1000个字符。
1923
1958
  # @type FlowDescription: String
1924
- # @param FlowType: 签署流程的类型(如销售合同/入职合同等)，最大长度200个字符
1959
+ # @param FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
1925
1960
  # @type FlowType: String
1926
- # @param ClientToken: 客户端Token，保持接口幂等性,最大长度64个字符
1961
+ # @param ClientToken: 已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
1927
1962
  # @type ClientToken: String
1928
- # @param DeadLine: 签署流程的签署截止时间。
1929
-
1930
- # 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1963
+ # @param DeadLine: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
1964
+ # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
1931
1965
  # @type DeadLine: Integer
1932
- # @param RemindedOn: 合同到期提醒时间戳，单位秒。设定该值后，可以提前进行到期通知，方便客户处理合同到期事务，如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
1966
+ # @param RemindedOn: 合同到期提醒时间，为Unix标准时间戳（秒）格式，支持的范围是从发起时间开始到后10年内。
1967
+
1968
+ # 到达提醒时间后，腾讯电子签会短信通知发起方企业合同提醒，可用于处理合同到期事务，如合同续签等事宜。
1933
1969
  # @type RemindedOn: Integer
1934
- # @param UserData: 用户自定义字段，回调的时候会进行透传，长度需要小于20480
1970
+ # @param UserData: 调用方自定义的个性化字段(可自定义此名称)，并以base64方式编码，支持的最大数据大小为 20480长度。
1971
+
1972
+ # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
1935
1973
  # @type UserData: String
1936
- # @param Unordered: 发送类型：
1937
- # true：无序签
1938
- # false：有序签
1939
- # 注：默认为false（有序签），请和模板中的配置保持一致
1974
+ # @param Unordered: 合同流程的签署顺序类型：
1975
+ # <ul><li> **false**：(默认)有序签署, 本合同多个参与人需要依次签署 </li>
1976
+ # <li> **true**：无序签署, 本合同多个参与人没有先后签署限制</li></ul>
1977
+ # 注：`请和模板中的配置保持一致`
1940
1978
  # @type Unordered: Boolean
1941
- # @param CustomShowMap: 合同显示的页卡模板，说明：只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名}，且N不能超过签署人的数量，N从1开始
1942
- # @type CustomShowMap: String
1943
- # @param NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
1944
- # 若设置为true，审核结果需通过接口 CreateFlowSignReview 通知电子签，审核通过后，发起方企业签署人方可进行签署操作，否则会阻塞其签署操作。
1979
+ # @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板，模板中支持以下变量：
1980
+ # <ul><li>{合同名称} </li>
1981
+ # <li>{发起方企业} </li>
1982
+ # <li>{发起方姓名} </li>
1983
+ # <li>{签署方N企业}</li>
1984
+ # <li>{签署方N姓名}</li></ul>
1985
+ # 其中，N表示签署方的编号，从1开始，不能超过签署人的数量。
1945
1986
 
1946
- # 注：企业可以通过此功能与企业内部的审批流程进行关联，支持手动、静默签署合同。
1987
+ # 例如，如果是腾讯公司张三发给李四名称为“租房合同”的合同，您可以将此字段设置为：`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`，则小程序中列表页展示此合同为以下样子
1988
+
1989
+ # 合同名称：租房合同
1990
+ # 发起方：腾讯公司(张三)
1991
+ # 签署方：李四
1992
+
1993
+ # @type CustomShowMap: String
1994
+ # @param NeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
1995
+ # <ul><li> **false**：（默认）不需要审批，直接签署。</li>
1996
+ # <li> **true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
1997
+ # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1998
+ # <ul><li> 如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
1999
+ # <li> 如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
2000
+ # 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
1947
2001
  # @type NeedSignReview: Boolean
1948
- # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2002
+ # @param Agent: 代理企业和员工的信息。
2003
+ # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
1949
2004
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1950
- # @param CcInfos: 被抄送人的信息列表。
1951
- # 注: 此功能为白名单功能，若有需要，请联系电子签客服开白使用。
2005
+ # @param CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
2006
+
2007
+ # 注:`此功能为白名单功能，使用前请联系对接的客户经理沟通。`
1952
2008
  # @type CcInfos: Array
1953
- # @param AutoSignScene: 个人自动签场景。发起自动签署时，需设置对应自动签署场景，目前仅支持场景：处方单-E_PRESCRIPTION_AUTO_SIGN
2009
+ # @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传：
2010
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN**：处方单（医疗自动签） </li></ul>
2011
+ # 注: `个人自动签名场景是白名单功能，使用前请与对接的客户经理联系沟通。`
1954
2012
  # @type AutoSignScene: String
1955
2013
  # @param RelatedFlowId: 暂未开放
1956
2014
  # @type RelatedFlowId: String
@@ -2027,11 +2085,12 @@ module TencentCloud
2027
2085
 
2028
2086
  # CreateFlow返回参数结构体
2029
2087
  class CreateFlowResponse < TencentCloud::Common::AbstractModel
2030
- # @param FlowId: 签署流程编号，
2088
+ # @param FlowId: 合同流程ID，为32位字符串。
2089
+ # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
2031
2090
 
2032
- # 返回的流程编号，需要在CreateDocument，StartFlow中使用，
2091
+ # 注:
2092
+ # 此返回的合同流程ID，需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后，合同才能进入签署环节
2033
2093
 
2034
- # 注意：这三个接口（CreateFlow，CreateDocument，StartFlow）要一并调用，才算发起成功
2035
2094
  # @type FlowId: String
2036
2095
  # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2037
2096
  # @type RequestId: String
@@ -3027,8 +3086,10 @@ module TencentCloud
3027
3086
  # @param Deadline: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的7天时截止。
3028
3087
  # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
3029
3088
  # @type Deadline: Integer
3030
- # @param UserData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
3089
+ # @param UserData: 调用方自定义的个性化字段，该字段的值可以是字符串JSON或其他字符串形式，客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输，支持的最大数据大小为20480长度。
3090
+
3031
3091
  # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
3092
+
3032
3093
  # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3033
3094
  # @type UserData: String
3034
3095
 
@@ -3432,27 +3493,30 @@ module TencentCloud
3432
3493
 
3433
3494
  # CreateUserAutoSignEnableUrl请求参数结构体
3434
3495
  class CreateUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
3435
- # @param Operator: 操作人信息,UserId必填
3496
+ # @param Operator: 执行本接口操作的员工信息。
3497
+ # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
3436
3498
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3437
- # @param SceneKey: 自动签场景:
3438
- # E_PRESCRIPTION_AUTO_SIGN 电子处方
3499
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
3500
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
3501
+
3502
+ # 注: `现在仅支持电子处方场景`
3439
3503
  # @type SceneKey: String
3440
- # @param AutoSignConfig: 自动签开通，签署相关配置
3504
+ # @param AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
3441
3505
  # @type AutoSignConfig: :class:`Tencentcloud::Ess.v20201111.models.AutoSignConfig`
3442
- # @param UrlType: 链接类型，
3443
- # 空-默认小程序端链接
3444
- # H5SIGN-h5端链接
3506
+ # @param UrlType: 生成的链接类型：
3507
+ # <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
3508
+ # <li> **H5SIGN** : 生成H5端开通链接</li></ul>
3445
3509
  # @type UrlType: String
3446
- # @param NotifyType: 通知类型
3447
-
3448
- # 默认不设置为不通知开通方，
3449
- # SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
3510
+ # @param NotifyType: 是否通知开通方，通知类型:
3511
+ # <ul><li>默认不设置为不通知开通方</li>
3512
+ # <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
3450
3513
  # @type NotifyType: String
3451
3514
  # @param NotifyAddress: 如果通知类型NotifyType选择为SMS，则此处为手机号, 其他通知类型不需要设置此项
3452
3515
  # @type NotifyAddress: String
3453
- # @param ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为30天。如果不传，默认有效期为7天。
3516
+ # @param ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
3454
3517
  # @type ExpiredTime: Integer
3455
- # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3518
+ # @param Agent: 代理企业和员工的信息。
3519
+ # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
3456
3520
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3457
3521
 
3458
3522
  attr_accessor :Operator, :SceneKey, :AutoSignConfig, :UrlType, :NotifyType, :NotifyAddress, :ExpiredTime, :Agent
@@ -3491,17 +3555,27 @@ module TencentCloud
3491
3555
 
3492
3556
  # CreateUserAutoSignEnableUrl返回参数结构体
3493
3557
  class CreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
3494
- # @param Url: 跳转短链
3558
+ # @param Url: 个人用户自动签的开通链接, 短链形式
3495
3559
  # @type Url: String
3496
- # @param AppId: 小程序AppId
3560
+ # @param AppId: 腾讯电子签小程序的 AppID，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
3561
+
3562
+ # 注: `如果获取的是H5链接, 则不会返回此值`
3497
3563
  # @type AppId: String
3498
- # @param AppOriginalId: 小程序 原始 Id
3564
+ # @param AppOriginalId: 腾讯电子签小程序的原始 Id, ，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
3565
+
3566
+ # 注: `如果获取的是H5链接, 则不会返回此值`
3499
3567
  # @type AppOriginalId: String
3500
- # @param Path: 跳转路径
3568
+ # @param Path: 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
3569
+
3570
+ # 注: `如果获取的是H5链接, 则不会返回此值`
3501
3571
  # @type Path: String
3502
- # @param QrCode: base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
3572
+ # @param QrCode: base64 格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
3573
+
3574
+ # 注: `如果获取的是H5链接, 则不会返回此二维码图片`
3503
3575
  # @type QrCode: String
3504
- # @param UrlType: 链接类型，空-默认小程序端链接，H5SIGN-h5端链接
3576
+ # @param UrlType: 返回的链接类型
3577
+ # <ul><li> 空: 默认小程序端链接</li>
3578
+ # <li> **H5SIGN** : h5端链接</li></ul>
3505
3579
  # @type UrlType: String
3506
3580
  # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3507
3581
  # @type RequestId: String
@@ -4935,14 +5009,18 @@ module TencentCloud
4935
5009
 
4936
5010
  # DescribeUserAutoSignStatus请求参数结构体
4937
5011
  class DescribeUserAutoSignStatusRequest < TencentCloud::Common::AbstractModel
4938
- # @param Operator: 操作人信息，UserId必填
5012
+ # @param Operator: 执行本接口操作的员工信息。
5013
+ # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
4939
5014
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4940
- # @param SceneKey: 自动签场景:
4941
- # E_PRESCRIPTION_AUTO_SIGN 电子处方
5015
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
5016
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
5017
+
5018
+ # 注: `现在仅支持电子处方场景`
4942
5019
  # @type SceneKey: String
4943
- # @param UserInfo: 要查询开启状态的用户信息
5020
+ # @param UserInfo: 要查询状态的用户信息, 包括名字,身份证等
4944
5021
  # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
4945
- # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5022
+ # @param Agent: 代理企业和员工的信息。
5023
+ # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
4946
5024
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4947
5025
 
4948
5026
  attr_accessor :Operator, :SceneKey, :UserInfo, :Agent
@@ -4975,16 +5053,18 @@ module TencentCloud
4975
5053
  class DescribeUserAutoSignStatusResponse < TencentCloud::Common::AbstractModel
4976
5054
  # @param IsOpen: 查询用户是否已开通自动签
4977
5055
  # @type IsOpen: Boolean
4978
- # @param LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
5056
+ # @param LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
4979
5057
 
4980
5058
  # 值为unix时间戳,单位为秒。
4981
5059
  # @type LicenseFrom: Integer
4982
- # @param LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
5060
+ # @param LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
5061
+
4983
5062
  # 值为unix时间戳,单位为秒。
4984
5063
  # @type LicenseTo: Integer
4985
- # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后，将扣减购买的个人自动签账号许可一次（1年有效期），不可解绑释放。不传默认为绑定自动签账号许可。
4986
- # 0-绑定个人自动签账号许可，开通后将扣减购买的个人自动签账号许可一次
4987
- # 1-不绑定，发起合同时将按标准合同套餐进行扣减
5064
+ # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
5065
+
5066
+ # <ul><li>**0**: 使用个人自动签账号许可进行开通，个人自动签账号许可有效期1年，注: `不可解绑释放更换他人`</li>
5067
+ # <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
4988
5068
  # @type LicenseType: Integer
4989
5069
  # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4990
5070
  # @type RequestId: String
@@ -5010,14 +5090,16 @@ module TencentCloud
5010
5090
 
5011
5091
  # DisableUserAutoSign请求参数结构体
5012
5092
  class DisableUserAutoSignRequest < TencentCloud::Common::AbstractModel
5013
- # @param Operator: 操作人信息,UserId必填
5093
+ # @param Operator: 执行本接口操作的员工信息。
5094
+ # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
5014
5095
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
5015
- # @param SceneKey: 自动签场景:
5016
- # E_PRESCRIPTION_AUTO_SIGN 电子处方
5096
+ # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
5097
+ # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
5017
5098
  # @type SceneKey: String
5018
- # @param UserInfo: 关闭自动签的个人的三要素
5099
+ # @param UserInfo: 需要关闭自动签的个人的信息，如姓名，证件信息等。
5019
5100
  # @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
5020
- # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5101
+ # @param Agent: 代理企业和员工的信息。
5102
+ # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
5021
5103
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
5022
5104
 
5023
5105
  attr_accessor :Operator, :SceneKey, :UserInfo, :Agent
@@ -5597,46 +5679,54 @@ module TencentCloud
5597
5679
 
5598
5680
  # 创建流程的签署方信息
5599
5681
  class FlowCreateApprover < TencentCloud::Common::AbstractModel
5600
- # @param ApproverType: 参与者类型：
5682
+ # @param ApproverType: 在指定签署方时，可选择企业B端或个人C端等不同的参与者类型，可选类型如下:
5601
5683
  # 0：企业
5602
5684
  # 1：个人
5603
- # 3：企业自动签署
5604
- # 注：类型为3（企业自动签署）时，会自动完成该签署方的签署。
5605
- # 自动签署仅进行盖章操作，不能是手写签名。
5606
- # 本方企业自动签署的签署人会默认是当前的发起人
5607
- # 他方企业自动签署的签署人是自动签模板的他方企业授权人
5685
+ # 3：企业静默签署
5686
+ # 注：类型为3（企业静默签署）时，此接口会默认完成该签署方的签署。静默签署仅进行盖章操作，不能自动签名。
5608
5687
  # 7: 个人自动签署，适用于个人自动签场景。
5609
- # 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
5688
+ # 注: 个人自动签场景为白名单功能，使用前请联系对接的客户经理沟通。
5610
5689
  # @type ApproverType: Integer
5611
- # @param OrganizationName: 签署人企业名称
5612
- # 当approverType=0 或 approverType=3时，必须指定
5690
+ # @param OrganizationName: 组织机构名称。
5691
+ # 请确认该名称与企业营业执照中注册的名称一致。
5692
+ # 如果名称中包含英文括号()，请使用中文括号（）代替。
5693
+
5694
+ # 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时，必须指定`
5613
5695
 
5614
5696
  # @type OrganizationName: String
5615
- # @param ApproverName: 签署方经办人姓名
5616
- # <br/>在未指定签署人电子签UserId情况下，为必填参数
5697
+ # @param ApproverName: 签署方经办人的姓名。
5698
+ # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
5699
+
5700
+ # 在未指定签署人电子签UserId情况下，为必填参数
5617
5701
  # @type ApproverName: String
5618
- # @param ApproverMobile: 签署方经办人手机号码
5619
- # <br/>在未指定签署人电子签UserId情况下，为必填参数
5702
+ # @param ApproverMobile: 签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
5703
+ # 请确认手机号所有方为此合同签署方。
5704
+
5705
+ # 在未指定签署人电子签UserId情况下，为必填参数
5620
5706
  # @type ApproverMobile: String
5621
- # @param ApproverIdCardType: 签署人的证件类型
5622
- # ID_CARD 身份证
5623
- # HONGKONG_AND_MACAO 港澳居民来往内地通行证
5624
- # HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
5625
- # OTHER_CARD_TYPE 其他（需要使用该类型请先联系运营经理）
5707
+ # @param ApproverIdCardType: 证件类型，支持以下类型
5708
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
5709
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
5710
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
5626
5711
  # @type ApproverIdCardType: String
5627
- # @param ApproverIdCardNumber: 签署人证件号（长度不超过18位）
5712
+ # @param ApproverIdCardNumber: 证件号码，应符合以下规则
5713
+ # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
5714
+ # <li>港澳居民来往内地通行证号码应为9位字符串，第1位为“C”，第2位为英文字母（但“I”、“O”除外），后7位为阿拉伯数字。</li>
5715
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
5628
5716
  # @type ApproverIdCardNumber: String
5629
5717
  # @param RecipientId: 签署方经办人在模板中的参与方ID
5630
5718
  # <br/>模板发起合同时，该参数为必填项
5631
5719
  # <br/>文件发起合同是，该参数无序传值
5632
5720
  # @type RecipientId: String
5633
- # @param VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
5721
+ # @param VerifyChannel: 签署意愿确认渠道，默认为WEIXINAPP:人脸识别
5722
+
5723
+ # 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
5634
5724
  # @type VerifyChannel: Array
5635
- # @param NotifyType: 是否发送短信
5636
- # <br/>sms--短信通知
5637
- # <br/>none--不通知
5638
- # <br/>默认为sms
5639
- # <br/>发起方=签署方时不发送短信
5725
+ # @param NotifyType: 通知签署方经办人的方式, 有以下途径:
5726
+ # <ul><li> **sms** : (默认)短信</li>
5727
+ # <li> **none** : 不通知</li></ul>
5728
+
5729
+ # 注: `发起方也是签署方时不给此签署方发送短信`
5640
5730
  # @type NotifyType: String
5641
5731
  # @param IsFullText: 合同强制需要阅读全文，无需传此参数
5642
5732
  # @type IsFullText: Boolean
@@ -5644,22 +5734,20 @@ module TencentCloud
5644
5734
  # @type PreReadTime: Integer
5645
5735
  # @param UserId: 签署人userId，仅支持本企业的员工userid， 可在控制台组织管理处获得
5646
5736
 
5647
- # 若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息
5737
+ # 注: `若传此字段 则以userid的信息为主，会覆盖传递过来的签署人基本信息， 包括姓名，手机号，证件类型等信息`
5648
5738
  # @type UserId: String
5649
- # @param Required: 当前只支持true，默认为true
5739
+ # @param Required: 字段已经废弃，当前只支持true，默认为true
5650
5740
  # @type Required: Boolean
5651
- # @param ApproverSource: 签署人用户来源，此参数仅针对企微用户开放
5652
-
5653
- # 企微侧用户请传入：WEWORKAPP
5741
+ # @param ApproverSource: 在企微场景下使用，需设置参数为**WEWORKAPP**，以表明合同来源于企微。
5654
5742
  # @type ApproverSource: String
5655
- # @param CustomApproverTag: 企业签署方或签标识，客户自定义，64位长度
5656
- # <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
5657
- # <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
5658
- # <br/>如果或签签署人为本方企微参与人，ApproverSource参数需要指定WEWORKAPP
5743
+ # @param CustomApproverTag: 在企业微信场景下，表明该合同流程为或签，其最大长度为64位字符串。
5744
+ # 所有参与或签的人员均需具备该标识。
5745
+ # 注意，在合同中，不同的或签参与人必须保证其CustomApproverTag唯一。
5746
+ # 如果或签签署人为本方企业微信参与人，则需要指定ApproverSource参数为WEWORKAPP。
5659
5747
  # @type CustomApproverTag: String
5660
- # @param RegisterInfo: 快速注册相关信息，目前暂未开放！
5748
+ # @param RegisterInfo: 已经废弃, 快速注册相关信息
5661
5749
  # @type RegisterInfo: :class:`Tencentcloud::Ess.v20201111.models.RegisterInfo`
5662
- # @param ApproverOption: 签署人个性化能力值
5750
+ # @param ApproverOption: 签署人个性化能力值，如是否可以转发他人处理、是否可以拒签等功能开关。
5663
5751
  # @type ApproverOption: :class:`Tencentcloud::Ess.v20201111.models.ApproverOption`
5664
5752
  # @param JumpUrl: 签署完前端跳转的url，暂未使用
5665
5753
  # @type JumpUrl: String
@@ -5667,16 +5755,35 @@ module TencentCloud
5667
5755
  # - 发起流程时系统自动补充
5668
5756
  # - 创建签署链接时，可以通过查询详情接口获得签署人的SignId，然后可传入此值为该签署人创建签署链接，无需再传姓名、手机号、证件号等其他信息
5669
5757
  # @type SignId: String
5670
- # @param ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批
5671
- # <br>true 则为需要
5672
- # <br/>false,无序企业内部审批（默认）
5673
- # <br/>为个人签署方时则由发起方企业审核。
5758
+ # @param ApproverNeedSignReview: 发起方企业的签署人进行签署操作前，是否需要企业内部走审批流程，取值如下：
5759
+ # <ul><li>**false**：（默认）不需要审批，直接签署。</li>
5760
+ # <li>**true**：需要走审批流程。当到对应参与人签署时，会阻塞其签署操作，等待企业内部审批完成。</li></ul>
5761
+ # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
5762
+ # <ul><li>如果企业通知腾讯电子签平台审核通过，签署方可继续签署动作。</li>
5763
+ # <li>如果企业通知腾讯电子签平台审核未通过，平台将继续阻塞签署方的签署动作，直到企业通知平台审核通过。</li></ul>
5764
+
5765
+ # 注：`此功能可用于与企业内部的审批流程进行关联，支持手动、静默签署合同`
5674
5766
  # @type ApproverNeedSignReview: Boolean
5675
5767
  # @param SignComponents: 签署人签署控件， 此参数仅针对文件发起（CreateFlowByFiles）生效
5676
- # <br/>文件发起时，可通过该参数为签署人指定签署控件类型以及位置
5768
+
5769
+ # 合同中的签署控件列表，列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
5770
+ # <ul><li> 个人签名/印章</li>
5771
+ # <li> 企业印章</li>
5772
+ # <li> 骑缝章等签署控件</li></ul>
5773
+
5774
+ # `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
5677
5775
  # @type SignComponents: Array
5678
5776
  # @param Components: 签署人填写控件 此参数仅针对文件发起（CreateFlowByFiles）生效
5679
- # <br/>文件发起时，可通过该参数为签署人指定填写控件类型以及位置
5777
+
5778
+ # 合同中的填写控件列表，列表中可支持下列多种填写控件，控件的详细定义参考开发者中心的Component结构体
5779
+ # <ul><li>单行文本控件</li>
5780
+ # <li>多行文本控件</li>
5781
+ # <li>勾选框控件</li>
5782
+ # <li>数字控件</li>
5783
+ # <li>图片控件</li>
5784
+ # <li>动态表格等填写控件</li></ul>
5785
+
5786
+ # `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
5680
5787
  # @type Components: Array
5681
5788
  # @param ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时，可以指定签署方签名方式
5682
5789
  # HANDWRITE – 手写签名
@@ -5684,13 +5791,28 @@ module TencentCloud
5684
5791
  # ESIGN -- 个人印章类型
5685
5792
  # SYSTEM_ESIGN -- 系统签名（该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署）
5686
5793
  # @type ComponentLimitType: Array
5687
- # @param ApproverVerifyTypes: 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
5794
+ # @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
5795
+ # <ul><li> **1** : （默认）人脸识别,人脸识别后才能合同内容</li>
5796
+ # <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容（当手写签名方式为OCR_ESIGN时，该校验方式无效，因为这种签名方式依赖实名认证）
5797
+ # </li></ul>
5798
+ # 注:
5799
+ # <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
5800
+ # <li>此字段不可传多个校验方式</li></ul>
5801
+
5802
+ # `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
5688
5803
 
5689
- # > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
5804
+ # .
5690
5805
  # @type ApproverVerifyTypes: Array
5691
- # @param ApproverSignTypes: 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
5806
+ # @param ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式，可传递以下值：
5807
+ # <ul><li>**1**：人脸认证，需进行人脸识别成功后才能签署合同；</li>
5808
+ # <li>**2**：签署密码，需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署；</li>
5809
+ # <li>**3**：运营商三要素，需到运营商处比对手机号实名信息（名字、手机号、证件号）校验一致才能成功进行合同签署。</li></ul>
5810
+ # 注：
5811
+ # <ul><li>默认情况下，认证校验方式为人脸认证和签署密码两种形式；</li>
5812
+ # <li>您可以传递多种值，表示可用多种认证校验方式。</li></ul>
5692
5813
 
5693
- # > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
5814
+ # 注:
5815
+ # `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
5694
5816
  # @type ApproverSignTypes: Array
5695
5817
 
5696
5818
  attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes
@@ -7089,26 +7211,26 @@ module TencentCloud
7089
7211
  end
7090
7212
  end
7091
7213
 
7092
- # 解除协议的签署人，如不指定，默认使用待解除流程（即原流程）中的签署人。
7093
- # 注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。
7094
- # 注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。
7095
- # 注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。
7214
+ # 解除协议的签署人，如不指定，默认使用原流程中的签署人。<br/>
7215
+ # `注意：不支持更换C端（个人身份类型）签署人，如果原流程中含有C端签署人，默认使用原流程中的该C端签署人。`<br/>
7216
+ # `注意：目前不支持替换C端（个人身份类型）签署人，但是可以指定C端签署人的签署方自定义控件别名，具体见参数ApproverSignRole描述。`<br/>
7217
+ # `注意：当指定C端签署人的签署方自定义控件别名不空时，除RelievedApproverReceiptId参数外，可以只参数ApproverSignRole。`<br/>
7096
7218
  class ReleasedApprover < TencentCloud::Common::AbstractModel
7097
- # @param Name: 签署人姓名，最大长度50个字符
7219
+ # @param Name: 签署人姓名，最大长度50个字。
7098
7220
  # @type Name: String
7099
- # @param Mobile: 签署人手机号
7221
+ # @param Mobile: 签署人手机号。
7100
7222
  # @type Mobile: String
7101
- # @param RelievedApproverReceiptId: 要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取（即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId ）
7223
+ # @param RelievedApproverReceiptId: 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
7102
7224
  # @type RelievedApproverReceiptId: String
7103
7225
  # @param ApproverType: 指定签署人类型，目前仅支持
7104
- # ORGANIZATION-企业
7105
- # ENTERPRISESERVER-企业静默签
7226
+ # <ul><li> **ORGANIZATION**：企业（默认值）</li>
7227
+ # <li> **ENTERPRISESERVER**：企业静默签</li></ul>
7106
7228
  # @type ApproverType: String
7107
- # @param ApproverSignComponentType: 签署控件类型，支持自定义企业签署方的签署控件为“印章”或“签名”
7108
- # - SIGN_SEAL-默认为印章控件类型
7109
- # - SIGN_SIGNATURE-手写签名控件类型
7229
+ # @param ApproverSignComponentType: 签署控件类型，支持自定义企业签署方的签署控件类型
7230
+ # <ul><li> **SIGN_SEAL**：默认为印章控件类型（默认值）</li>
7231
+ # <li> **SIGN_SIGNATURE**：手写签名控件类型</li></ul>
7110
7232
  # @type ApproverSignComponentType: String
7111
- # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字符
7233
+ # @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方，以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段，最大20个字。
7112
7234
  # @type ApproverSignRole: String
7113
7235
 
7114
7236
  attr_accessor :Name, :Mobile, :RelievedApproverReceiptId, :ApproverType, :ApproverSignComponentType, :ApproverSignRole
@@ -7422,8 +7544,8 @@ module TencentCloud
7422
7544
  # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
7423
7545
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
7424
7546
  # @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
7425
- # 0 - 合同发起时通知（默认）
7426
- # 1 - 签署完成后通知
7547
+ # <ul><li> **0** :合同发起时通知通知对方来查看合同（默认）</li>
7548
+ # <li> **1** : 签署完成后通知对方来查看合同</li></ul>
7427
7549
  # @type CcNotifyType: Integer
7428
7550
 
7429
7551
  attr_accessor :Operator, :FlowId, :ClientToken, :Agent, :CcNotifyType
@@ -7457,9 +7579,9 @@ module TencentCloud
7457
7579
  # StartFlow返回参数结构体
7458
7580
  class StartFlowResponse < TencentCloud::Common::AbstractModel
7459
7581
  # @param Status: 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
7460
- # START - 发起成功
7461
- # REVIEW - 提交审核成功
7462
- # EXECUTING - 已提交发起任务
7582
+ # <ul><li> **START** : 发起成功, 合同进入签署环节</li>
7583
+ # <li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能，使用前请联系对接的客户经理沟通。`</li>
7584
+ # <li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
7463
7585
  # @type Status: String
7464
7586
  # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7465
7587
  # @type RequestId: String
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-ess
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.654
4
+ version: 3.0.656
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-09-07 00:00:00.000000000 Z
11
+ date: 2023-09-11 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common