tencentcloud-sdk-ess 3.0.661 → 3.0.663

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.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8203a8f6ec01f0f5223561028324c870829a70df
4
- data.tar.gz: cdab9adfb6a50eb4d376b6240bd3a88a79eaeea3
3
+ metadata.gz: a137543ecf5d04b21d7194d814ed9f819149de5e
4
+ data.tar.gz: 7955fdc9598e96d9e008f70852cd16d09b2477e3
5
5
  SHA512:
6
- metadata.gz: 225fd4adcc422dd7529f35e696f0c41a7257f8c3e6dce362da345006dda8e03d506f4b51401e293a88c5feaaaf3aa8f40ad6be82b91d01a0bfa048156d0daf2d
7
- data.tar.gz: 62dee719075e925a6a25fcf1556835d637ffe58211e974bf4b28efc57a53103301f3b46d717c920faf88b6d292d0ca93920d4b7bb683f49319525b5473007bb4
6
+ metadata.gz: 4898a9582bf84a20db394425c8d590f2c9d453186a35575eede829fda945849f0da3a0171f972d81d9dbc229def68b9fb31f8eff07f595b85d8fe0fbc1ce25d5
7
+ data.tar.gz: 5c78cee1dbc1d829d7f7e78bb1edac5d3ef2bfd48ac90889dfd7043454403b19a9f5c34486b1f3d58efd64aa93c623e1c7e01e6cfb75866a59eaec118049207f
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.661
1
+ 3.0.663
@@ -159,6 +159,36 @@ module TencentCloud
159
159
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
160
160
  end
161
161
 
162
+ # 通过此接口,创建小程序批量签署链接,个人/企业员工点击此链接即可跳转小程序进行批量签署。
163
+ # 请确保生成链接时候的身份信息和签署合同参与方的信息保持一致。
164
+
165
+ # 注:
166
+ # - 参与人点击链接后需短信验证码才能查看合同内容。
167
+ # - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。
168
+ # - 个人批量签署,签名区`仅支持手写签名`。
169
+
170
+ # @param request: Request instance for CreateBatchSignUrl.
171
+ # @type request: :class:`Tencentcloud::ess::V20201111::CreateBatchSignUrlRequest`
172
+ # @rtype: :class:`Tencentcloud::ess::V20201111::CreateBatchSignUrlResponse`
173
+ def CreateBatchSignUrl(request)
174
+ body = send_request('CreateBatchSignUrl', request.serialize)
175
+ response = JSON.parse(body)
176
+ if response['Response'].key?('Error') == false
177
+ model = CreateBatchSignUrlResponse.new
178
+ model.deserialize(response['Response'])
179
+ model
180
+ else
181
+ code = response['Response']['Error']['Code']
182
+ message = response['Response']['Error']['Message']
183
+ reqid = response['Response']['RequestId']
184
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
185
+ end
186
+ rescue TencentCloud::Common::TencentCloudSDKException => e
187
+ raise e
188
+ rescue StandardError => e
189
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
190
+ end
191
+
162
192
  # 此接口(CreateConvertTaskApi)用来将word、excel、图片、txt类型文件转换为PDF文件。<br />
163
193
  # 前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
164
194
  # 适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
@@ -190,9 +220,11 @@ module TencentCloud
190
220
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
191
221
  end
192
222
 
193
- # 创建签署流程电子文档
194
- # 适用场景:见创建签署流程接口。
195
- # 注:该接口需要给对应的流程指定一个模板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>接口使用, 具体逻辑可以参考下图:
223
+ # 创建签署流程电子文档<br />
224
+ # 适用场景:见创建签署流程接口。<br />
225
+ # 点击查看<a href="https://qian.tencent.com/developers/startFlows/CreateFlow" target="_blank">通过模板创建签署流程</a>
226
+ # <a href="https://qian.tencent.com/developers/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>。<br />
227
+ # 注:该接口需要给对应的流程指定一个模板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>接口使用。具体逻辑可以参考下图:
196
228
 
197
229
  # <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>
198
230
 
@@ -451,10 +483,9 @@ module TencentCloud
451
483
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
452
484
  end
453
485
 
454
- # 提交企业签署流程审批结果
455
- # 适用场景:
456
- # 在通过接口(CreateFlow 或者CreateFlowByFiles)创建签署流程时,若指定了参数 NeedSignReview 为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。
457
- # 若签署流程状态正常,且本企业存在签署方未签署,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
486
+ # 提交签署流程审批结果的适用场景包括:
487
+ # 1. 在使用模板(CreateFlow)或文件(CreateFlowByFiles)创建签署流程时,若指定了参数NeedSignReview为true,且发起方企业作为签署方参与了流程签署,则可以调用此接口提交企业内部签署审批结果。自动签署也需要进行审核通过才会进行签署。
488
+ # 2. 若签署流程状态正常,同一签署流程可以多次提交签署审批结果,签署时的最后一个“审批结果”有效。
458
489
 
459
490
  # @param request: Request instance for CreateFlowSignReview.
460
491
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateFlowSignReviewRequest`
@@ -712,9 +743,9 @@ module TencentCloud
712
743
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
713
744
  end
714
745
 
715
- # 创建快速发起流程
716
- # <br/>适用场景:用户通过API 合同文件及签署信息,并可通过我们返回的URL在页面完成签署控件等信息的编辑与确认,快速发起合同.
717
- # <br/>注:该接口文件的resourceId 是通过上传文件之后获取的。
746
+ # 创建发起流程web页面
747
+ # <br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
748
+ # <br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
718
749
 
719
750
  # @param request: Request instance for CreatePrepareFlow.
720
751
  # @type request: :class:`Tencentcloud::ess::V20201111::CreatePrepareFlowRequest`
@@ -858,7 +889,7 @@ module TencentCloud
858
889
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
859
890
  end
860
891
 
861
- # 对企业员工进行印章授权
892
+ # 本接口(CreateSealPolicy)用于对企业员工进行印章授权
862
893
 
863
894
  # @param request: Request instance for CreateSealPolicy.
864
895
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateSealPolicyRequest`
@@ -908,8 +939,9 @@ module TencentCloud
908
939
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
909
940
  end
910
941
 
911
- # 用来创建嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),该接口配合其他所有可嵌入页面接口使用
912
- # 创建配置对当前企业全局生效,如果多次调用,会以最后一次的配置为准
942
+ # 用来设置本企业嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),设置后获取的web签署界面都会使用此配置进行展示。
943
+
944
+ # 如果多次调用,会以最后一次的配置为准
913
945
 
914
946
  # @param request: Request instance for CreateWebThemeConfig.
915
947
  # @type request: :class:`Tencentcloud::ess::V20201111::CreateWebThemeConfigRequest`
@@ -1009,7 +1041,7 @@ module TencentCloud
1009
1041
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1010
1042
  end
1011
1043
 
1012
- # 撤销员工持有的印章权限
1044
+ # 本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限
1013
1045
 
1014
1046
  # @param request: Request instance for DeleteSealPolicies.
1015
1047
  # @type request: :class:`Tencentcloud::ess::V20201111::DeleteSealPoliciesRequest`
@@ -1062,7 +1094,7 @@ module TencentCloud
1062
1094
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1063
1095
  end
1064
1096
 
1065
- # 查询文件下载URL。
1097
+ # 本接口(DescribeFileUrls)用于查询文件的下载URL。
1066
1098
  # 适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
1067
1099
 
1068
1100
  # @param request: Request instance for DescribeFileUrls.
@@ -1114,7 +1146,7 @@ module TencentCloud
1114
1146
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1115
1147
  end
1116
1148
 
1117
- # 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。
1149
+ # 查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
1118
1150
 
1119
1151
  # @param request: Request instance for DescribeFlowComponents.
