tencentcloud-sdk-essbasic 3.0.679 → 3.0.680

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: 038320bb7522ec5e0b68092a8e55cca800347ca8
4
- data.tar.gz: 3b60421bde56f92c0b2215e316b90fa06e2a68d0
3
+ metadata.gz: 6bbdfeec2f5d1dc72b0192b2f0ecc3cc9fcc5996
4
+ data.tar.gz: 8fd260b485b275a73616f631601c5f3126684de3
5
5
  SHA512:
6
- metadata.gz: 5c6d5eec0e0ac88104a95fb25e5b2fd280eac88bcd0d0cd4e78f241f3ed2101f1f87c953334da8687b62cfaf9285c10202c61d6a4d2057b0408399648e136dc5
7
- data.tar.gz: 586f6cfc5c0fdcb9457ada941688f042c2dff53e15abe79c8e8efd534b0450f15e6d6f92a1852c00e8d1bd89290603389b36c42135708c05eccac2081fff4868
6
+ metadata.gz: 69524c740f2a24a54811b6bec221e29fdc04a262006bdbc47ed842abe82cf0ce0f2f199926dbbd2998b59b10a490f71b8f0013fef38f904ed774bf36e32e43cc
7
+ data.tar.gz: c553b902eb96c4fc6adfbde02e9ae634c7b1d07d00a450dd879b79ae87171a1ee9638fabcaa7110383a5de972aec6a51978bb808002ca13fd5e9a0d1cf76ec79
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.679
1
+ 3.0.680
@@ -305,7 +305,62 @@ module TencentCloud
305
305
 
306
306
  # 接口(ChannelCreateFlowByFiles)用PDF文件创建签署流程。
307
307
 
308
- # 注: `此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。`
308
+ # 适用场景:适用非制式的合同文件签署,开发者有每个签署流程的PDF,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
309
+
310
+ # **注**:
311
+ # <ul>
312
+ # <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
313
+ # <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
314
+ # </ul>
315
+
316
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/ChannelCreateFlowByFiles.png)
317
+
318
+ # **可以作为发起方和签署方的角色列表**
319
+ # <table>
320
+ # <thead>
321
+ # <tr>
322
+ # <th>场景编号</th>
323
+ # <th>可作为发起方类型</th>
324
+ # <th>可作为签署方的类型</th>
325
+ # </tr>
326
+ # </thead>
327
+
328
+ # <tbody>
329
+ # <tr>
330
+ # <td>场景一</td>
331
+ # <td>第三方子企业A员工</td>
332
+ # <td>第三方子企业A员工</td>
333
+ # </tr>
334
+
335
+ # <tr>
336
+ # <td>场景二</td>
337
+ # <td>第三方子企业A员工</td>
338
+ # <td>第三方子企业B(不指定经办人)</td>
339
+ # </tr>
340
+
341
+ # <tr>
342
+ # <td>场景三</td>
343
+ # <td>第三方子企业A员工</td>
344
+ # <td>第三方子企业B员工</td>
345
+ # </tr>
346
+
347
+ # <tr>
348
+ # <td>场景四</td>
349
+ # <td>第三方子企业A员工</td>
350
+ # <td>个人/自然人</td>
351
+ # </tr>
352
+
353
+ # <tr>
354
+ # <td>场景五</td>
355
+ # <td>第三方子企业A员工</td>
356
+ # <td>SaaS平台企业员工</td>
357
+ # </tr>
358
+ # </tbody>
359
+ # </table>
360
+
361
+ # **注**:
362
+ # `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
363
+ # `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
309
364
 
310
365
  # @param request: Request instance for ChannelCreateFlowByFiles.
