tencentcloud-sdk-essbasic 3.0.712 → 3.0.714

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ae70bd33426321f6e24effed079f80b365dff4fa
4
- data.tar.gz: 3fd4430ff98a5d67c1b85372cefee291d384e0a4
3
+ metadata.gz: 41e849ea8df6057f3ffa5bcfdfbe28179a79dd6d
4
+ data.tar.gz: aabc1bf6114b3add5520e90fc769f34f53b65f32
5
5
  SHA512:
6
- metadata.gz: 6ad279f74ecf3435ded93c47dfea04f8bf115b10c94325e286ce7062cc4aef33ff9c9fb1c458237b118572ca22ac1c1f0e79ab68e87bee4a1667832eb433e200
7
- data.tar.gz: 60385f51bc75f5457abc6f1a024b0e20f0b48b86a0a420cbaa4d71a41fa81f27bd8e424be100f14481898d47885801adee41096c69f2198dad0dfdcb55943d84
6
+ metadata.gz: a95e42e40934b9086ad78fb1ac336b7d4ff42298afb7999e78ad8b8ed60131d3b8bbc42466ab45911ce33896eb7ca6a1ff25e415a9d2637b599bc5bdd5b99ef6
7
+ data.tar.gz: b6c8978a16dca70d227a9d2eb3baed81be515d4b6b1df191b5868896fc8622f836819ee8e17d17120e60405e694295729b008f8325e0f6f907ab18e14c9a15ff
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.712
1
+ 3.0.714
@@ -313,8 +313,13 @@ module TencentCloud
313
313
  end
314
314
 
315
315
  # 本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
316
- # 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
317
- # 进入web连接后与当前控制台操作保持一致
316
+
317
+ # 本接口下面功能的签署页面链接的生成
318
+ # - 创建印章
319
+ # - 创建模板
320
+ # - 修改模板
321
+ # - 预览模板
322
+ # - 预览合同流程
318
323
 
319
324
  # @param request: Request instance for ChannelCreateEmbedWebUrl.
320
325
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateEmbedWebUrlRequest`
@@ -800,11 +805,14 @@ module TencentCloud
800
805
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
801
806
  end
802
807
 
803
- # 创建预发起合同
804
- # 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
805
- # 可指定合同信息不可更改,签署人信息不可更改
806
- # 合同发起后,填写及签署流程与现有操作流程一致
807
- # 注意:目前仅支持模板发起
808
+ # 通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
809
+
810
+ # 注意:
811
+ # 1. **仅支持模板**发起
812
+ # 2. 只支持PC浏览器操作使用
813
+
814
+ # 嵌入的页面样式如下:
815
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
808
816
 
809
817
  # @param request: Request instance for ChannelCreatePrepareFlow.
810
818
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreatePrepareFlowRequest`
@@ -994,7 +1002,8 @@ module TencentCloud
994
1002
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
995
1003
  end
996
1004
 
997
- # 通过此接口,绑定员工角色,支持以电子签userId、客户系统userId两种方式调用。
1005
+ # 使用此接口,用来绑定企业实名员工的角色,
1006
+ # 支持以电子签userId、客户系统openId两种方式进行绑定。
998
1007
 
999
1008
  # @param request: Request instance for ChannelCreateUserRoles.