1120
1152
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowComponentsRequest`
@@ -1170,7 +1202,8 @@ module TencentCloud
1170
1202
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1171
1203
  end
1172
1204
 
1173
- # 查询合同详情
1205
+ # 接口用户查询合同流程的详情信息, 支持查询多个(数量不能超过100)
1206
+
1174
1207
  # 适用场景:可用于主动查询某个合同详情信息。
1175
1208
 
1176
1209
  # @param request: Request instance for DescribeFlowInfo.
@@ -1195,13 +1228,7 @@ module TencentCloud
1195
1228
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1196
1229
  end
1197
1230
 
1198
- # 本接口用于查询本企业模板列表。
1199
-
1200
- # 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
1201
-
1202
- # > **适用场景**
1203
- # >
1204
- # > 该接口常用来配合“模板发起合同-创建电子文档”接口作为前置的接口使用。
1231
+ # 此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。
1205
1232
  # > 一个模板通常会包含以下结构信息
1206
1233
  # >- 模板基本信息
1207
1234
  # >- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
@@ -1209,6 +1236,12 @@ module TencentCloud
1209
1236
  # >- 签署控件 SignComponents
1210
1237
  # >- 生成模板的文件基础信息 FileInfos
1211
1238
 
1239
+ # 当模板较多或模板中的控件较多时,可以通过查询模板接口更方便的获取模板列表,以及每个模板内的控件信息。
1240
+
1241
+ # 适用场景:
1242
+ # 该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口,作为创建电子文档的前置接口使用。
1243
+ # 通过此接口查询到模板信息后,再通过调用创建电子文档接口,指定模板ID,指定模板中需要的填写控件内容等,完成电子文档的创建。
1244
+
1212
1245
  # @param request: Request instance for DescribeFlowTemplates.
1213
1246
  # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest`
1214
1247
  # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesResponse`
@@ -1659,7 +1692,7 @@ module TencentCloud
1659
1692
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1660
1693
  end
1661
1694
 
1662
- # 对流程的合同文件进行数字签名验证,判断文件是否被篡改。
1695
+ # 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
1663
1696
 
1664
1697
  # @param request: Request instance for VerifyPdf.
1665
1698
  # @type request: :class:`Tencentcloud::ess::V20201111::VerifyPdfRequest`
@@ -1063,6 +1063,130 @@ module TencentCloud
1063
1063
  end
1064
1064
  end
1065
1065
 
1066
+ # CreateBatchSignUrl请求参数结构体
1067
+ class CreateBatchSignUrlRequest < TencentCloud::Common::AbstractModel
1068
+ # @param Operator: 执行本接口操作的员工信息。
1069
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1070
+ # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
1071
+ # @param Name: 签署方经办人的姓名。
1072
+ # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1073
+
1074
+ # 注:`请确保和合同中填入的一致`
1075
+ # @type Name: String
1076
+ # @param Mobile: 手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
1077
+ # 请确认手机号所有方为此业务通知方。
1078
+
1079
+ # 注:`请确保和合同中填入的一致, 若无法保持一致,请确保在发起和生成批量签署链接时传入相同的参与方证件信息`
1080
+ # @type Mobile: String
1081
+ # @param Agent: 代理企业和员工的信息。
1082
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1083
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
1084
+ # @param IdCardType: 证件类型,支持以下类型
1085
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
1086
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
1087
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
1088
+
1089
+ # 注:`请确保和合同中填入的一致`
1090
+ # @type IdCardType: String
1091
+ # @param IdCardNumber: 证件号码,应符合以下规则
1092
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1093
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
1094
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
1095
+
1096
+ # 注:`请确保和合同中填入的一致`
1097
+ # @type IdCardNumber: String
1098
+ # @param NotifyType: 通知用户方式:
1099
+ # <ul>
1100
+ # <li>**NONE** : 不通知(默认)</li>
1101
+ # <li>**SMS** : 短信通知(发送短信通知到Mobile参数所传的手机号)</li>
1102
+ # </ul>
1103
+ # @type NotifyType: String
1104
+ # @param FlowIds: 本次需要批量签署的合同流程ID列表。
1105
+ # 可以不传, 如不传则是发给对方的所有待签署合同流程。
1106
+ # @type FlowIds: Array
1107
+ # @param OrganizationName: 目标签署人的企业名称,签署人如果是企业员工身份,需要传此参数。
1108
+
1109
+ # 注:
1110
+ # <ul>
1111
+ # <li>请确认该名称与企业营业执照中注册的名称一致。</li>
1112
+ # <li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
1113
+ # <li>请确保此企业已完成腾讯电子签企业认证。</li>
1114
+ # </ul>
1115
+ # @type OrganizationName: String
1116
+ # @param JumpToDetail: 是否直接跳转至合同内容页面进行签署
1117
+ # <ul>
1118
+ # <li>**false**: 会跳转至批量合同流程的列表, 点击需要批量签署合同后进入合同内容页面进行签署(默认)</li>
1119
+ # <li>**true**: 跳过合同流程列表, 直接进入合同内容页面进行签署</li>
1120
+ # </ul>
1121
+ # @type JumpToDetail: Boolean
1122
+
1123
+ attr_accessor :Operator, :Name, :Mobile, :Agent, :IdCardType, :IdCardNumber, :NotifyType, :FlowIds, :OrganizationName, :JumpToDetail
1124
+
1125
+ def initialize(operator=nil, name=nil, mobile=nil, agent=nil, idcardtype=nil, idcardnumber=nil, notifytype=nil, flowids=nil, organizationname=nil, jumptodetail=nil)
1126
+ @Operator = operator
1127
+ @Name = name
1128
+ @Mobile = mobile
1129
+ @Agent = agent
1130
+ @IdCardType = idcardtype
1131
+ @IdCardNumber = idcardnumber
1132
+ @NotifyType = notifytype
1133
+ @FlowIds = flowids
1134
+ @OrganizationName = organizationname
1135
+ @JumpToDetail = jumptodetail
1136
+ end
1137
+
1138
+ def deserialize(params)
1139
+ unless params['Operator'].nil?
1140
+ @Operator = UserInfo.new
1141
+ @Operator.deserialize(params['Operator'])
1142
+ end
1143
+ @Name = params['Name']
1144
+ @Mobile = params['Mobile']
1145
+ unless params['Agent'].nil?
1146
+ @Agent = Agent.new
1147
+ @Agent.deserialize(params['Agent'])
1148
+ end
1149
+ @IdCardType = params['IdCardType']
1150
+ @IdCardNumber = params['IdCardNumber']
1151
+ @NotifyType = params['NotifyType']
1152
+ @FlowIds = params['FlowIds']
1153
+ @OrganizationName = params['OrganizationName']
1154
+ @JumpToDetail = params['JumpToDetail']
1155
+ end
1156
+ end
1157
+
1158
+ # CreateBatchSignUrl返回参数结构体
1159
+ class CreateBatchSignUrlResponse < TencentCloud::Common::AbstractModel
1160
+ # @param SignUrl: 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
1161
+
1162
+ # 注: `非小程序和APP集成使用`
1163
+ # @type SignUrl: String
1164
+ # @param ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,默认生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
1165
+ # @type ExpiredTime: Integer
1166
+ # @param MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
1167
+
1168
+ # 注: `小程序和APP集成使用`
1169
+ # @type MiniAppPath: String
1170
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1171
+ # @type RequestId: String
1172
+
1173
+ attr_accessor :SignUrl, :ExpiredTime, :MiniAppPath, :RequestId
1174
+
1175
+ def initialize(signurl=nil, expiredtime=nil, miniapppath=nil, requestid=nil)
1176
+ @SignUrl = signurl
1177
+ @ExpiredTime = expiredtime
1178
+ @MiniAppPath = miniapppath
1179
+ @RequestId = requestid
1180
+ end
1181
+
1182
+ def deserialize(params)
1183
+ @SignUrl = params['SignUrl']
1184
+ @ExpiredTime = params['ExpiredTime']
1185
+ @MiniAppPath = params['MiniAppPath']
1186
+ @RequestId = params['RequestId']
1187
+ end
1188
+ end
1189
+
1066
1190
  # CreateConvertTaskApi请求参数结构体