311
366
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowByFilesRequest`
@@ -1104,8 +1159,15 @@ module TencentCloud
1104
1159
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1105
1160
  end
1106
1161
 
1107
- # 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
1108
- # 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。
1162
+ # 提交申请出证报告任务并返回报告ID
1163
+
1164
+ # 注意:
1165
+ # <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
1166
+ # <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
1167
+ # <li>合同流程必须所有参与方`已经签署完成`。</li>
1168
+ # <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
1169
+
1170
+ # <svg id="SvgjsSvg1006" width="262" height="229" 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="SvgjsDefs1007"><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="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
1109
1171
 
1110
1172
  # @param request: Request instance for CreateChannelFlowEvidenceReport.
1111
1173
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateChannelFlowEvidenceReportRequest`
@@ -1129,7 +1191,40 @@ module TencentCloud
1129
1191
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1130
1192
  end
1131
1193
 
1132
- # 此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。
1194
+ # 此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接(需要在移动端打开,会跳转到微信小程序),支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。
1195
+
1196
+
1197
+ # <h3 id="1-企业超管变更">1. 企业超管变更</h3>
1198
+
1199
+ # <p>换成企业的其他员工来当超管</p>
1200
+
1201
+ # <h3 id="2-企业基础信息变更">2. 企业基础信息变更</h3>
1202
+
1203
+ # <h4 id="可以变动">可以变动</h4>
1204
+
1205
+ # <ul>
1206
+ # <li>企业名称<br>
1207
+ # </li>
1208
+ # <li>法定代表人姓名(新法人有邀请链接)<br>
1209
+ # </li>
1210
+ # <li>企业地址和所在地</li>
1211
+ # </ul>
1212
+
1213
+ # <h4 id="不可变动">不可变动</h4>
1214
+
1215
+ # <ul>
1216
+ # <li>统一社会信用代码<br>
1217
+ # </li>
1218
+ # <li>企业主体类型</li>
1219
+ # </ul>
1220
+
1221
+ # <p>如果企业名称变动会引起下面的变动</p>
1222
+
1223
+ # <ul>
1224
+ # <li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>
1225
+ # <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
1226
+ # <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
1227
+ # </ul>
1133
1228
 
1134
1229
  # @param request: Request instance for CreateChannelOrganizationInfoChangeUrl.
1135
1230
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateChannelOrganizationInfoChangeUrlRequest`
@@ -1190,6 +1285,57 @@ module TencentCloud
1190
1285
  # 如若在模板中配置了动态表格, 上传的附件必须为A4大小
1191
1286
  # 合同发起人必须在电子签已经进行实名。
1192
1287
 
1288
+ # **整体的逻辑如下**
1289
+
1290
+ # ![image](https://dyn.ess.tencent.cn/guide/capi/CreateFlowsByTemplates.png)
1291
+
1292
+ # **可以作为发起方和签署方的角色列表**
1293
+ # <table>
1294
+ # <thead>
1295
+ # <tr>
1296
+ # <th>场景编号</th>
1297
+ # <th>可作为发起方类型</th>
1298
+ # <th>可作为签署方的类型</th>
1299
+ # </tr>
1300
+ # </thead>
1301
+
1302
+ # <tbody>
1303
+ # <tr>
1304
+ # <td>场景一</td>
1305
+ # <td>第三方子企业A员工</td>
1306
+ # <td>第三方子企业A员工</td>
1307
+ # </tr>
1308
+
1309
+ # <tr>
1310
+ # <td>场景二</td>
1311
+ # <td>第三方子企业A员工</td>
1312
+ # <td>第三方子企业B(不指定经办人)</td>
1313
+ # </tr>
1314
+
1315
+ # <tr>
1316
+ # <td>场景三</td>
1317
+ # <td>第三方子企业A员工</td>
1318
+ # <td>第三方子企业B员工</td>
1319
+ # </tr>
1320
+
1321
+ # <tr>
1322
+ # <td>场景四</td>
1323
+ # <td>第三方子企业A员工</td>
1324
+ # <td>个人/自然人</td>
1325
+ # </tr>
1326
+
1327
+ # <tr>
1328
+ # <td>场景五</td>
1329
+ # <td>第三方子企业A员工</td>
1330
+ # <td>SaaS平台企业员工</td>
1331
+ # </tr>
1332
+ # </tbody>
1333
+ # </table>
1334
+
1335
+ # **注**:
1336
+ # `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
1337
+ # `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
1338
+
1193
1339
  # @param request: Request instance for CreateFlowsByTemplates.