1000
1009
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserRolesRequest`
@@ -1496,6 +1505,11 @@ module TencentCloud
1496
1505
  # <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
1497
1506
  # </ul>
1498
1507
 
1508
+
1509
+ # 注意:
1510
+ # 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
1511
+ # 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
1512
+
1499
1513
  # @param request: Request instance for CreateChannelOrganizationInfoChangeUrl.
1500
1514
  # @type request: :class:`Tencentcloud::essbasic::V20210526::CreateChannelOrganizationInfoChangeUrlRequest`
1501
1515
  # @rtype: :class:`Tencentcloud::essbasic::V20210526::CreateChannelOrganizationInfoChangeUrlResponse`
@@ -287,35 +287,42 @@ module TencentCloud
287
287
 
288
288
  # 基础流程信息
289
289
  class BaseFlowInfo < TencentCloud::Common::AbstractModel
290
- # @param FlowName: 合同流程名称
290
+ # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
291
291
  # @type FlowName: String
292
- # @param FlowType: 合同流程类型
293
- # <br/>客户自定义,用于合同分类展示
292
+ # @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
294
293
  # @type FlowType: String
295
- # @param FlowDescription: 合同流程描述信息
294
+ # @param FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
296
295
  # @type FlowDescription: String
297
- # @param Deadline: 合同流程截止时间,unix时间戳,单位秒
296
+ # @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
298
297
  # @type Deadline: Integer
299
- # @param Unordered: 是否顺序签署(true:无序签,false:顺序签)
300
- # <br/>默认false,有序签署合同
298
+ # @param Unordered: 合同流程的签署顺序类型:
299
+ # **false**:(默认)有序签署, 本合同多个参与人需要依次签署
300
+ # **true**:无序签署, 本合同多个参与人没有先后签署限制
301
301
  # @type Unordered: Boolean
302
302
  # @param IntelligentStatus: 是否打开智能添加填写区(默认开启,打开:"OPEN" 关闭:"CLOSE")
303
303
  # @type IntelligentStatus: String
304
- # @param FormFields: 填写控件内容
304
+ # @param FormFields: 填写控件内容, 填写的控制的ID-填写的内容对列表
305
305
  # @type FormFields: Array
306
- # @param NeedSignReview: 本企业(发起方企业)是否需要签署审批
307
- # <br/>true:开启发起方签署审批
308
- # <br/>false:不开启发起方签署审批
309
- # <br/>开启后,使用ChannelCreateFlowSignReview接口提交审批结果,才能继续完成签署
306
+ # @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
307
+ # <ul><li> **false**:(默认)不需要审批,直接签署。</li>
308
+ # <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
309
+ # 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
310
+ # <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
311
+ # <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
312
+ # 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
310
313
  # @type NeedSignReview: Boolean
311
- # @param UserData: 用户流程自定义数据参数
314
+ # @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为1000长度。
315
+
316
+ # 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的回调通知模块。
312
317
  # @type UserData: String
313
- # @param CcInfos: 抄送人信息
318
+ # @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
319
+
320
+ # 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
314
321
  # @type CcInfos: Array
315
- # @param NeedCreateReview: 是否需要开启发起方发起前审核
316
- # <br/>true:开启发起方发起前审核
317
- # <br/>false:不开启发起方发起前审核
318
- # <br/>当指定NeedCreateReview=true,则提交审核后,需要使用接口:ChannelCreateFlowSignReview,来完成发起前审核,审核通过后,可以继续查看,签署合同
322
+ # @param NeedCreateReview: 发起方企业的签署人进行发起操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
323
+
324
+ # 若设置为true,发起审核结果需通过接口 [提交企业签署流程审批结果](https://qian.tencent.com/developers/partnerApis/operateFlows/ChannelCreateFlowSignReview)通知电子签,审核通过后,发起方企业签署人方可进行发起操作,否则会阻塞其发起操作。
325
+
319
326
  # @type NeedCreateReview: Boolean
320
327
  # @param Components: 填写控件:文件发起使用
321
328
  # @type Components: Array
@@ -1285,25 +1292,37 @@ module TencentCloud
1285
1292
 
1286
1293
  # ChannelCreateEmbedWebUrl请求参数结构体
1287
1294
  class ChannelCreateEmbedWebUrlRequest < TencentCloud::Common::AbstractModel
1288
- # @param Agent: 渠道应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1295
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1296
+
1297
+ # 此接口下面信息必填。
1298
+ # <ul>
1299
+ # <li>渠道应用标识: Agent.AppId</li>
1300
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1301
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1302
+ # </ul>
1303
+ # 第三方平台子客企业和员工必须已经经过实名认证
1289
1304
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1290
1305
  # @param EmbedType: 要生成WEB嵌入界面的类型, 可以选择的值如下:
1291
1306
 
1292
- # - CREATE_SEAL: 生成创建印章的嵌入页面
1293
- # - CREATE_TEMPLATE:生成创建模板的嵌入页面
1294
- # - MODIFY_TEMPLATE:生成修改模板的嵌入页面
1295
- # - PREVIEW_TEMPLATE:生成预览模板的嵌入页面
1296
- # - PREVIEW_FLOW:生成预览合同文档的嵌入页面
1297
- # - PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面
1298
- # - PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面
1299
- # - PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面
1300
- # - EXTEND_SERVICE:生成扩展服务的嵌入页面
1307
+ # <ul>
1308
+ # <li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
1309
+ # <li>CREATE_TEMPLATE:生成创建模板的嵌入页面</li>
1310
+ # <li>MODIFY_TEMPLATE:生成修改模板的嵌入页面</li>
1311
+ # <li>PREVIEW_TEMPLATE:生成预览模板的嵌入页面</li>
1312
+ # <li>PREVIEW_FLOW:生成预览合同文档的嵌入页面</li>
1313
+ # <li>PREVIEW_FLOW_DETAIL:生成预览合同详情的嵌入页面</li>
1314
+ # <li>PREVIEW_SEAL_LIST:生成预览印章列表的嵌入页面</li>
1315
+ # <li>PREVIEW_SEAL_DETAIL:生成预览印章详情的嵌入页面</li>
1316
+ # <li>EXTEND_SERVICE:生成扩展服务的嵌入页面</li>
1317
+ # </ul>
1301
1318
  # @type EmbedType: String
1302
1319
  # @param BusinessId: WEB嵌入的业务资源ID
1303
1320
 
1304
- # - 当EmbedType取值MODIFY_TEMPLATE,PREVIEW_TEMPLATE时需要填写模板id作为BusinessId
1305
- # - 当EmbedType取值PREVIEW_FLOWPREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId
1306
- # - 当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId
1321
+ # <ul>
1322
+ # <li>当EmbedType取值MODIFY_TEMPLATEPREVIEW_TEMPLATE时需要填写模板id作为BusinessId</li>
1323
+ # <li>当EmbedType取值PREVIEW_FLOW,PREVIEW_FLOW_DETAIL时需要填写合同id作为BusinessId</li>
1324
+ # <li>当EmbedType取值PREVIEW_SEAL_DETAIL需要填写印章id作为BusinessId</li>
1325
+ # </ul>
1307
1326
  # @type BusinessId: String
1308
1327
  # @param HiddenComponents: 是否隐藏控件,只有预览模板时生效
1309
1328
  # @type HiddenComponents: Boolean
@@ -1340,7 +1359,7 @@ module TencentCloud
1340
1359
 
1341
1360
  # ChannelCreateEmbedWebUrl返回参数结构体
1342
1361
  class ChannelCreateEmbedWebUrlResponse < TencentCloud::Common::AbstractModel
1343
- # @param WebUrl: 嵌入的web链接
1362
+ # @param WebUrl: 嵌入的web链接,5分钟有效
1344
1363
  # @type WebUrl: String
1345
1364
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1346
1365
  # @type RequestId: String
@@ -2293,19 +2312,27 @@ module TencentCloud
2293
2312
 
2294
2313
  # ChannelCreatePrepareFlow请求参数结构体
2295
2314
  class ChannelCreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
2296
- # @param ResourceId: 资源id,与ResourceType对应
2315
+ # @param ResourceId: 合同模板ID,为32位字符串。
2297
2316
  # @type ResourceId: String
2298
- # @param ResourceType: 资源类型,与ResourceId对应1:模板 2: 文件
2317
+ # @param ResourceType: 资源类型,此接口固定为**1**表示为用模板发起
2299
2318
  # @type ResourceType: Integer
2300
- # @param FlowInfo: 合同流程基础信息
2319
+ # @param FlowInfo: 要创建的合同信息
2301
2320
  # @type FlowInfo: :class:`Tencentcloud::Essbasic.v20210526.models.BaseFlowInfo`
2302
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
2321
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2322
+
2323
+ # 此接口下面信息必填。
2324
+ # <ul>
2325
+ # <li>渠道应用标识: Agent.AppId</li>
2326
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2327
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2328
+ # </ul>
2329
+ # 第三方平台子客企业和员工必须已经经过实名认证
2303
2330
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2304
- # @param FlowOption: 合同流程配置信息,用于配置发起合同时定制化
2331
+ # @param FlowOption: 合同流程配置信息,用于配置发起合同时定制化如是否允许修改,某些按钮的隐藏等逻辑
2305
2332
  # @type FlowOption: :class:`Tencentcloud::Essbasic.v20210526.models.CreateFlowOption`
2306
2333
  # @param FlowApproverList: 合同签署人信息
2307
2334
  # @type FlowApproverList: Array
2308
- # @param FlowId: 通过flowid快速获得之前成功通过页面发起的合同生成链接
2335
+ # @param FlowId: 用过去已经通过此接口发起的合同的ID复制个新的合同创建链接
2309
2336
  # @type FlowId: String
2310
2337
  # @param NeedPreview: 该参数不可用,请通过获取 web 可嵌入接口获取合同流程预览 URL
2311
2338
  # @type NeedPreview: Boolean
@@ -2374,9 +2401,9 @@ module TencentCloud
2374
2401
 
2375
2402
  # ChannelCreatePrepareFlow返回参数结构体
2376
2403
  class ChannelCreatePrepareFlowResponse < TencentCloud::Common::AbstractModel
2377
- # @param PrepareFlowUrl: 预发起的合同链接, 可以直接点击进入进行合同发起
2404
+ # @param PrepareFlowUrl: 发起的合同嵌入链接, 可以直接点击进入进行合同发起, 有效期为5分钟
2378
2405
  # @type PrepareFlowUrl: String
2379
- # @param PreviewFlowUrl: 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果
2406
+ # @param PreviewFlowUrl: 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果, 有效期为5分钟
2380
2407
  # @type PreviewFlowUrl: String
2381
2408
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2382
2409
  # @type RequestId: String
@@ -4177,24 +4204,48 @@ module TencentCloud
4177
4204
 
4178
4205
  # 通用签署人信息
4179
4206
  class CommonFlowApprover < TencentCloud::Common::AbstractModel
4180
- # @param NotChannelOrganization: 指定当前签署人为第三方应用集成子客,默认false:当前签署人为第三方应用集成子客,true:当前签署人为saas企业用户
4207
+ # @param NotChannelOrganization: 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
4208
+ # <ul>
4209
+ # <li>false: 默认值,第三方平台子客企业下员工</li>
4210
+ # <li>true: SaaS平台企业下的员工</li>
4211
+ # </ul>
4181
4212
  # @type NotChannelOrganization: Boolean
4182
- # @param ApproverType: 签署人类型,目前支持:0-企业签署人,1-个人签署人,3-企业静默签署人
4213
+ # @param ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
4214
+
4215
+ # **0** :企业/企业员工(企业签署方或模板发起时的企业静默签)
4216
+ # **1** :个人/自然人
4217
+ # **3** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)
4218
+
4219
+ # 注:类型为3(企业/企业员工自动签)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
4183
4220
  # @type ApproverType: Integer
4184
- # @param OrganizationId: 企业id
4221
+ # @param OrganizationId: 电子签平台给企业生成的企业id
4185
4222
  # @type OrganizationId: String
4186
4223
  # @param OrganizationOpenId: 企业OpenId,第三方应用集成非静默签子客企业签署人发起合同必传
4187
4224
  # @type OrganizationOpenId: String
4188
4225
  # @param OrganizationName: 企业名称,第三方应用集成非静默签子客企业签署人必传,saas企业签署人必传
4189
4226
  # @type OrganizationName: String
4190
- # @param UserId: 用户id
4227
+ # @param UserId: 电子签平台给企业员工或者自热人生成的用户id
4191
4228
  # @type UserId: String
4192
- # @param OpenId: 用户openId,第三方应用集成非静默签子客企业签署人必传
4229
+ # @param OpenId: 第三方平台子客企业员工的唯一标识
4193
4230
  # @type OpenId: String
4194
- # @param ApproverName: 签署人名称,saas企业签署人,个人签署人必传
4231
+ # @param ApproverName: 签署方经办人的姓名。
4232
+ # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
4195
4233
  # @type ApproverName: String
4196
4234
  # @param ApproverMobile: 签署人手机号,saas企业签署人,个人签署人必传
4197
4235
  # @type ApproverMobile: String
4236
+ # @param ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
4237
+ # <ul><li>ID_CARD : 居民身份证 (默认值)</li>
4238
+ # <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4239
+ # <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
4240
+ # <li>OTHER_CARD_TYPE : 其他证件</li></ul>
4241
+
4242
+ # 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
4243
+ # @type ApproverIdCardType: String
4244
+ # @param ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
4245
+ # <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
4246
+ # <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
4247
+ # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
4248
+ # @type ApproverIdCardNumber: String
4198
4249
  # @param RecipientId: 签署人Id,使用模板发起是,对应模板配置中的签署人RecipientId
4199
4250
  # 注意:模板发起时该字段必填
4200
4251
  # @type RecipientId: String
@@ -4202,20 +4253,39 @@ module TencentCloud
4202
4253
  # @type PreReadTime: Integer
4203
4254
  # @param IsFullText: 签署前置条件:阅读全文限制
4204
4255
  # @type IsFullText: Boolean
4205
- # @param NotifyType: 通知类型:SMS(短信) NONE(不做通知), 不传 默认SMS
4256
+ # @param NotifyType: 通知签署方经办人的方式, 有以下途径:
4257
+ # <ul><li> **SMS** :(默认)短信</li>
4258
+ # <li> **NONE** : 不通知</li></ul>
4259
+
4260
+ # 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
4206
4261
  # @type NotifyType: String
4207
4262
  # @param ApproverOption: 签署人配置
4208
4263
  # @type ApproverOption: :class:`Tencentcloud::Essbasic.v20210526.models.CommonApproverOption`
4209
- # @param SignComponents: 签署控件:文件发起使用
4264
+ # @param SignComponents: 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
4210
4265
  # @type SignComponents: Array
4211
- # @param ApproverVerifyTypes: 签署人查看合同时认证方式, 1-实名查看 2-短信验证码查看(企业签署方不支持该方式) 如果不传默认为1 查看合同的认证方式 Flow层级的优先于approver层级的 (当手写签名方式为OCR_ESIGN时,合同认证方式2无效,因为这种签名方式依赖实名认证)
4266
+ # @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
4267
+ # <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
4268
+ # <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
4269
+ # </li></ul>
4270
+ # 注:
4271
+ # <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
4272
+ # <li>此字段可传多个校验方式</li></ul>
4212
4273
  # @type ApproverVerifyTypes: Array
4213
- # @param ApproverSignTypes: 签署人签署合同时的认证方式 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
4274
+ # @param ApproverSignTypes: 签署人签署合同时的认证方式
4275
+ # <ul><li> **1** :人脸认证</li>
4276
+ # <li> **2** :签署密码</li>
4277
+ # <li> **3** :运营商三要素</li></ul>
4278
+
4279
+ # 默认为1(人脸认证 ),2(签署密码)
4280
+
4281
+ # 注:
4282
+ # 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
4283
+ # 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
4214
4284
  # @type ApproverSignTypes: Array
4215
4285
 
4216
- attr_accessor :NotChannelOrganization, :ApproverType, :OrganizationId, :OrganizationOpenId, :OrganizationName, :UserId, :OpenId, :ApproverName, :ApproverMobile, :RecipientId, :PreReadTime, :IsFullText, :NotifyType, :ApproverOption, :SignComponents, :ApproverVerifyTypes, :ApproverSignTypes
4286
+ attr_accessor :NotChannelOrganization, :ApproverType, :OrganizationId, :OrganizationOpenId, :OrganizationName, :UserId, :OpenId, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :PreReadTime, :IsFullText, :NotifyType, :ApproverOption, :SignComponents, :ApproverVerifyTypes, :ApproverSignTypes
4217
4287
 
4218
- def initialize(notchannelorganization=nil, approvertype=nil, organizationid=nil, organizationopenid=nil, organizationname=nil, userid=nil, openid=nil, approvername=nil, approvermobile=nil, recipientid=nil, prereadtime=nil, isfulltext=nil, notifytype=nil, approveroption=nil, signcomponents=nil, approververifytypes=nil, approversigntypes=nil)
4288
+ def initialize(notchannelorganization=nil, approvertype=nil, organizationid=nil, organizationopenid=nil, organizationname=nil, userid=nil, openid=nil, approvername=nil, approvermobile=nil, approveridcardtype=nil, approveridcardnumber=nil, recipientid=nil, prereadtime=nil, isfulltext=nil, notifytype=nil, approveroption=nil, signcomponents=nil, approververifytypes=nil, approversigntypes=nil)
4219
4289
  @NotChannelOrganization = notchannelorganization
4220
4290
  @ApproverType = approvertype
4221
4291
  @OrganizationId = organizationid
@@ -4225,6 +4295,8 @@ module TencentCloud
4225
4295
  @OpenId = openid
4226
4296
  @ApproverName = approvername
4227
4297
  @ApproverMobile = approvermobile
4298
+ @ApproverIdCardType = approveridcardtype
4299
+ @ApproverIdCardNumber = approveridcardnumber
4228
4300
  @RecipientId = recipientid
4229
4301
  @PreReadTime = prereadtime
4230
4302
  @IsFullText = isfulltext
@@ -4245,6 +4317,8 @@ module TencentCloud
4245
4317
  @OpenId = params['OpenId']
4246
4318
  @ApproverName = params['ApproverName']
4247
4319
  @ApproverMobile = params['ApproverMobile']
4320
+ @ApproverIdCardType = params['ApproverIdCardType']
4321
+ @ApproverIdCardNumber = params['ApproverIdCardNumber']
4248
4322
  @RecipientId = params['RecipientId']
4249
4323
  @PreReadTime = params['PreReadTime']
4250
4324
  @IsFullText = params['IsFullText']
@@ -4675,9 +4749,9 @@ module TencentCloud
4675
4749
 
4676
4750
  # 此接口下面信息必填。
4677
4751
  # <ul>
4678
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4752
+ # <li>渠道应用标识: Agent.AppId</li>
4679
4753
  # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4680
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4754
+ # <li>第三方平台子客企业中的员工标识: Agent.ProxyOrganizationOpenId</li>
4681
4755
  # </ul>
4682
4756
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
4683
4757
  # @param ChangeType: 企业信息变更类型,可选类型如下:
@@ -4876,28 +4950,44 @@ module TencentCloud
4876
4950
 
4877
4951
  # 创建合同个性化参数
4878
4952
  class CreateFlowOption < TencentCloud::Common::AbstractModel
4879
- # @param CanEditFlow: 是否允许修改合同信息,true-是,false-否
4953
+ # @param CanEditFlow: 是否允许修改合同信息,
4954
+ # **true**:可以
4955
+ # **false**:(默认)不可以
4880
4956
  # @type CanEditFlow: Boolean
4881
- # @param HideShowFlowName: 是否允许发起合同弹窗隐藏合同名称,true-允许,false-不允许
4957
+ # @param HideShowFlowName: 是否允许发起合同弹窗隐藏合同名称
4958
+ # **true**:允许
4959
+ # **false**:(默认)不允许
4882
4960
  # @type HideShowFlowName: Boolean
4883
- # @param HideShowFlowType: 是否允许发起合同弹窗隐藏合同类型,true-允许,false-不允许
4961
+ # @param HideShowFlowType: 是否允许发起合同弹窗隐藏合同类型,
4962
+ # **true**:允许
4963
+ # **false**:(默认)不允许
4884
4964
  # @type HideShowFlowType: Boolean
4885
- # @param HideShowDeadline: 是否允许发起合同弹窗隐藏合同到期时间,true-允许,false-不允许
4965
+ # @param HideShowDeadline: 是否允许发起合同弹窗隐藏合同到期时间
4966
+ # **true**:允许
4967
+ # **false**:(默认)不允许
4886
4968
  # @type HideShowDeadline: Boolean
4887
- # @param CanSkipAddApprover: 是否允许发起合同步骤跳过指定签署方步骤,true-允许,false-不允许
4969
+ # @param CanSkipAddApprover: 是否允许发起合同步骤跳过指定签署方步骤
4970
+ # **true**:允许
4971
+ # **false**:(默认)不允许
4888
4972
  # @type CanSkipAddApprover: Boolean
4889
- # @param CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,描述信息最长500
4973
+ # @param CustomCreateFlowDescription: 定制化发起合同弹窗的描述信息,长度不能超过500,只能由中文、字母、数字和标点组成。
4890
4974
  # @type CustomCreateFlowDescription: String
4975
+ # @param ForbidEditFillComponent: 禁止编辑填写控件
4976
+
4977
+ # **true**:禁止编辑填写控件
4978
+ # **false**:(默认)允许编辑填写控件
4979
+ # @type ForbidEditFillComponent: Boolean
4891
4980
 
4892
- attr_accessor :CanEditFlow, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :CustomCreateFlowDescription
4981
+ attr_accessor :CanEditFlow, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :CustomCreateFlowDescription, :ForbidEditFillComponent
4893
4982
 
4894
- def initialize(caneditflow=nil, hideshowflowname=nil, hideshowflowtype=nil, hideshowdeadline=nil, canskipaddapprover=nil, customcreateflowdescription=nil)
4983
+ def initialize(caneditflow=nil, hideshowflowname=nil, hideshowflowtype=nil, hideshowdeadline=nil, canskipaddapprover=nil, customcreateflowdescription=nil, forbideditfillcomponent=nil)
4895
4984
  @CanEditFlow = caneditflow
4896
4985
  @HideShowFlowName = hideshowflowname
4897
4986
  @HideShowFlowType = hideshowflowtype
4898
4987
  @HideShowDeadline = hideshowdeadline
4899
4988
  @CanSkipAddApprover = canskipaddapprover
4900
4989
  @CustomCreateFlowDescription = customcreateflowdescription
4990
+ @ForbidEditFillComponent = forbideditfillcomponent
4901
4991
  end
4902
4992
 
4903
4993
  def deserialize(params)
@@ -4907,6 +4997,7 @@ module TencentCloud
4907
4997
  @HideShowDeadline = params['HideShowDeadline']
4908
4998
  @CanSkipAddApprover = params['CanSkipAddApprover']
4909
4999
  @CustomCreateFlowDescription = params['CustomCreateFlowDescription']
5000
+ @ForbidEditFillComponent = params['ForbidEditFillComponent']
4910
5001
  end
4911
5002
  end
4912
5003
 
@@ -6395,7 +6486,7 @@ module TencentCloud
6395
6486
  # 默认为1(人脸认证 ),2(签署密码)
6396
6487
 
6397
6488
  # 注:
6398
- # 1. 用<font color='red'>模版创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
6489
+ # 1. 用<font color='red'>模板创建合同场景</font>, 签署人的认证方式需要在配置模板的时候指定, <font color='red'>在创建合同重新指定无效</font>
6399
6490
  # 2. 运营商三要素认证方式对手机号运营商及前缀有限制,可以参考[运营商支持列表类](https://qian.tencent.com/developers/partner/mobile_support)得到具体的支持说明
6400
6491
  # @type ApproverSignTypes: Array
6401
6492
  # @param SignId: 签署ID
@@ -6901,8 +6992,6 @@ module TencentCloud
6901
6992
 
6902
6993
  # @type CustomShowMap: String
6903
6994
  # @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
6904
-
6905
- # 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
6906
6995
  # @type CcInfos: Array
6907
6996
  # @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
6908
6997
  # <ul><li> **false**:(默认)不需要审批,直接签署。</li>
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.712
4
+ version: 3.0.714
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-11-24 00:00:00.000000000 Z
11
+ date: 2023-11-27 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common