1067
1191
  class CreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
1068
1192
  # @param ResourceType: 需要进行转换的资源文件类型
@@ -1164,6 +1288,7 @@ module TencentCloud
1164
1288
  # @param NeedPreview: 是否为预览模式,取值如下:
1165
1289
  # <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
1166
1290
  # <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
1291
+ # 注: `当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
1167
1292
  # @type NeedPreview: Boolean
1168
1293
  # @param PreviewType: 预览模式下产生的预览链接类型
1169
1294
  # <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
@@ -1225,7 +1350,8 @@ module TencentCloud
1225
1350
  # @type DocumentId: String
1226
1351
  # @param PreviewFileUrl: 合同预览链接URL。
1227
1352
 
1228
- # 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
1353
+ # 注: `1.如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL`
1354
+ # `2.当使用的模板中存在动态表格控件时,预览结果中没有动态表格的填写内容`
1229
1355
  # 注意:此字段可能返回 null,表示取不到有效值。
1230
1356
  # @type PreviewFileUrl: String
1231
1357
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -1845,44 +1971,44 @@ module TencentCloud
1845
1971
  # 创建合同个性化参数
1846
1972
  class CreateFlowOption < TencentCloud::Common::AbstractModel
1847
1973
  # @param CanEditFlow: 是否允许修改发起合同时确认弹窗的合同信息(合同名称、合同类型、签署截止时间),若不允许编辑,则表单字段将被禁止输入。
1848
- # <br/>true:允许编辑(默认),<br/>false:不允许编辑<br/>默认:false:不允许编辑
1974
+ # <br/>true:允许编辑<br/>false:不允许编辑(默认值)<br/>
1849
1975
  # @type CanEditFlow: Boolean
1850
1976
  # @param CanEditFormField: 是否允许编辑模板控件
1851
1977
  # <br/>true:允许编辑模板控件信息
1852
- # <br/>false:不允许编辑模板控件信息
1853
- # <br/>默认false:不允许编辑模板控件信息
1978
+ # <br/>false:不允许编辑模板控件信息(默认值)
1979
+ # <br/>
1854
1980
  # @type CanEditFormField: Boolean
1855
1981
  # @param HideShowFlowName: 发起页面隐藏合同名称展示
1856
1982
  # <br/>true:发起页面隐藏合同名称展示
1857
- # <br/>false:发起页面不隐藏合同名称展示
1858
- # <br/>默认false:发起页面不隐藏合同名称展示
1983
+ # <br/>false:发起页面不隐藏合同名称展示(默认值)
1984
+ # <br/>
1859
1985
  # @type HideShowFlowName: Boolean
1860
1986
  # @param HideShowFlowType: 发起页面隐藏合同类型展示
1861
1987
  # <br/>true:发起页面隐藏合同类型展示
1862
- # <br/>false:发起页面不隐藏合同类型展示
1863
- # <br/>默认false:发起页面不隐藏合同类型展示
1988
+ # <br/>false:发起页面不隐藏合同类型展示(默认值)
1989
+ # <br/>
1864
1990
  # @type HideShowFlowType: Boolean
1865
1991
  # @param HideShowDeadline: 发起页面隐藏合同截止日期展示
1866
1992
  # <br/>true:发起页面隐藏合同截止日期展示
1867
- # <br/>false:发起页面不隐藏合同截止日期展示
1868
- # <br/>默认false:发起页面不隐藏合同截止日期展示
1993
+ # <br/>false:发起页面不隐藏合同截止日期展示(默认值)
1994
+ # <br/>
1869
1995
  # @type HideShowDeadline: Boolean
1870
1996
  # @param CanSkipAddApprover: 发起页面允许跳过添加签署人环节
1871
1997
  # <br/>true:发起页面允许跳过添加签署人环节
1872
- # <br/>false:发起页面不允许跳过添加签署人环节
1873
- # <br/>默认false:发起页面不允许跳过添加签署人环节
1998
+ # <br/>false:发起页面不允许跳过添加签署人环节(默认值)
1999
+ # <br/>
1874
2000
  # @type CanSkipAddApprover: Boolean
1875
2001
  # @param SkipUploadFile: 文件发起页面跳过文件上传步骤
1876
2002
  # <br/>true:文件发起页面跳过文件上传步骤
1877
- # <br/>false:文件发起页面不跳过文件上传步骤
1878
- # <br/>默认false:文件发起页面不跳过文件上传步骤
2003
+ # <br/>false:文件发起页面不跳过文件上传步骤(默认值)
2004
+ # <br/>
1879
2005
  # @type SkipUploadFile: Boolean
1880
2006
  # @param ForbidEditFillComponent: 禁止编辑填写控件
1881
2007
  # <br/>true:禁止编辑填写控件
1882
- # <br/>false:允许编辑填写控件
1883
- # <br/>默认false:允许编辑填写控件
2008
+ # <br/>false:允许编辑填写控件(默认值)
2009
+ # <br/>
1884
2010
  # @type ForbidEditFillComponent: Boolean
1885
- # @param CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500
2011
+ # @param CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500字符
1886
2012
  # @type CustomCreateFlowDescription: String
1887
2013
 
1888
2014
  attr_accessor :CanEditFlow, :CanEditFormField, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :SkipUploadFile, :ForbidEditFillComponent, :CustomCreateFlowDescription
@@ -2142,30 +2268,33 @@ module TencentCloud
2142
2268
 
2143
2269
  # CreateFlowSignReview请求参数结构体
2144
2270
  class CreateFlowSignReviewRequest < TencentCloud::Common::AbstractModel
2145
- # @param Operator: 调用方用户信息,userId 必填
2271
+ # @param Operator: 执行本接口操作的员工信息。
2272
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2146
2273
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2147
- # @param FlowId: 签署流程编号
2274
+ # @param FlowId: 合同流程ID,为32位字符串。
2275
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2276
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2148
2277
  # @type FlowId: String
2149
- # @param ReviewType: 企业内部审核结果
2150
- # PASS: 通过
2151
- # REJECT: 拒绝
2278
+ # @param ReviewType: 企业审核结果
2279
+ # <ul><li>PASS: 通过</li>
2280
+ # <li>REJECT: 拒绝</li></ul>
2152
2281
  # @type ReviewType: String
2153
- # @param ReviewMessage: 审核原因
2154
- # 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
2282
+ # @param ReviewMessage: 审核结果原因,
2283
+ # 字符串长度不超过200
2284
+ # 当ReviewType 是拒绝(REJECT) 时此字段必填。
2155
2285
  # @type ReviewMessage: String
2156
2286
  # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2157
2287
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
2158
- # @param RecipientId: 审核签署节点使用 非必填 如果填写则审核该签署节点。给个人审核时必填。
2288
+ # @param RecipientId: 审核签署节点人标识,
2289
+ # 用来标识审核的签署方。
2290
+ # 如果签署审核节点是个人, 此参数必填。
2159
2291
  # @type RecipientId: String
2160
- # @param OperateType: 操作类型:(接口通过该字段区分操作类型)
2161
-
2162
- # SignReview:签署审核
2163
- # CreateReview:发起审核
2292
+ # @param OperateType: 操作类型:(接口通过该字段区分不同的操作类型)
2164
2293
 
2165
- # 默认:SignReview;SignReview:签署审核
2294
+ # <ul><li>SignReview: 签署审核(默认)</li>
2295
+ # <li>CreateReview: 创建审核</li></ul>
2166
2296
 