1194
1340
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateFlowsByTemplatesRequest`
1195
1341
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::CreateFlowsByTemplatesResponse`
@@ -1313,7 +1459,14 @@ module TencentCloud
1313
1459
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1314
1460
  end
1315
1461
 
1316
- # 查询企业扩展服务授权信息,企业经办人需要是企业超管或者法人
1462
+ # 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
1463
+ # 1. 企业自动签
1464
+ # 2. 企业与港澳台居民签署合同
1465
+ # 3. 使用手机号验证签署方身份
1466
+ # 4. 骑缝章
1467
+ # 5. 拓宽签署方年龄限制
1468
+
1469
+ # 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
1317
1470
 
1318
1471
  # @param request: Request instance for DescribeExtendedServiceAuthInfo.
1319
1472
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeExtendedServiceAuthInfoRequest`
@@ -87,10 +87,12 @@ module TencentCloud
87
87
  class ApproverItem < TencentCloud::Common::AbstractModel
88
88
  # @param SignId: 签署方唯一编号
89
89
 
90
- # 在动态签署人场景下,可以用此编号确定参与方
90
+ # 在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
91
91
  # 注意:此字段可能返回 null,表示取不到有效值。
92
92
  # @type SignId: String
93
93
  # @param RecipientId: 签署方角色编号
94
+
95
+ # 在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
94
96
  # 注意:此字段可能返回 null,表示取不到有效值。
95
97
  # @type RecipientId: String
96
98
  # @param ApproverRoleName: 签署方角色名称
@@ -986,8 +988,7 @@ module TencentCloud
986
988
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
987
989
  # @param FillApproverType: 签署人信息补充方式
988
990
 
989
- # <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
990
- # <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
991
+ # <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
991
992
  # @type FillApproverType: Integer
992
993
 
993
994
  attr_accessor :Agent, :FlowId, :Approvers, :Operator, :FillApproverType
@@ -1095,9 +1096,7 @@ module TencentCloud
1095
1096
  # @param Unordered: 合同流程的签署顺序类型:
1096
1097
  # <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
1097
1098
  # <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
1098
-
1099
- # 注
1100
- # `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
1099
+ # **注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
1101
1100
  # @type Unordered: Boolean
1102
1101
  # @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为255个字符,仅限中文、字母、数字和下划线组成。
1103
1102
  # @type FlowType: String
@@ -1136,9 +1135,7 @@ module TencentCloud
1136
1135
  # @param SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
1137
1136
  # <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
1138
1137
  # <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
1139
-
1140
- # 注:
1141
- # `发起后添加控件功能不支持添加签批控件`
1138
+ # **注**: `发起后添加控件功能不支持添加签批控件`
1142
1139
  # @type SignBeanTag: Integer
1143
1140
  # @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1144
1141
  # @type CcInfos: Array
@@ -1232,7 +1229,8 @@ module TencentCloud
1232
1229
 
1233
1230
  # ChannelCreateFlowByFiles返回参数结构体
1234
1231
  class ChannelCreateFlowByFilesResponse < TencentCloud::Common::AbstractModel
1235
- # @param FlowId: 合同签署流程ID
1232
+ # @param FlowId: 合同流程ID,为32位字符串。
1233
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1236
1234
  # 注意:此字段可能返回 null,表示取不到有效值。
1237
1235
  # @type FlowId: String
1238
1236
  # @param Approvers: 签署方信息,如角色ID、角色名称等
@@ -3902,9 +3900,17 @@ module TencentCloud
3902
3900
 
3903
3901
  # CreateChannelFlowEvidenceReport请求参数结构体
3904
3902
  class CreateChannelFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
3905
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
3903
+ # @param Agent: 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3904
+
3905
+ # 此接口下面信息必填。
3906
+ # <ul>
3907
+ # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
3908
+ # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
3909
+ # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3910
+ # </ul>
3906
3911
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3907
- # @param FlowId: 签署流程编号
3912
+ # @param FlowId: 合同流程ID,为32位字符串。
3913
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3908
3914
  # @type FlowId: String