2167
- # 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
2168
- # 若发起个人审核,则指定该字段为:SignReview
2297
+ # 如果审核节点是个人,则操作类型只能为SignReview
2169
2298
  # @type OperateType: String
2170
2299
 
2171
2300
  attr_accessor :Operator, :FlowId, :ReviewType, :ReviewMessage, :Agent, :RecipientId, :OperateType
@@ -2870,67 +2999,79 @@ module TencentCloud
2870
2999
 
2871
3000
  # CreatePrepareFlow请求参数结构体
2872
3001
  class CreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
2873
- # @param Operator: 调用方用户信息,userId 必填
3002
+ # @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId
3003
+ # 支持填入集团子公司经办人 userId 代发合同。
3004
+
3005
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
2874
3006
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
2875
- # @param ResourceId: 资源id,与ResourceType对应
3007
+ # @param ResourceId: 资源id,与ResourceType相对应,取值范围:
3008
+ # <ul>
3009
+ # <li>文件Id(通过UploadFiles获取文件资源Id)</li>
3010
+ # <li>模板Id</li>
3011
+ # </ul>
2876
3012
  # @type ResourceId: String
2877
- # @param FlowName: 合同名称
3013
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
2878
3014
  # @type FlowName: String
2879
- # @param Unordered: 是否顺序签署
2880
- # true:无序签
2881
- # false:顺序签
3015
+ # @param Unordered: 合同流程的签署顺序类型:
3016
+ # <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
3017
+ # <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2882
3018
  # @type Unordered: Boolean
2883
- # @param Deadline: 签署流程的签署截止时间。
2884
- # 值为unix时间戳,精确到秒
2885
- # 不传默认为当前时间一年后
3019
+ # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
2886
3020
  # @type Deadline: Integer
2887
3021
  # @param UserFlowTypeId: 用户自定义合同类型Id
2888
3022
 
2889
- # 该id为电子签企业内的合同类型id, 可以在自定义合同类型处获取
3023
+ # 该id为电子签企业内的合同类型id, 可以在控制台-合同-自定义合同类型处获取
3024
+ # 注: `该参数如果和FlowType同时传,以该参数优先生效`
2890
3025
  # @type UserFlowTypeId: String
2891
- # @param FlowType: 合同类型名称
2892
- # 该字段用于客户自定义合同类型
2893
- # 建议使用时指定合同类型,便于之后合同分类以及查看
2894
- # 如果合同类型与自定义的合同类型描述一致,会自动归类到自定义的合同类型处,如果不一致,则会创建一个新的自定义合同类型
3026
+ # @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
2895
3027
  # @type FlowType: String
2896
- # @param Approvers: 签署流程参与者信息,最大限制50
3028
+ # @param Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
3029
+
3030
+ # 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序,请确保列表中参与人的顺序符合实际签署顺序。
2897
3031
  # @type Approvers: Array
2898
- # @param IntelligentStatus: 打开智能添加填写区
2899
- # 默认开启,打开:"OPEN"
2900
- # 关闭:"CLOSE"
3032
+ # @param IntelligentStatus: 开启或者关闭智能添加填写区:
3033
+ # <ul><li> **OPEN**:开启(默认值)</li>
3034
+ # <li> **CLOSE**:关闭</li></ul>
2901
3035
  # @type IntelligentStatus: String
2902
- # @param ResourceType: 资源类型,
2903
- # 1:模板
2904
- # 2:文件,
2905
- # 不传默认为2:文件
3036
+ # @param ResourceType: 资源类型,取值有:
3037
+ # <ul><li> **1**:模板</li>
3038
+ # <li> **2**:文件(默认值)</li></ul>
2906
3039
  # @type ResourceType: Integer
2907
- # @param Components: 发起方填写控件
2908
- # 该类型控件由发起方完成填写
3040
+ # @param Components: 该字段已废弃,请使用InitiatorComponents
2909
3041
  # @type Components: :class:`Tencentcloud::Ess.v20201111.models.Component`
2910
3042
  # @param FlowOption: 发起合同个性化参数
2911
3043
  # 用于满足创建及页面操作过程中的个性化要求
2912
3044
  # 具体定制化内容详见数据接口说明
2913
3045
  # @type FlowOption: :class:`Tencentcloud::Ess.v20201111.models.CreateFlowOption`
2914
- # @param NeedSignReview: 是否开启发起方签署审核
2915
- # true:开启发起方签署审核
2916
- # false:不开启发起方签署审核
2917
- # 默认false:不开启发起方签署审核
3046
+ # @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3047
+ # <ul><li> **false**:(默认)不需要审批,直接签署。</li>
3048
+ # <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
3049
+ # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3050
+ # <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
3051
+ # <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
3052
+ # 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2918
3053
  # @type NeedSignReview: Boolean
2919
- # @param NeedCreateReview: 开启发起方发起合同审核
2920
- # true:开启发起方发起合同审核
2921
- # false:不开启发起方发起合同审核
2922
- # 默认false:不开启发起方发起合同审核
3054
+ # @param NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3055
+
3056
+ # 若设置为true,发起审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
3057
+
2923
3058
  # @type NeedCreateReview: Boolean
2924
- # @param UserData: 用户自定义参数
3059
+ # @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
3060
+
3061
+ # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
2925
3062
  # @type UserData: String
2926
- # @param FlowId: 合同id,用于通过已web页面发起的合同id快速生成一个web发起合同链接
3063
+ # @param FlowId: 合同Id:用于通过一个已发起的合同快速生成一个发起流程web链接
3064
+ # 注: `该参数必须是一个待发起审核的合同id,并且还未审核通过`
2927
3065
  # @type FlowId: String
2928
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3066
+ # @param Agent: 代理企业和员工的信息。
3067
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2929
3068
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3069
+ # @param InitiatorComponents: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
3070
+ # @type InitiatorComponents: Array
2930
3071
 
2931
- attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :FlowType, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :Agent
3072
+ attr_accessor :Operator, :ResourceId, :FlowName, :Unordered, :Deadline, :UserFlowTypeId, :FlowType, :Approvers, :IntelligentStatus, :ResourceType, :Components, :FlowOption, :NeedSignReview, :NeedCreateReview, :UserData, :FlowId, :Agent, :InitiatorComponents
2932
3073
 
2933
- def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, flowtype=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, agent=nil)
3074
+ def initialize(operator=nil, resourceid=nil, flowname=nil, unordered=nil, deadline=nil, userflowtypeid=nil, flowtype=nil, approvers=nil, intelligentstatus=nil, resourcetype=nil, components=nil, flowoption=nil, needsignreview=nil, needcreatereview=nil, userdata=nil, flowid=nil, agent=nil, initiatorcomponents=nil)
2934
3075
  @Operator = operator
2935
3076
  @ResourceId = resourceid
2936
3077
  @FlowName = flowname
@@ -2948,6 +3089,7 @@ module TencentCloud
2948
3089
  @UserData = userdata
2949
3090
  @FlowId = flowid
2950
3091
  @Agent = agent
3092
+ @InitiatorComponents = initiatorcomponents
2951
3093
  end
2952
3094
 
2953
3095
  def deserialize(params)
@@ -2987,12 +3129,20 @@ module TencentCloud
2987
3129
  @Agent = Agent.new
2988
3130
  @Agent.deserialize(params['Agent'])
2989
3131
  end
3132
+ unless params['InitiatorComponents'].nil?
3133
+ @InitiatorComponents = []
3134
+ params['InitiatorComponents'].each do |i|
3135
+ component_tmp = Component.new
3136
+ component_tmp.deserialize(i)
3137
+ @InitiatorComponents << component_tmp
3138
+ end
3139
+ end
2990
3140
  end
2991
3141
  end
2992
3142
 
2993
3143
  # CreatePrepareFlow返回参数结构体
2994
3144
  class CreatePrepareFlowResponse < TencentCloud::Common::AbstractModel
2995
- # @param Url: 快速发起预览链接,有效期5分钟
3145
+ # @param Url: 发起流程的web页面链接,有效期5分钟
2996
3146
  # @type Url: String
2997
3147
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2998
3148
  # @type RequestId: String
@@ -3014,18 +3164,20 @@ module TencentCloud
3014
3164
  class CreatePreparedPersonalEsignRequest < TencentCloud::Common::AbstractModel
3015
3165
  # @param UserName: 个人用户姓名
3016
3166
  # @type UserName: String
3017
- # @param IdCardNumber: 身份证件号码
3167
+ # @param IdCardNumber: 证件号码,应符合以下规则
3168
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3169
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
3170
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3018
3171
  # @type IdCardNumber: String
3019
- # @param SealName: 印章名称
3172
+ # @param SealName: 印章名称,长度1-50个字。
3020
3173
  # @type SealName: String
3021
- # @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
3174
+ # @param Operator: 执行本接口操作的员工信息。
3175
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3022
3176
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3023
- # @param IdCardType: 身份证件类型:
3024
- # ID_CARD 身份证
3025
- # PASSPORT 护照
3026
- # HONGKONG_AND_MACAO 中国香港
3027
- # FOREIGN_ID_CARD 境外身份
3028
- # HONGKONG_MACAO_AND_TAIWAN 中国台湾
3177
+ # @param IdCardType: 证件类型,支持以下类型
3178
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
3179
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
3180
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
3029
3181
  # @type IdCardType: String
3030
3182
  # @param SealImage: 印章图片的base64
3031
3183
  # 注:已废弃
@@ -3044,16 +3196,19 @@ module TencentCloud
3044
3196
  # RED 红色,
3045
3197
  # BLUE 蓝色。
3046
3198
  # @type SealColor: String
3047
- # @param ProcessSeal: 是否处理印章
3048
- # 默认不做印章处理。
3049
- # 取值:false:不做任何处理;
3050
- # true:做透明化处理和颜色增强。
3199
+ # @param ProcessSeal: 是否处理印章,默认不做印章处理。
3200
+ # 取值如下:
3201
+ # <ul>
3202
+ # <li>false:不做任何处理;</li>
3203
+ # <li>true:做透明化处理和颜色增强。</li>
3204
+ # </ul>
3051
3205
  # @type ProcessSeal: Boolean
3052
3206
  # @param FileId: 印章图片文件 id
3053
3207
  # 取值:
3054
3208
  # 填写的FileId通过UploadFiles接口上传文件获取。
3055
3209
  # @type FileId: String
3056
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3210
+ # @param Agent: 代理企业和员工的信息。
3211
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3057
3212
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3058
3213
  # @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次 1-不绑定,发起合同时将按标准合同套餐进行扣减
3059
3214
  # @type LicenseType: Integer
@@ -3106,7 +3261,8 @@ module TencentCloud
3106
3261
 
3107
3262
  # CreatePreparedPersonalEsign返回参数结构体
3108
3263
  class CreatePreparedPersonalEsignResponse < TencentCloud::Common::AbstractModel
3109
- # @param SealId: 导入生成的印章ID
3264
+ # @param SealId: 导入生成的印章ID,为32位字符串。
3265
+ # 建议开发者保存此印章ID,开头实名认证后,通过此 ID查询导入的印章。
3110
3266
  # @type SealId: String
3111
3267
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3112
3268
  # @type RequestId: String
@@ -3321,11 +3477,14 @@ module TencentCloud
3321
3477
 
3322
3478
  # CreateSealPolicy请求参数结构体
3323
3479
  class CreateSealPolicyRequest < TencentCloud::Common::AbstractModel
3324
- # @param Operator: 调用方用户信息,userId 必填
3480
+ # @param Operator: 执行本接口操作的员工信息。
3481
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3325
3482
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3326
3483
  # @param Users: 用户在电子文件签署平台标识信息,具体参考UserInfo结构体。可跟下面的UserIds可叠加起作用
3327
3484
  # @type Users: Array
3328
- # @param SealId: 印章ID
3485
+ # @param SealId: 电子印章ID,为32位字符串。
3486
+ # 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
3487
+ # 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
3329
3488
  # @type SealId: String
3330
3489
  # @param Expired: 授权有效期。时间戳秒级
3331
3490
  # @type Expired: Integer
@@ -3333,7 +3492,8 @@ module TencentCloud
3333
3492
  # @type UserIds: Array
3334
3493
  # @param Policy: 印章授权内容
3335
3494
  # @type Policy: String
3336
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3495
+ # @param Agent: 代理企业和员工的信息。
3496
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3337
3497
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3338
3498
 
3339
3499
  attr_accessor :Operator, :Users, :SealId, :Expired, :UserIds, :Policy, :Agent
@@ -3374,7 +3534,8 @@ module TencentCloud
3374
3534
 
3375
3535
  # CreateSealPolicy返回参数结构体
3376
3536
  class CreateSealPolicyResponse < TencentCloud::Common::AbstractModel
3377
- # @param UserIds: 最终授权成功的。其他的跳过的是已经授权了的
3537
+ # @param UserIds: 最终授权成功的用户ID,在腾讯电子签平台的唯一身份标识,为32位字符串。
3538
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3378
3539
  # @type UserIds: Array
3379
3540
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3380
3541
  # @type RequestId: String
@@ -3407,10 +3568,12 @@ module TencentCloud
3407
3568
  # 如果要使用图片上传请传字段 Image
3408
3569
  # @type GenerateSource: String
3409
3570
  # @param SealType: 电子印章类型:
3410
- # OFFICIAL-公章;
3411
- # CONTRACT-合同专用章;
3412
- # FINANCE-合财务专用章;
3413
- # PERSONNEL-人事专用章.
3571
+ # <ul>
3572
+ # <li>OFFICIAL-公章;</li>
3573
+ # <li>CONTRACT-合同专用章;</li>
3574
+ # <li>FINANCE-合财务专用章;</li>
3575
+ # <li>PERSONNEL-人事专用章.</li>
3576
+ # </ul>
3414
3577
  # @type SealType: String
3415
3578
  # @param FileName: 电子印章图片文件名称,1-50个中文字符。
3416
3579
  # @type FileName: String
@@ -3435,16 +3598,20 @@ module TencentCloud
3435
3598
  # @type SealCentralType: String
3436
3599
  # @param FileToken: 通过文件上传时,服务端生成的电子印章上传图片的token
3437
3600
  # @type FileToken: String
3438
- # @param SealStyle: 印章样式:
3601
+ # @param SealStyle: 印章样式,取值如下:
3439
3602
 
3440
- # cycle:圆形印章;
3441
- # ellipse:椭圆印章;
3442
- # 注:默认圆形印章
3603
+ # <ul>
3604
+ # <li>cycle:圆形印章;</li>
3605
+ # <li>ellipse:椭圆印章;</li>
3606
+ # <li>注:默认圆形印章</li>
3607
+ # </ul>
3443
3608
  # @type SealStyle: String
3444
3609
  # @param SealSize: 印章尺寸取值描述:
3445
- # 42_42 圆形企业公章直径42mm;
3446
- # 40_40 圆形企业印章直径40mm;
3447
- # 45_30 椭圆形印章45mm x 30mm;
3610
+ # <ul>
3611
+ # <li>42_42 圆形企业公章直径42mm;</li>
3612
+ # <li>40_40 圆形企业印章直径40mm;</li>
3613
+ # <li>45_30 椭圆形印章45mm x 30mm;</li>
3614
+ # </ul>
3448
3615
  # @type SealSize: String