3909
3915
  # @param Operator: 暂未开放
3910
3916
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -3935,15 +3941,14 @@ module TencentCloud
3935
3941
 
3936
3942
  # CreateChannelFlowEvidenceReport返回参数结构体
3937
3943
  class CreateChannelFlowEvidenceReportResponse < TencentCloud::Common::AbstractModel
3938
- # @param ReportId: 出证报告 ID,可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
3939
-
3944
+ # @param ReportId: 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
3940
3945
  # 注意:此字段可能返回 null,表示取不到有效值。
3941
3946
  # @type ReportId: String
3942
- # @param Status: 出征任务的执行状态,状态列表如下
3947
+ # @param Status: 出证任务执行的状态, 状态含义如下:
3943
3948
 
3944
- # - EvidenceStatusExecuting : 出征任务正在执行中
3945
- # - EvidenceStatusSuccess : 出征任务执行成功
3946
- # - EvidenceStatusFailed : 出征任务执行失败
3949
+ # <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
3950
+ # <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
3951
+ # <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
3947
3952
  # @type Status: String
3948
3953
  # @param ReportUrl: 废除,字段无效
3949
3954
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -3970,10 +3975,18 @@ module TencentCloud
3970
3975
 
3971
3976
  # CreateChannelOrganizationInfoChangeUrl请求参数结构体
3972
3977
  class CreateChannelOrganizationInfoChangeUrlRequest < TencentCloud::Common::AbstractModel
3973
- # @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3978
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3979
+
3980
+ # 此接口下面信息必填。
3981
+ # <ul>
3982
+ # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
3983
+ # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
3984
+ # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3985
+ # </ul>
3974
3986
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3975
3987
  # @param ChangeType: 企业信息变更类型,可选类型如下:
3976
- # <ul><li>**1**:企业超管变更</li><li>**2**:企业基础信息变更</li></ul>
3988
+ # <ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
3989
+ # <li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
3977
3990
  # @type ChangeType: Integer
3978
3991
 
3979
3992
  attr_accessor :Agent, :ChangeType
@@ -3994,7 +4007,7 @@ module TencentCloud
3994
4007
 
3995
4008
  # CreateChannelOrganizationInfoChangeUrl返回参数结构体
3996
4009
  class CreateChannelOrganizationInfoChangeUrlResponse < TencentCloud::Common::AbstractModel
3997
- # @param Url: 创建的企业信息变更链接。
4010
+ # @param Url: 创建的企业信息变更链接。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。
3998
4011
  # @type Url: String
3999
4012
  # @param ExpiredTime: 链接过期时间。链接7天有效。
4000
4013
  # @type ExpiredTime: Integer
@@ -4195,15 +4208,29 @@ module TencentCloud
4195
4208
 
4196
4209
  # CreateFlowsByTemplates请求参数结构体
4197
4210
  class CreateFlowsByTemplatesRequest < TencentCloud::Common::AbstractModel
4198
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
4211
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4212
+
4213
+ # 此接口下面信息必填。
4214
+ # <ul>
4215
+ # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4216
+ # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4217
+ # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4218
+ # </ul>
4199
4219
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4200
4220
  # @param FlowInfos: 要创建的合同信息列表,最多支持一次创建20个合同
4201
4221
  # @type FlowInfos: Array
4202
- # @param NeedPreview: 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
4203
- # 预览链接有效期300秒;
4204
- # 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
4222
+ # @param NeedPreview: 是否为预览模式,取值如下:
4223
+ # <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
4224
+ # <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
4225
+
4226
+ # 注:
4227
+
4228
+ # `如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
4205
4229
  # @type NeedPreview: Boolean
4206
- # @param PreviewType: 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
4230
+ # @param PreviewType: 预览模式下产生的预览链接类型
4231
+ # <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
4232
+ # <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
4233
+ # 注: `此参数在NeedPreview 为true时有效`
4207
4234
  # @type PreviewType: Integer
4208
4235
  # @param Operator: 操作者的信息,不用传