3449
3616
 
3450
3617
  attr_accessor :Operator, :SealName, :Agent, :GenerateSource, :SealType, :FileName, :Image, :Width, :Height, :Color, :SealHorizontalText, :SealChordText, :SealCentralType, :FileToken, :SealStyle, :SealSize
@@ -3496,7 +3663,9 @@ module TencentCloud
3496
3663
 
3497
3664
  # CreateSeal返回参数结构体
3498
3665
  class CreateSealResponse < TencentCloud::Common::AbstractModel
3499
- # @param SealId: 电子印章编号
3666
+ # @param SealId: 电子印章ID,为32位字符串。
3667
+ # 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
3668
+ # 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
3500
3669
  # @type SealId: String
3501
3670
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3502
3671
  # @type RequestId: String
@@ -3670,7 +3839,7 @@ module TencentCloud
3670
3839
  # <ul><li> **EMBED_WEB_THEME**:嵌入式主题(默认),web页面嵌入的主题风格配置</li>
3671
3840
  # </ul>
3672
3841
  # @type ThemeType: String
3673
- # @param WebThemeConfig: 主题配置
3842
+ # @param WebThemeConfig: 电子签logo是否展示,主体颜色等配置项
3674
3843
  # @type WebThemeConfig: :class:`Tencentcloud::Ess.v20201111.models.WebThemeConfig`
3675
3844
  # @param Agent: 代理企业和员工的信息。
3676
3845
  # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
@@ -3900,15 +4069,21 @@ module TencentCloud
3900
4069
 
3901
4070
  # DeleteSealPolicies请求参数结构体
3902
4071
  class DeleteSealPoliciesRequest < TencentCloud::Common::AbstractModel
3903
- # @param Operator: 调用方用户信息,userId 必填
4072
+ # @param Operator: 执行本接口操作的员工信息。
4073
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3904
4074
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
3905
4075
  # @param PolicyIds: 印章授权编码数组。这个参数跟下面的SealId其中一个必填,另外一个可选填
3906
4076
  # @type PolicyIds: Array
3907
- # @param SealId: 印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填
4077
+ # @param SealId: 电子印章ID,为32位字符串。
4078
+ # 建议开发者保留此印章ID,后续指定签署区印章或者操作印章需此印章ID。
4079
+ # 可登录腾讯电子签控制台,在 "印章"->"印章中心"选择查看的印章,在"印章详情" 中查看某个印章的SealId(在页面中展示为印章ID)。
4080
+ # 注:印章ID。这个参数跟上面的PolicyIds其中一个必填,另外一个可选填。
3908
4081
  # @type SealId: String
3909
- # @param UserIds: 待授权的员工ID
4082
+ # @param UserIds: 待授权的员工ID,员工在腾讯电子签平台的唯一身份标识,为32位字符串。
4083
+ # 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3910
4084
  # @type UserIds: Array
3911
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4085
+ # @param Agent: 代理企业和员工的信息。
4086
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3912
4087
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
3913
4088
 
3914
4089
  attr_accessor :Operator, :PolicyIds, :SealId, :UserIds, :Agent
@@ -4076,24 +4251,38 @@ module TencentCloud
4076
4251
 
4077
4252
  # DescribeFileUrls请求参数结构体
4078
4253
  class DescribeFileUrlsRequest < TencentCloud::Common::AbstractModel
4079
- # @param Operator: 调用方用户信息,UserId 必填
4254
+ # @param Operator: 执行本接口操作的员工信息。
4255
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4080
4256
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4081
4257
  # @param BusinessType: 文件对应的业务类型,目前支持:
4082
- # - 流程 "FLOW",如需下载合同文件请选择此项
4083
- # - 模板 "TEMPLATE"
4084
- # - 文档 "DOCUMENT"
4085
- # - 印章 “SEAL”
4258
+ # <ul>
4259
+ # <li>FLOW 如需下载合同文件请选择此项</li>
4260
+ # <li>TEMPLATE 如需下载模板文件请选择此项</li>
4261
+ # <li>DOCUMENT 如需下载文档文件请选择此项</li>
4262
+ # <li>SEAL 如需下载印章图片请选择此项</li>
4263
+ # </ul>
4086
4264
  # @type BusinessType: String
4087
- # @param BusinessIds: 业务编号的数组,如流程编号、模板编号、文档编号、印章编号。如需下载合同文件请传入FlowId
4088
- # 最大支持20个资源
4265
+ # @param BusinessIds: 业务编号的数组,取值如下:
4266
+ # <ul>
4267
+ # <li>流程编号</li>
4268
+ # <li>模板编号</li>
4269
+ # <li>文档编号</li>
4270
+ # <li>印章编号</li>
4271
+ # <li>如需下载合同文件请传入FlowId,最大支持20个资源</li>
4272
+ # </ul>
4089
4273
  # @type BusinessIds: Array
4090
4274
  # @param FileName: 下载后的文件命名,只有FileType为zip的时候生效
4091
4275
  # @type FileName: String
4092
- # @param FileType: 文件类型,"JPG", "PDF","ZIP"等
4276
+ # @param FileType: 要下载的文件类型,取值如下:
4277
+ # <ul>
4278
+ # <li>JPG</li>
4279
+ # <li>PDF</li>
4280
+ # <li>ZIP</li>
4281
+ # </ul>
4093
4282
  # @type FileType: String
4094
- # @param Offset: 指定资源起始偏移量,默认0
4283
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 1000。
4095
4284
  # @type Offset: Integer
4096
- # @param Limit: 指定资源数量,查询全部资源则传入-1
4285
+ # @param Limit: 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 100。
4097
4286
  # @type Limit: Integer
4098
4287
  # @param UrlTtl: 下载url过期时间,单位秒。0: 按默认值5分钟,允许范围:1s~24x60x60s(1天)
4099
4288
  # @type UrlTtl: Integer
@@ -4244,11 +4433,15 @@ module TencentCloud
4244
4433
 
4245
4434
  # DescribeFlowComponents请求参数结构体
4246
4435
  class DescribeFlowComponentsRequest < TencentCloud::Common::AbstractModel
4247
- # @param Operator: 操作者信息
4436
+ # @param Operator: 执行本接口操作的员工信息。
4437
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4248
4438
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4249
- # @param FlowId: 流程(合同)的编号
4439
+ # @param FlowId: 合同流程ID,为32位字符串。
4440
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
4441
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4250
4442
  # @type FlowId: String
4251
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4443
+ # @param Agent: 代理企业和员工的信息。
4444
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4252
4445
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4253
4446
 
4254
4447
  attr_accessor :Operator, :FlowId, :Agent
@@ -4274,7 +4467,7 @@ module TencentCloud
4274
4467
 
4275
4468
  # DescribeFlowComponents返回参数结构体
4276
4469
  class DescribeFlowComponentsResponse < TencentCloud::Common::AbstractModel
4277
- # @param RecipientComponentInfos: 流程关联的填写控件信息,按照参与方进行分类返回。
4470
+ # @param RecipientComponentInfos: 合同流程关联的填写控件信息,按照参与方进行分类返回。
4278
4471
  # 注意:此字段可能返回 null,表示取不到有效值。
4279
4472
  # @type RecipientComponentInfos: Array
4280
4473
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -4363,13 +4556,13 @@ module TencentCloud
4363
4556
 
4364
4557
  # DescribeFlowInfo请求参数结构体
4365
4558
  class DescribeFlowInfoRequest < TencentCloud::Common::AbstractModel
4366
- # @param Operator: 调用方用户信息,userId 必填
4559
+ # @param Operator: 执行本接口操作的员工信息。 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4367
4560
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4368
4561
  # @param FlowIds: 需要查询的流程ID列表,限制最大100个
4369
4562
 
4370
4563
  # 如果查询合同组的信息,不要传此参数
4371
4564
  # @type FlowIds: Array
4372
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4565
+ # @param Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4373
4566
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4374
4567
  # @param FlowGroupId: 合同组ID, 如果传此参数会忽略FlowIds入参
4375
4568
  # 所以如传此参数不要传FlowIds参数
@@ -4402,7 +4595,7 @@ module TencentCloud
4402
4595
  class DescribeFlowInfoResponse < TencentCloud::Common::AbstractModel
4403
4596
  # @param FlowDetailInfos: 签署流程信息
4404
4597
  # @type FlowDetailInfos: Array
4405
- # @param FlowGroupId: 合同组ID
4598
+ # @param FlowGroupId: 合同组ID,为32位字符串
4406
4599
  # @type FlowGroupId: String
4407
4600
  # @param FlowGroupName: 合同组名称
4408
4601
  # @type FlowGroupName: String
@@ -4435,28 +4628,32 @@ module TencentCloud
4435
4628
 
4436
4629
  # DescribeFlowTemplates请求参数结构体
4437
4630
  class DescribeFlowTemplatesRequest < TencentCloud::Common::AbstractModel
4438
- # @param Operator: 调用方员工/经办人信息
4439
- # UserId 必填,在企业控制台组织架构中可以查到员工的UserId
4440
- # 注:请保证员工有相关的角色权限
4631
+ # @param Operator: 执行本接口操作的员工信息。
4632
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4441
4633
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4442
- # @param Agent: 代理相关应用信息
4443
- # 如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4634
+ # @param Agent: 代理企业和员工的信息。
4635
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4444
4636
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4445
- # @param ContentType: 查询内容类型
4446
- # 0-模板列表及详情(默认)
4447
- # 1-仅模板列表
4637
+ # @param ContentType: 查询内容控制
4638
+
4639
+ # <ul><li>**0**:模板列表及详情(默认)</li>
4640
+ # <li>**1**:仅模板列表</li></ul>
4448
4641
  # @type ContentType: Integer
4449
4642
  # @param Filters: 搜索条件,本字段用于指定模板Id进行查询。
4450
- # Key:template-id
4451
- # Values:需要查询的模板Id列表
4643
+ # Key:template-id Values:需要查询的模板Id列表
4452
4644
  # @type Filters: Array
4453
- # @param Offset: 查询结果分页返回,此处指定第几页,如果不传默从第一页返回。页码从0开始,即首页为0。
4645
+ # @param Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
4646
+
4647
+ # 注:`1.offset从0开始,即第一页为0。`
4648
+ # `2.默认从第一页返回。`
4454
4649
  # @type Offset: Integer
4455
- # @param Limit: 指定每页多少条数据,如果不传默认为20,单页最大200。
4650
+ # @param Limit: 指定每页返回的数据条数,和Offset参数配合使用。
4651
+
4652
+ # 注:`1.默认值为20,单页做大值为200。`
4456
4653
  # @type Limit: Integer
4457
- # @param ApplicationId: 用于查询指定应用号下单模板列表。
4458
- # ApplicationId不为空,查询指定应用下的模板列表
4459
- # ApplicationId为空,查询所有应用下的模板列表
4654
+ # @param ApplicationId: 指定查询的应用号,指定后查询该应用号下的模板列表。
4655
+
4656
+ # 注:`1.ApplicationId为空时,查询所有应用下的模板列表。`
4460
4657
  # @type ApplicationId: String
4461
4658
  # @param IsChannel: 默认为false,查询SaaS模板库列表;
4462
4659
  # 为true,查询第三方应用集成平台企业模板库管理列表
@@ -4520,9 +4717,9 @@ module TencentCloud
4520
4717
 
4521
4718
  # DescribeFlowTemplates返回参数结构体
4522
4719
  class DescribeFlowTemplatesResponse < TencentCloud::Common::AbstractModel
4523
- # @param Templates: 模板详情列表
4720
+ # @param Templates: 模板详情列表数据
4524
4721
  # @type Templates: Array
4525
- # @param TotalCount: 查询到的总数
4722
+ # @param TotalCount: 查询到的模板总数
4526
4723
  # @type TotalCount: Integer
4527
4724
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4528
4725
  # @type RequestId: String
@@ -4923,36 +5120,46 @@ module TencentCloud
4923
5120
 
4924
5121
  # DescribeOrganizationSeals请求参数结构体
4925
5122
  class DescribeOrganizationSealsRequest < TencentCloud::Common::AbstractModel
4926
- # @param Operator: 调用方用户信息,userId 必填
5123
+ # @param Operator: 执行本接口操作的员工信息。
5124
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4927
5125
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
4928
- # @param Limit: 返回最大数量,最大为100
5126
+ # @param Limit: 指定分页每页返回的数据条数,如果不传默认为 20,单页最大支持 200。
4929
5127
  # @type Limit: Integer
4930
- # @param Offset: 偏移量,默认为0,最大为20000
5128
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0,最大 20000
4931
5129
  # @type Offset: Integer
4932
- # @param InfoType: 查询信息类型,为0时不返回授权用户,为1时返回
5130
+ # @param InfoType: 查询信息类型,取值如下:
5131
+ # <ul>
5132
+ # <li>0不返回授权用户</li>
5133
+ # <li>1返回授权用户信息</li>
5134
+ # </ul>
4933
5135
  # @type InfoType: Integer
4934
5136
  # @param SealId: 印章id(没有输入返回所有)
4935
5137
  # @type SealId: String
4936
5138
  # @param SealTypes: 印章类型列表(都是组织机构印章)。
4937
5139
  # 为空时查询所有类型的印章。
4938
5140
  # 目前支持以下类型:
4939
- # OFFICIAL:企业公章;
4940
- # CONTRACT:合同专用章;
4941
- # ORGANIZATION_SEAL:企业印章(图片上传创建);
4942
- # LEGAL_PERSON_SEAL:法定代表人章
5141
+ # <ul>
5142
+ # <li>OFFICIAL:企业公章;</li>
5143
+ # <li>CONTRACT:合同专用章;</li>
5144
+ # <li>ORGANIZATION_SEAL:企业印章(图片上传创建);</li>
5145
+ # <li>LEGAL_PERSON_SEAL:法定代表人章</li>
5146
+ # </ul>
4943
5147
  # @type SealTypes: Array
4944
- # @param Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
5148
+ # @param Agent: 代理企业和员工的信息。
5149
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4945
5150
  # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
4946
5151
  # @param SealStatuses: 查询的印章状态列表。
4947
- # 取值为空,只查询启用状态的印章;
4948
- # 取值ALL,查询所有状态的印章;
4949
- # 取值CHECKING,查询待审核的印章;
4950
- # 取值SUCCESS,查询启用状态的印章;
4951
- # 取值FAIL,查询印章审核拒绝的印章;
4952
- # 取值DISABLE,查询已停用的印章;
4953
- # 取值STOPPED,查询已终止的印章;
4954
- # 取值VOID,查询已作废的印章;
4955
- # 取值INVALID,查询已失效的印章;
5152
+ # <ul>
5153
+ # <li>空,只查询启用状态的印章;</li>
5154
+ # <li>ALL,查询所有状态的印章;</li>
5155
+ # <li>CHECKING,查询待审核的印章;</li>
5156
+ # <li>SUCCESS,查询启用状态的印章;</li>
5157
+ # <li>FAIL,查询印章审核拒绝的印章;</li>
5158
+ # <li>DISABLE,查询已停用的印章;</li>
5159
+ # <li>STOPPED,查询已终止的印章;</li>
5160
+ # <li>VOID,查询已作废的印章;</li>
5161
+ # <li>INVALID,查询已失效的印章;</li>
5162
+ # </ul>
4956
5163
  # @type SealStatuses: Array
4957
5164
 
4958
5165
  attr_accessor :Operator, :Limit, :Offset, :InfoType, :SealId, :SealTypes, :Agent, :SealStatuses
@@ -5968,40 +6175,28 @@ module TencentCloud
5968
6175
 
5969
6176
  # 此结构体(FlowDetailInfo)描述的是合同(流程)的详细信息
5970
6177
  class FlowDetailInfo < TencentCloud::Common::AbstractModel
5971
- # @param FlowId: 合同(流程)的ID
6178
+ # @param FlowId: 合同流程ID,为32位字符串。
5972
6179
  # @type FlowId: String
5973
- # @param FlowName: 合同(流程)的名字
6180
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
5974
6181
  # @type FlowName: String
5975
- # @param FlowType: 合同(流程)的类型
6182
+ # @param FlowType: 合同流程的类别分类(如销售合同/入职合同等)。
5976
6183
  # 注意:此字段可能返回 null,表示取不到有效值。
5977
6184
  # @type FlowType: String
5978
- # @param FlowStatus: 流程状态
5979
- # - 0 还没有发起
5980
- # - 1 待签署
5981
- # - 2 部分签署
5982
- # - 3 已拒签
5983
- # - 4 已签署
5984
- # - 5 已过期
5985
- # - 6 已撤销
5986
- # - 7 还没有预发起
5987
- # - 8 等待填写
5988
- # - 9 部分填写
5989
- # - 10 拒填
5990
- # - 21 已解除
6185
+ # @param FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值 <ul><li> **0** : 未开启流程(合同中不存在填写环节)</li> <li> **1** : 待签署</li> <li> **2** : 部分签署</li> <li> **3** : 已拒签</li> <li> **4** : 已签署</li> <li> **5** : 已过期</li> <li> **6** : 已撤销</li> <li> **7** : 未开启流程(合同中存在填写环节)</li> <li> **8** : 等待填写</li> <li> **9** : 部分填写</li> <li> **10** : 已拒填</li> <li> **21** : 已解除</li></ul>
5991
6186
  # @type FlowStatus: Integer
5992
- # @param FlowMessage: 合同(流程)的信息
6187
+ # @param FlowMessage: 当合同流程状态为已拒签(即 FlowStatus=3)或已撤销(即 FlowStatus=6)时,此字段 FlowMessage 为拒签或撤销原因。
5993
6188
  # 注意:此字段可能返回 null,表示取不到有效值。
5994
6189
  # @type FlowMessage: String
5995
- # @param FlowDescription: 流程的描述
6190
+ # @param FlowDescription: 合同流程描述信息。
5996
6191
  # 注意:此字段可能返回 null,表示取不到有效值。
5997
6192
  # @type FlowDescription: String
5998
- # @param CreatedOn: 合同(流程)的创建时间戳,单位秒
6193
+ # @param CreatedOn: 合同流程的创建时间戳,格式为Unix标准时间戳(秒)。
5999
6194
  # @type CreatedOn: Integer
6000
- # @param FlowApproverInfos: 合同(流程)的签署方数组
6195
+ # @param FlowApproverInfos: 合同流程的签署方数组
6001
6196
  # @type FlowApproverInfos: Array
6002
- # @param CcInfos: 合同(流程)的关注方信息列表
6197
+ # @param CcInfos: 合同流程的关注方信息数组
6003
6198
  # @type CcInfos: Array
6004
- # @param Creator: 合同发起人UserId
6199
+ # @param Creator: 合同流程发起方的员工编号, 即员工在腾讯电子签平台的唯一身份标识。
6005
6200
  # 注意:此字段可能返回 null,表示取不到有效值。
6006
6201
  # @type Creator: String
6007
6202
 
@@ -7231,11 +7426,13 @@ module TencentCloud
7231
7426
  # 注意:此字段可能返回 null,表示取不到有效值。
7232
7427
  # @type RecipientId: String
7233
7428
  # @param RecipientFillStatus: 参与方填写状态
7234
- # 0-未填写
7235
- # 1-已填写
7429
+ # <ul><li>0-未填写</li>
7430
+ # <li>1-已填写</li></ul>
7236
7431
  # 注意:此字段可能返回 null,表示取不到有效值。
7237
7432
  # @type RecipientFillStatus: String
7238
7433
  # @param IsPromoter: 是否为发起方
7434
+ # <ul><li>true-发起方</li>
7435
+ # <li>false-参与方</li></ul>
7239
7436
  # 注意:此字段可能返回 null,表示取不到有效值。
7240
7437
  # @type IsPromoter: Boolean
7241
7438
  # @param Components: 填写控件列表
@@ -8256,16 +8453,22 @@ module TencentCloud
8256
8453
 
8257
8454
  # VerifyPdf请求参数结构体
8258
8455
  class VerifyPdfRequest < TencentCloud::Common::AbstractModel
8259
- # @param FlowId: 流程ID
8456
+ # @param FlowId: 合同流程ID,为32位字符串。
8457
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
8260
8458
  # @type FlowId: String
8261
- # @param Operator: 调用方用户信息,userId 必填
8459
+ # @param Operator: 执行本接口操作的员工信息。
8460
+ # 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
8262
8461
  # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
8462
+ # @param Agent: 代理企业和员工的信息。
8463
+ # 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8464
+ # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
8263
8465
 
8264
- attr_accessor :FlowId, :Operator
8466
+ attr_accessor :FlowId, :Operator, :Agent
8265
8467
 
8266
- def initialize(flowid=nil, operator=nil)
8468
+ def initialize(flowid=nil, operator=nil, agent=nil)
8267
8469
  @FlowId = flowid
8268
8470
  @Operator = operator
8471
+ @Agent = agent
8269
8472
  end
8270
8473
 
8271
8474
  def deserialize(params)
@@ -8274,16 +8477,31 @@ module TencentCloud
8274
8477
  @Operator = UserInfo.new
8275
8478
  @Operator.deserialize(params['Operator'])
8276
8479
  end
8480
+ unless params['Agent'].nil?
8481
+ @Agent = Agent.new
8482
+ @Agent.deserialize(params['Agent'])
8483
+ end
8277
8484
  end
8278
8485
  end
8279
8486
 
8280
8487
  # VerifyPdf返回参数结构体
8281
8488
  class VerifyPdfResponse < TencentCloud::Common::AbstractModel
8282
- # @param VerifyResult: 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
8489
+ # @param VerifyResult: 验签结果代码,代码的含义如下:
8490
+
8491
+ # <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
8492
+ # <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
8493
+ # <li>**3**:文件被篡改。</li>
8494
+ # <li>**4**:异常:文件内没有签名域。</li>
8495
+ # <li>**5**:异常:文件签名格式错误。</li></ul>
8283
8496
  # @type VerifyResult: Integer
8284
- # @param PdfVerifyResults: 验签结果详情,每个签名域对应的验签结果。状态值:1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
8497
+ # @param PdfVerifyResults: 验签结果详情,每个签名域对应的验签结果。状态值如下
8498
+ # <ul><li> **1** :验签成功,在电子签签署</li>
8499
+ # <li> **2** :验签成功,在其他平台签署</li>
8500
+ # <li> **3** :验签失败</li>
8501
+ # <li> **4** :pdf文件没有签名域</li>
8502
+ # <li> **5** :文件签名格式错误</li></ul>
8285
8503
  # @type PdfVerifyResults: Array
8286
- # @param VerifySerialNo: 验签序列号
8504
+ # @param VerifySerialNo: 验签序列号, 为11为数组组成的字符串
8287
8505
  # @type VerifySerialNo: String
8288
8506
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8289
8507
  # @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.661
4
+ version: 3.0.663
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-18 00:00:00.000000000 Z
11
+ date: 2023-09-20 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common