4209
4236
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -4245,14 +4272,17 @@ module TencentCloud
4245
4272
 
4246
4273
  # CreateFlowsByTemplates返回参数结构体
4247
4274
  class CreateFlowsByTemplatesResponse < TencentCloud::Common::AbstractModel
4248
- # @param FlowIds: 多个合同ID
4275
+ # @param FlowIds: 生成的合同流程ID数组,合同流程ID为32位字符串。
4276
+ # 建议开发者妥善保存此流程ID数组,以便于顺利进行后续操作。
4249
4277
  # @type FlowIds: Array
4250
4278
  # @param CustomerData: 第三方应用平台的业务信息, 与创建合同的FlowInfos数组中的CustomerData一一对应
4251
4279
  # @type CustomerData: Array
4252
4280
  # @param ErrorMessages: 创建消息,对应多个合同ID,
4253
4281
  # 成功为“”,创建失败则对应失败消息
4254
4282
  # @type ErrorMessages: Array
4255
- # @param PreviewUrls: 预览模式下返回的预览文件url数组
4283
+ # @param PreviewUrls: 合同预览链接URL数组。
4284
+
4285
+ # 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
4256
4286
  # @type PreviewUrls: Array
4257
4287
  # @param TaskInfos: 复杂文档合成任务(如,包含动态表格的预览任务)的任务信息数组;
4258
4288
  # 如果文档需要异步合成,此字段会返回该异步任务的任务信息,后续可以通过ChannelGetTaskResultApi接口查询任务详情;
@@ -4615,9 +4645,14 @@ module TencentCloud
4615
4645
 
4616
4646
  # DescribeExtendedServiceAuthInfo请求参数结构体
4617
4647
  class DescribeExtendedServiceAuthInfoRequest < TencentCloud::Common::AbstractModel
4618
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4648
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4619
4649
 
4620
- # 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
4650
+ # 此接口下面信息必填。
4651
+ # <ul>
4652
+ # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4653
+ # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4654
+ # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4655
+ # </ul>
4621
4656
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4622
4657
 
4623
4658
  attr_accessor :Agent
@@ -4636,7 +4671,7 @@ module TencentCloud
4636
4671
 
4637
4672
  # DescribeExtendedServiceAuthInfo返回参数结构体
4638
4673
  class DescribeExtendedServiceAuthInfoResponse < TencentCloud::Common::AbstractModel
4639
- # @param AuthInfo: 企业扩展服务授权信息
4674
+ # @param AuthInfo: 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
4640
4675
  # 注意:此字段可能返回 null,表示取不到有效值。
4641
4676
  # @type AuthInfo: Array
4642
4677
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -5031,11 +5066,11 @@ module TencentCloud
5031
5066
  end
5032
5067
  end
5033
5068
 
5034
- # 企业扩展服务授权信息
5069
+ # 扩展服务开通和授权的详细信息
5035
5070
  class ExtentServiceAuthInfo < TencentCloud::Common::AbstractModel
5036
5071
  # @param Type: 扩展服务类型
5037
5072
  # <ul>
5038
- # <li>AUTO_SIGN 企业静默签(自动签署)</li>
5073
+ # <li>AUTO_SIGN 企业自动签(自动签署)</li>
5039
5074
  # <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
5040
5075
  # <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
5041
5076
  # <li> PAGING_SEAL 骑缝章</li>
@@ -5045,14 +5080,12 @@ module TencentCloud
5045
5080
  # @type Type: String
5046
5081
  # @param Name: 扩展服务名称
5047
5082
  # @type Name: String
5048
- # @param Status: 服务状态
5049
- # ENABLE 开启
5050
- # DISABLE 关闭
5083
+ # @param Status: 扩展服务的开通状态: ENABLE:开通 DISABLE:未开通
5051
5084
  # @type Status: String
5052
- # @param OperatorOpenId: 最近操作人第三方应用平台的用户openid
5085
+ # @param OperatorOpenId: 操作扩展服务的操作人第三方应用平台的用户openid
5053
5086
  # 注意:此字段可能返回 null,表示取不到有效值。
5054
5087
  # @type OperatorOpenId: String
5055
- # @param OperateOn: 最近操作时间戳,单位秒
5088
+ # @param OperateOn: 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
5056
5089
  # 注意:此字段可能返回 null,表示取不到有效值。
5057
5090
  # @type OperateOn: Integer
5058
5091
 
@@ -5300,18 +5333,62 @@ module TencentCloud
5300
5333
 
5301
5334
  # 创建签署流程签署人入参。
5302
5335
 
5303
- # 其中签署方FlowApproverInfo需要传递的参数
5304
- # 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。
5305
-
5306
- # 其他身份标识,注:`如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`
5307
-
5308
- # <ul><li>1-个人:Name、Mobile必传</li>
5309
- # <li>2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;</li>
5310
- # <li>3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;</li>
5311
- # <li>4-非第三方平台子客企业(平台企业):Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
5312
-
5313
- # RecipientId参数:
5314
- # 从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
5336
+ # **各种场景传参说明**:
5337
+
5338
+ # <table>
5339
+ # <thead>
5340
+ # <tr>
5341
+ # <th>场景编号</th>
5342
+ # <th>可作为发起方类型</th>
5343
+ # <th>可作为签署方的类型</th>
5344
+ # <th>签署方传参说明</th>
5345
+ # </tr>
5346
+ # </thead>
5347
+
5348
+ # <tbody>
5349
+ # <tr>
5350
+ # <td>场景一</td>
5351
+ # <td>第三方子企业A员工</td>
5352
+ # <td>第三方子企业A员工</td>
5353
+ # <td>OpenId、OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
5354
+ # </tr>
5355
+
5356
+ # <tr>
5357
+ # <td>场景二</td>
5358
+ # <td>第三方子企业A员工</td>
5359
+ # <td>第三方子企业B(不指定经办人)</td>
5360
+ # <td>OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
5361
+ # </tr>
5362
+
5363
+ # <tr>
5364
+ # <td>场景三</td>
5365
+ # <td>第三方子企业A员工</td>
5366
+ # <td>第三方子企业B员工</td>
5367
+ # <td>OpenId、OrgName、OrgOpenId必传, ApproverType设置为ORGANIZATION</td>
5368
+ # </tr>
5369
+
5370
+ # <tr>
5371
+ # <td>场景四</td>
5372
+ # <td>第三方子企业A员工</td>
5373
+ # <td>个人/自然人</td>
5374
+ # <td>Name、Mobile必传, ApproverType设置为PERSON</td>
5375
+ # </tr>
5376
+
5377
+ # <tr>
5378
+ # <td>场景五</td>
5379
+ # <td>第三方子企业A员工</td>
5380
+ # <td>SaaS平台企业员工</td>
5381
+ # <td>Name、Mobile、OrgName必传,且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
5382
+ # </tr>
5383
+ # </tbody>
5384
+ # </table>
5385
+
5386
+ # **注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
5387
+
5388
+ # RecipientId参数获取:
5389
+ # 从<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates" target="_blank">DescribeFlowTemplates接口</a>接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
5390
+
5391
+ # **注2**: `如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`, 动态签署方可以参考<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">此文档</a>
5315
5392
  class FlowApproverInfo < TencentCloud::Common::AbstractModel
5316
5393
  # @param Name: 签署方经办人的姓名。
5317
5394
  # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.679
4
+ version: 3.0.680
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-10-18 00:00:00.000000000 Z
11
+ date: 2023-10-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common
@@ -33,11 +33,11 @@ executables: []
33
33
  extensions: []
34
34
  extra_rdoc_files: []
35
35
  files:
36
- - lib/v20210526/models.rb
37
- - lib/v20210526/client.rb
38
36
  - lib/tencentcloud-sdk-essbasic.rb
39
- - lib/v20201222/models.rb
37
+ - lib/v20210526/client.rb
38
+ - lib/v20210526/models.rb
40
39
  - lib/v20201222/client.rb
40
+ - lib/v20201222/models.rb
41
41
  - lib/VERSION
42
42
  homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby
43
43
  licenses: