tencentcloud-sdk-python 3.0.1061__py2.py3-none-any.whl → 3.0.1075__py2.py3-none-any.whl

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.

Potentially problematic release.


This version of tencentcloud-sdk-python might be problematic. Click here for more details.

Files changed (114) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/aiart/v20221229/models.py +5 -5
  3. tencentcloud/antiddos/v20200309/models.py +27 -1
  4. tencentcloud/asr/v20190614/errorcodes.py +3 -0
  5. tencentcloud/batch/v20170312/models.py +3 -3
  6. tencentcloud/billing/v20180709/billing_client.py +23 -0
  7. tencentcloud/billing/v20180709/errorcodes.py +6 -0
  8. tencentcloud/billing/v20180709/models.py +506 -0
  9. tencentcloud/car/v20220110/car_client.py +2 -2
  10. tencentcloud/cat/v20180409/models.py +2 -2
  11. tencentcloud/cbs/v20170312/models.py +4 -4
  12. tencentcloud/cdb/v20170320/cdb_client.py +2 -2
  13. tencentcloud/cdb/v20170320/models.py +2 -2
  14. tencentcloud/cdc/v20201214/cdc_client.py +2 -2
  15. tencentcloud/cdc/v20201214/errorcodes.py +1 -1
  16. tencentcloud/cdc/v20201214/models.py +134 -4
  17. tencentcloud/cdn/v20180606/models.py +1 -1
  18. tencentcloud/cdwch/v20200915/cdwch_client.py +23 -0
  19. tencentcloud/cdwch/v20200915/models.py +365 -0
  20. tencentcloud/cdwdoris/v20211228/models.py +5 -1
  21. tencentcloud/cfs/v20190719/models.py +12 -0
  22. tencentcloud/cfw/v20190904/cfw_client.py +0 -25
  23. tencentcloud/cfw/v20190904/models.py +123 -102
  24. tencentcloud/clb/v20180317/errorcodes.py +3 -0
  25. tencentcloud/cloudaudit/v20190319/cloudaudit_client.py +6 -6
  26. tencentcloud/cloudaudit/v20190319/errorcodes.py +6 -3
  27. tencentcloud/cloudaudit/v20190319/models.py +30 -2
  28. tencentcloud/common/credential.py +14 -4
  29. tencentcloud/cvm/v20170312/errorcodes.py +3 -0
  30. tencentcloud/cvm/v20170312/models.py +6 -6
  31. tencentcloud/cwp/v20180228/cwp_client.py +1 -1
  32. tencentcloud/cwp/v20180228/models.py +70 -32
  33. tencentcloud/cynosdb/v20190107/models.py +188 -0
  34. tencentcloud/dasb/v20191018/models.py +26 -0
  35. tencentcloud/dbbrain/v20191016/models.py +1 -1
  36. tencentcloud/dnspod/v20210323/dnspod_client.py +3 -0
  37. tencentcloud/dnspod/v20210323/models.py +12 -0
  38. tencentcloud/dts/v20211206/dts_client.py +511 -0
  39. tencentcloud/dts/v20211206/errorcodes.py +3 -0
  40. tencentcloud/dts/v20211206/models.py +6919 -2997
  41. tencentcloud/es/v20180416/errorcodes.py +4 -1
  42. tencentcloud/ess/v20201111/ess_client.py +132 -21
  43. tencentcloud/ess/v20201111/models.py +495 -67
  44. tencentcloud/essbasic/v20210526/essbasic_client.py +126 -39
  45. tencentcloud/essbasic/v20210526/models.py +501 -237
  46. tencentcloud/facefusion/v20181201/errorcodes.py +3 -0
  47. tencentcloud/faceid/v20180301/errorcodes.py +1 -1
  48. tencentcloud/faceid/v20180301/models.py +26 -2
  49. tencentcloud/hai/v20230812/errorcodes.py +18 -0
  50. tencentcloud/hai/v20230812/models.py +81 -3
  51. tencentcloud/hunyuan/v20230901/hunyuan_client.py +23 -0
  52. tencentcloud/hunyuan/v20230901/models.py +195 -1
  53. tencentcloud/iss/v20230517/errorcodes.py +3 -0
  54. tencentcloud/iss/v20230517/models.py +20 -8
  55. tencentcloud/ivld/v20210903/models.py +1 -1
  56. tencentcloud/mongodb/v20190725/errorcodes.py +1 -1
  57. tencentcloud/mongodb/v20190725/models.py +149 -0
  58. tencentcloud/monitor/v20180724/models.py +1118 -97
  59. tencentcloud/monitor/v20180724/monitor_client.py +118 -0
  60. tencentcloud/mps/v20190612/models.py +60 -1
  61. tencentcloud/mrs/v20200910/errorcodes.py +6 -0
  62. tencentcloud/mrs/v20200910/models.py +161 -1
  63. tencentcloud/mrs/v20200910/mrs_client.py +46 -0
  64. tencentcloud/oceanus/v20190422/errorcodes.py +3 -0
  65. tencentcloud/oceanus/v20190422/models.py +229 -0
  66. tencentcloud/oceanus/v20190422/oceanus_client.py +23 -0
  67. tencentcloud/ocr/v20181119/models.py +41 -1
  68. tencentcloud/omics/v20221128/models.py +92 -25
  69. tencentcloud/rum/v20210622/models.py +0 -504
  70. tencentcloud/rum/v20210622/rum_client.py +0 -138
  71. tencentcloud/scf/v20180416/errorcodes.py +3 -0
  72. tencentcloud/scf/v20180416/models.py +13 -1
  73. tencentcloud/ses/v20201002/errorcodes.py +3 -0
  74. tencentcloud/sqlserver/v20180328/models.py +5 -5
  75. tencentcloud/sqlserver/v20180328/sqlserver_client.py +6 -6
  76. tencentcloud/ssm/v20190923/models.py +2 -2
  77. tencentcloud/tat/v20201028/models.py +2 -0
  78. tencentcloud/tcb/v20180608/models.py +12 -3
  79. tencentcloud/tcm/v20210413/errorcodes.py +3 -0
  80. tencentcloud/tcss/v20201101/models.py +1735 -2
  81. tencentcloud/tcss/v20201101/tcss_client.py +92 -0
  82. tencentcloud/tdid/v20210519/errorcodes.py +143 -2
  83. tencentcloud/tdid/v20210519/models.py +1424 -788
  84. tencentcloud/tdid/v20210519/tdid_client.py +201 -112
  85. tencentcloud/tdmq/v20200217/errorcodes.py +3 -0
  86. tencentcloud/tdmq/v20200217/models.py +261 -0
  87. tencentcloud/tdmq/v20200217/tdmq_client.py +23 -0
  88. tencentcloud/teo/v20220901/errorcodes.py +13 -1
  89. tencentcloud/teo/v20220901/models.py +24 -22
  90. tencentcloud/tione/v20211111/errorcodes.py +12 -0
  91. tencentcloud/tione/v20211111/models.py +190 -32
  92. tencentcloud/tiw/v20190919/models.py +117 -10
  93. tencentcloud/tms/v20201229/models.py +562 -4
  94. tencentcloud/tms/v20201229/tms_client.py +23 -0
  95. tencentcloud/trp/v20210515/models.py +39 -1
  96. tencentcloud/trp/v20210515/trp_client.py +1 -1
  97. tencentcloud/trtc/v20190722/errorcodes.py +6 -0
  98. tencentcloud/trtc/v20190722/models.py +34 -5
  99. tencentcloud/trtc/v20190722/trtc_client.py +2 -0
  100. tencentcloud/tse/v20201207/models.py +512 -1
  101. tencentcloud/tse/v20201207/tse_client.py +115 -0
  102. tencentcloud/tsf/v20180326/models.py +216 -5
  103. tencentcloud/tsf/v20180326/tsf_client.py +1 -1
  104. tencentcloud/vod/v20180717/models.py +1018 -128
  105. tencentcloud/vod/v20180717/vod_client.py +165 -3
  106. tencentcloud/vpc/v20170312/errorcodes.py +3 -0
  107. tencentcloud/vpc/v20170312/models.py +24 -0
  108. tencentcloud/wedata/v20210820/models.py +1353 -0
  109. tencentcloud/wedata/v20210820/wedata_client.py +69 -0
  110. {tencentcloud_sdk_python-3.0.1061.dist-info → tencentcloud_sdk_python-3.0.1075.dist-info}/METADATA +1 -1
  111. {tencentcloud_sdk_python-3.0.1061.dist-info → tencentcloud_sdk_python-3.0.1075.dist-info}/RECORD +114 -114
  112. {tencentcloud_sdk_python-3.0.1061.dist-info → tencentcloud_sdk_python-3.0.1075.dist-info}/LICENSE +0 -0
  113. {tencentcloud_sdk_python-3.0.1061.dist-info → tencentcloud_sdk_python-3.0.1075.dist-info}/WHEEL +0 -0
  114. {tencentcloud_sdk_python-3.0.1061.dist-info → tencentcloud_sdk_python-3.0.1075.dist-info}/top_level.txt +0 -0
@@ -1642,7 +1642,7 @@ class ChannelCancelMultiFlowSignQRCodeRequest(AbstractModel):
1642
1642
  </ul>
1643
1643
  第三方平台子客企业和员工必须已经经过实名认证
1644
1644
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1645
- :param _QrCodeId: 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
1645
+ :param _QrCodeId: 需要取消的签署码ID,为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
1646
1646
  :type QrCodeId: str
1647
1647
  :param _Operator: 暂未开放
1648
1648
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -1837,9 +1837,9 @@ class ChannelCreateBatchCancelFlowUrlRequest(AbstractModel):
1837
1837
  <ul>
1838
1838
  <li>渠道应用标识: Agent.AppId</li>
1839
1839
  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1840
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1840
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
1841
1841
  </ul>
1842
- 第三方平台子客企业和员工必须已经经过实名认证
1842
+ 第三方平台子客企业和员工必须已经过实名认证
1843
1843
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1844
1844
  :param _FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
1845
1845
  :type FlowIds: list of str
@@ -1905,6 +1905,8 @@ class ChannelCreateBatchCancelFlowUrlResponse(AbstractModel):
1905
1905
  def __init__(self):
1906
1906
  r"""
1907
1907
  :param _BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
1908
+
1909
+ 注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1908
1910
  :type BatchCancelFlowUrl: str
1909
1911
  :param _FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
1910
1912
  :type FailMessages: list of str
@@ -2152,7 +2154,15 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
2152
2154
 
2153
2155
  def __init__(self):
2154
2156
  r"""
2155
- :param _Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2157
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2158
+
2159
+ 此接口下面信息必填。
2160
+ <ul>
2161
+ <li>渠道应用标识: Agent.AppId</li>
2162
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2163
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
2164
+ </ul>
2165
+ 第三方平台子客企业和员工必须已经过实名认证
2156
2166
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2157
2167
  :param _Name: 签署方经办人的姓名。
2158
2168
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
@@ -2198,7 +2208,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
2198
2208
  <li>请确认该名称与企业营业执照中注册的名称一致。</li>
2199
2209
  <li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
2200
2210
  <li>请确保此企业已完成腾讯电子签企业认证。</li>
2201
- <li>若为子客企业,请确保员工已经加入企业。</li>
2211
+ <li>暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。</li>
2202
2212
  </ul>
2203
2213
  :type OrganizationName: str
2204
2214
  :param _JumpToDetail: 是否直接跳转至合同内容页面进行签署
@@ -2334,13 +2344,17 @@ class ChannelCreateBatchSignUrlResponse(AbstractModel):
2334
2344
  r"""
2335
2345
  :param _SignUrl: 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
2336
2346
 
2337
- 注: `非小程序和APP集成使用`
2347
+ 注:
2348
+ 1. 非小程序和APP集成使用
2349
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
2338
2350
  :type SignUrl: str
2339
2351
  :param _ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
2340
2352
  :type ExpiredTime: int
2341
2353
  :param _MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
2342
2354
 
2343
- 注: `小程序和APP集成使用`
2355
+ 注:
2356
+ 1. 小程序和APP集成使用
2357
+ 2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
2344
2358
  :type MiniAppPath: str
2345
2359
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2346
2360
  :type RequestId: str
@@ -2988,9 +3002,9 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
2988
3002
 
2989
3003
  此接口下面信息必填。
2990
3004
  <ul>
2991
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2992
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2993
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3005
+ <li>渠道应用标识: Agent.AppId</li>
3006
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3007
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2994
3008
  </ul>
2995
3009
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2996
3010
  :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
@@ -3789,23 +3803,29 @@ class ChannelCreateFlowSignReviewRequest(AbstractModel):
3789
3803
  r"""
3790
3804
  :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3791
3805
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
3792
- :param _FlowId: 签署流程编号
3806
+ :param _FlowId: 合同流程ID,为32位字符串。
3807
+ <ul><li>建议开发者妥善保存此流程ID,以便于顺利进行后续操作。</li>
3808
+ <li>可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
3793
3809
  :type FlowId: str
3794
3810
  :param _ReviewType: 企业内部审核结果
3795
- PASS: 通过
3796
- REJECT: 拒绝
3797
- SIGN_REJECT:拒签(流程结束)
3811
+ <ul><li>PASS: 审核通过</li>
3812
+ <li>REJECT: 审核拒绝</li>
3813
+ <li>SIGN_REJECT:拒签(流程结束)</li></ul>
3798
3814
  :type ReviewType: str
3799
- :param _ReviewMessage: 审核原因
3800
- 当ReviewType 是REJECT 时此字段必填,字符串长度不超过200
3815
+ :param _ReviewMessage: 审核结果原因
3816
+ <ul><li>字符串长度不超过200</li>
3817
+ <li>当ReviewType 是拒绝(REJECT) 时此字段必填。</li>
3818
+ <li>当ReviewType 是拒绝(SIGN_REJECT) 时此字段必填。</li></ul>
3801
3819
  :type ReviewMessage: str
3802
- :param _RecipientId: 签署节点审核时需要指定,给个人审核时必填。
3820
+ :param _RecipientId: 审核节点的签署人标志,用于指定当前审核的签署方
3821
+ <ul><li>**如果签署审核节点是个人, 此参数必填**。</li></ul>
3803
3822
  :type RecipientId: str
3804
- :param _OperateType: 操作类型,默认:SignReview;SignReview:签署审核,CreateReview:发起审核
3805
- 注:接口通过该字段区分操作类型
3806
- 该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程
3807
- 若想使用发起审核,请指定该字段为:CreateReview
3808
- 若发起个人审核,则指定该字段为:SignReview
3823
+ :param _OperateType: 流程审核操作类型,取值如下:
3824
+ <ul><li>**SignReview**:(默认)签署审核</li>
3825
+ <li>**CreateReview**:发起审核</li>
3826
+ <li>注意:`该字段不传或者为空,则默认为SignReview签署审核,走签署审核流程`</li></ul>
3827
+
3828
+
3809
3829
  :type OperateType: str
3810
3830
  """
3811
3831
  self._Agent = None
@@ -4273,9 +4293,9 @@ class ChannelCreateMultiFlowSignQRCodeResponse(AbstractModel):
4273
4293
 
4274
4294
  def __init__(self):
4275
4295
  r"""
4276
- :param _QrCode: 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
4296
+ :param _QrCode: 一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。
4277
4297
  :type QrCode: :class:`tencentcloud.essbasic.v20210526.models.SignQrCode`
4278
- :param _SignUrls: 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
4298
+ :param _SignUrls: 一码多签签署码链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
4279
4299
  :type SignUrls: :class:`tencentcloud.essbasic.v20210526.models.SignUrl`
4280
4300
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4281
4301
  :type RequestId: str
@@ -4571,8 +4591,9 @@ class ChannelCreatePrepareFlowRequest(AbstractModel):
4571
4591
  :param _ResourceId: 资源id,与ResourceType相对应,取值范围:
4572
4592
  <ul>
4573
4593
  <li>文件Id(通过UploadFiles获取文件资源Id)</li>
4574
- <li>模板Id</li>
4594
+ <li>模板Id(通过控制台创建模板后获取模板Id)</li>
4575
4595
  </ul>
4596
+ 注意:需要同时设置 ResourceType 参数指定资源类型
4576
4597
  :type ResourceId: str
4577
4598
  :param _FlowOption: 合同流程配置信息,用于配置发起合同时定制化如是否允许修改,某些按钮的隐藏等逻辑
4578
4599
  :type FlowOption: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowOption`
@@ -8456,7 +8477,7 @@ class CommonFlowApprover(AbstractModel):
8456
8477
 
8457
8478
  注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
8458
8479
  :type NotifyType: str
8459
- :param _ApproverOption: 签署人配置
8480
+ :param _ApproverOption: 签署人配置,用于控制签署人相关属性
8460
8481
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.CommonApproverOption`
8461
8482
  :param _SignComponents: 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
8462
8483
  :type SignComponents: list of Component
@@ -8704,223 +8725,188 @@ class Component(AbstractModel):
8704
8725
 
8705
8726
  def __init__(self):
8706
8727
  r"""
8707
- :param _ComponentId: 控件编号
8728
+ :param _ComponentId: 控件唯一ID。
8708
8729
 
8709
- CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
8730
+ **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
8710
8731
 
8711
- 注:
8712
- 当GenerateMode=KEYWORD时,通过"^"来决定是否使用关键字整词匹配能力。
8713
- 例:当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
8714
- 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
8732
+ **在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
8733
+
8734
+ 例:
8735
+
8736
+ - 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
8737
+ - 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
8738
+ - 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
8739
+ - 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
8740
+
8741
+
8742
+ 注:`控件ID可以在一个PDF中不可重复`
8715
8743
 
8716
- 创建控件时,此值为空
8717
- 查询时返回完整结构
8718
8744
  :type ComponentId: str
8719
- :param _ComponentType: 如果是Component控件类型,则可选的字段为:
8720
- TEXT - 普通文本控件,输入文本字符串;
8721
- MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
8722
- CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
8723
- FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
8724
- DYNAMIC_TABLE - 动态表格控件;
8725
- ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分割;
8726
- SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
8727
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
8728
- DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
8729
-
8730
- 如果是SignComponent控件类型,则可选的字段为
8731
- SIGN_SEAL - 签署印章控件;
8732
- SIGN_DATE - 签署日期控件;
8733
- SIGN_SIGNATURE - 用户签名控件;
8734
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
8735
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
8736
- SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
8737
- SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
8738
-
8739
- 表单域的控件不能作为印章和签名控件
8745
+ :param _ComponentType: **如果是Component填写控件类型,则可选的字段为**:
8746
+
8747
+ <ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
8748
+ <li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
8749
+ <li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
8750
+ <li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
8751
+ <li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
8752
+ <li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
8753
+ <li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
8754
+ <li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
8755
+ <li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
8756
+
8757
+ **如果是SignComponent签署控件类型,则可选的字段为**
8758
+
8759
+ <ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
8760
+ <li> <b>SIGN_DATE</b> : 签署日期控件;</li>
8761
+ <li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
8762
+ <li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li>
8763
+ <li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
8764
+ <li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
8765
+ <li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
8766
+ 注:` 表单域的控件不能作为印章和签名控件`
8740
8767
  :type ComponentType: str
8741
- :param _ComponentName: 控件简称,不超过30个字符
8768
+ :param _ComponentName: **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
8769
+
8770
+ **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
8771
+
8772
+ 注:`控件名可以在一个PDF中可以重复`
8773
+
8742
8774
  :type ComponentName: str
8743
- :param _ComponentRequired: 控件是否为必填项,
8744
- 默认为false-非必填
8775
+ :param _ComponentRequired: 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
8776
+ <ul><li>false(默认):可以不填写</li>
8777
+ <li>true :必须填写此填写控件</li></ul>
8778
+ 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
8745
8779
  :type ComponentRequired: bool
8746
- :param _ComponentRecipientId: 控件关联的参与方ID,对应Recipient结构体中的RecipientId
8780
+ :param _ComponentRecipientId: **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
8747
8781
  :type ComponentRecipientId: str
8748
- :param _FileIndex: 控件所属文件的序号 (文档中文件的排列序号,从0开始)
8782
+ :param _FileIndex: <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
8749
8783
  :type FileIndex: int
8750
8784
  :param _GenerateMode: 控件生成的方式:
8751
- NORMAL - 普通控件
8752
- FIELD - 表单域
8753
- KEYWORD - 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)
8785
+ <ul><li> <b>NORMAL</b> : 绝对定位控件</li>
8786
+ <li> <b>FIELD</b> : 表单域</li>
8787
+ <li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
8754
8788
  :type GenerateMode: str
8755
- :param _ComponentWidth: 参数控件宽度,默认100,单位px
8756
- 表单域和关键字转换控件不用填
8789
+ :param _ComponentWidth: **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
8790
+
8757
8791
  :type ComponentWidth: float
8758
- :param _ComponentHeight: 参数控件高度,默认100,单位px
8759
- 表单域和关键字转换控件不用填
8792
+ :param _ComponentHeight: **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
8793
+
8760
8794
  :type ComponentHeight: float
8761
- :param _ComponentPage: 参数控件所在页码,从1开始
8795
+ :param _ComponentPage: **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
8796
+
8797
+ 注:
8798
+ 1. 页码编号是从<font color="red">1</font>开始编号的。
8799
+ 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
8762
8800
  :type ComponentPage: int
8763
- :param _ComponentPosX: 参数控件X位置,单位px
8801
+ :param _ComponentPosX: **在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
8764
8802
  :type ComponentPosX: float
8765
- :param _ComponentPosY: 参数控件Y位置,单位px
8803
+ :param _ComponentPosY: **在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
8766
8804
  :type ComponentPosY: float
8767
- :param _ComponentExtra: 扩展参数:
8768
- 为JSON格式。
8769
- 不同类型的控件会有部分非通用参数
8770
-
8771
- ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
8772
- 1 Font:目前只支持黑体、宋体
8773
- 2 FontSize: 范围12-72
8774
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
8775
- 4 FontColor:字符串类型,格式为RGB颜色数字
8776
- 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
8777
-
8778
- ComponentType为FILL_IMAGE时,支持以下参数:
8779
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
8780
- FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
8781
-
8782
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
8783
- {“ComponentTypeLimit”: [“xxx”]}
8784
- xxx可以为:
8785
- HANDWRITE 手写签名
8786
- OCR_ESIGN -- AI智能识别手写签名
8787
- ESIGN -- 个人印章类型
8788
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
8789
- 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
8790
-
8791
- ComponentType为SIGN_DATE时,支持以下参数:
8792
- 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
8793
- 2 FontSize: 数字类型,范围6-72,默认值为12
8794
- 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
8795
- 4 Format: 字符串类型,日期格式,必须是以下五种之一 yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
8796
- 5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
8805
+ :param _ComponentExtra: **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
8806
+
8807
+ <font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
8808
+ <ul><li> <b>Font</b>:目前只支持黑体、宋体</li>
8809
+ <li> <b>FontSize</b>: 范围12 :72</li>
8810
+ <li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
8811
+ <li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>
8812
+ <b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
8813
+
8814
+ <font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
8815
+ <ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
8816
+ <li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
8817
+
8818
+ <font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
8819
+ <ul><li> <b>HANDWRITE</b> : 手写签名</li>
8820
+ <li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
8821
+ <li> <b>ESIGN</b> : 个人印章类型</li>
8822
+ <li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
8823
+ <li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
8824
+ <b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
8825
+ 印章的对应关系参考下图
8826
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ee0498856c060c065628a0c5ba780d6b.jpg)
8827
+
8828
+ <font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
8829
+ <ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
8830
+ <li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
8831
+ <li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
8832
+ <li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
8833
+ <li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
8797
8834
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
8798
8835
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
8799
- 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
8800
-
8801
- ComponentType为SIGN_SEAL类型时,支持以下参数:
8802
- 1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
8803
- 参数样例: "ComponentExtra":"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"
8804
- :type ComponentExtra: str
8805
- :param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
8806
- TEXT - 文本内容
8807
- MULTI_LINE_TEXT - 文本内容
8808
- CHECK_BOX - true/false
8809
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
8810
- SELECTOR - 选项值
8811
- DATE - 默认是格式化为xxxx年xx月xx日
8812
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
8813
- SIGN_SEAL - 印章ID
8814
- SIGN_PAGING_SEAL - 可以指定印章ID
8836
+ <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
8815
8837
 
8816
- 控件值约束说明:
8817
- 企业全称控件:
8818
- 约束:企业名称中文字符中文括号
8819
- 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
8838
+ <font color="red">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:
8839
+ <ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
8840
+ <b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
8820
8841
 
8821
- 统一社会信用代码控件:
8822
- 检查正则表达式:/^[A-Z0-9]{1,18}$/
8823
8842
 
8824
- 法人名称控件:
8825
- 约束:最大50个字符,2到25个汉字或者1到50个字母
8826
- 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
8827
-
8828
- 签署意见控件:
8829
- 约束:签署意见最大长度为50字符
8830
-
8831
- 签署人手机号控件:
8832
- 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
8833
-
8834
- 签署人身份证控件:
8835
- 约束:合法的身份证号码检查
8836
-
8837
- 控件名称:
8838
- 约束:控件名称最大长度为20字符
8839
-
8840
- 单行文本控件:
8841
- 约束:只允许输入中文,英文,数字,中英文标点符号
8842
-
8843
- 多行文本控件:
8844
- 约束:只允许输入中文,英文,数字,中英文标点符号
8845
-
8846
- 勾选框控件:
8847
- 约束:选择填字符串true,不选填字符串false
8848
-
8849
- 选择器控件:
8850
- 约束:同单行文本控件约束,填写选择值中的字符串
8851
-
8852
- 数字控件:
8853
- 约束:请输入有效的数字(可带小数点)
8854
- 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
8855
-
8856
- 日期控件:
8857
- 约束:格式:yyyy年mm月dd日
8858
-
8859
- 附件控件:
8860
- 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
8861
-
8862
- 图片控件:
8863
- 约束:JPG或PNG图片,填写上传的图片资源ID
8864
-
8865
- 邮箱控件:
8866
- 约束:请输入有效的邮箱地址, w3c标准
8867
- 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
8868
- 参考:https://emailregex.com/
8869
-
8870
- 地址控件:
8871
- 同单行文本控件约束
8872
-
8873
- 省市区控件:
8874
- 同单行文本控件约束
8875
-
8876
- 性别控件:
8877
- 同单行文本控件约束,填写选择值中的字符串
8878
-
8879
- 学历控件:
8880
- 同单行文本控件约束,填写选择值中的字符串
8843
+ <font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
8844
+ <ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
8845
+ 场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
8846
+ <b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
8847
+ :type ComponentExtra: str
8848
+ :param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
8849
+ <ul><li> <b>TEXT</b> : 文本内容</li>
8850
+ <li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
8851
+ <li> <b>CHECK_BOX</b> : true/false</li>
8852
+ <li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
8853
+ <li> <b>SELECTOR</b> : 选项值</li>
8854
+ <li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
8855
+ <li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
8856
+ <li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取</li>
8857
+ <li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取</li></ul>
8858
+
8859
+
8860
+ <b>控件值约束说明</b>:
8861
+ <table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
8862
+ 注: `部分特殊控件需要在控制台配置模板形式创建`
8881
8863
  :type ComponentValue: str
8882
- :param _ComponentDateFontSize: 日期签署控件的字号,默认为 12
8883
-
8884
- 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
8864
+ :param _ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
8885
8865
  :type ComponentDateFontSize: int
8886
- :param _DocumentId: 控件所属文档的Id, 模板相关接口为空值
8866
+ :param _DocumentId: <font color="red">【暂未使用】</font>控件归属的文档的ID, **发起合同时候不要填写此字段留空即可**
8887
8867
  :type DocumentId: str
8888
- :param _ComponentDescription: 控件描述,不超过30个字符
8868
+ :param _ComponentDescription: <font color="red">【暂未使用】</font>控件描述,用户自定义,不影响合同发起流程
8889
8869
  :type ComponentDescription: str
8890
- :param _OffsetX: 指定关键字时横坐标偏移量,单位pt
8870
+ :param _OffsetX: **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
8871
+ 注意: `向左调整设置为负数, 向右调整设置成正数`
8891
8872
  :type OffsetX: float
8892
- :param _OffsetY: 指定关键字时纵坐标偏移量,单位pt
8873
+ :param _OffsetY: **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
8874
+ 注意: `向上调整设置为负数, 向下调整设置成正数`
8893
8875
  :type OffsetY: float
8894
- :param _ChannelComponentId: 平台企业控件ID
8895
- 如果不为空,属于平台企业预设控件;
8876
+ :param _ChannelComponentId: <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
8896
8877
  :type ChannelComponentId: str
8897
- :param _KeywordOrder: 指定关键字排序规则,
8898
- Positive-正序,
8899
- Reverse-倒序。
8900
- 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
8901
- 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
8878
+ :param _KeywordOrder: **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
8879
+ <ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
8880
+ <li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
8881
+
8882
+ 在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
8902
8883
  :type KeywordOrder: str
8903
- :param _KeywordPage: 指定关键字页码。
8904
- 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
8884
+ :param _KeywordPage: **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
8905
8885
  :type KeywordPage: int
8906
- :param _RelativeLocation: 关键字位置模式,
8907
- Middle-居中,
8908
- Below-正下方,
8909
- Right-正右方,
8910
- LowerRight-右上角,
8911
- UpperRight-右下角。
8886
+ :param _RelativeLocation: **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
8887
+ <ul><li> <b>Middle</b> :居中</li>
8888
+ <li> <b>Below</b> :正下方</li>
8889
+ <li> <b>Right</b> :正右方</li>
8890
+ <li> <b>LowerRight</b> :右上角</li>
8891
+ <li> <b>UpperRight</b> :右下角。</li></ul>
8912
8892
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
8913
8893
  :type RelativeLocation: str
8914
- :param _KeywordIndexes: 关键字索引,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
8915
- 示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
8894
+ :param _KeywordIndexes: **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
8895
+
8896
+ 注意:关键字索引是从0开始计数的
8916
8897
  :type KeywordIndexes: list of int
8917
- :param _Placeholder: 填写提示的内容
8898
+ :param _Placeholder: 填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。
8899
+ 注:`签署控件设置此字段无效`
8918
8900
  注意:此字段可能返回 null,表示取不到有效值。
8919
8901
  :type Placeholder: str
8920
- :param _LockComponentValue: 是否锁定控件值不允许编辑(嵌入式发起使用) <br/>默认false:不锁定控件值,允许在页面编辑控件值
8902
+ :param _LockComponentValue: **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
8903
+ <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
8904
+ <li>true:锁定控件值,在页面编辑控件值</li></ul>
8921
8905
  注意:此字段可能返回 null,表示取不到有效值。
8922
8906
  :type LockComponentValue: bool
8923
- :param _ForbidMoveAndDelete: 是否禁止移动和删除控件 <br/>默认false,不禁止移动和删除控件
8907
+ :param _ForbidMoveAndDelete: **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
8908
+ <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
8909
+ <li> <b>true</b> : 可以移动和删除控件</li></ul>
8924
8910
  注意:此字段可能返回 null,表示取不到有效值。
8925
8911
  :type ForbidMoveAndDelete: bool
8926
8912
  """
@@ -9553,17 +9539,25 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
9553
9539
  此接口下面信息必填。
9554
9540
  <ul>
9555
9541
  <li>渠道应用标识: Agent.AppId</li>
9556
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
9557
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOrganizationOpenId</li>
9542
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
9543
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
9558
9544
  </ul>
9545
+ 第三方平台子客企业和员工必须已经过实名认证
9559
9546
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9560
9547
  :param _ChangeType: 企业信息变更类型,可选类型如下:
9561
9548
  <ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
9562
9549
  <li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
9563
9550
  :type ChangeType: int
9551
+ :param _Endpoint: 变更链接类型:
9552
+ <ul>
9553
+ <li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>
9554
+ <li>**APP** : 创建变更小程序链接,可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>
9555
+ </ul>
9556
+ :type Endpoint: str
9564
9557
  """
9565
9558
  self._Agent = None
9566
9559
  self._ChangeType = None
9560
+ self._Endpoint = None
9567
9561
 
9568
9562
  @property
9569
9563
  def Agent(self):
@@ -9581,12 +9575,21 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
9581
9575
  def ChangeType(self, ChangeType):
9582
9576
  self._ChangeType = ChangeType
9583
9577
 
9578
+ @property
9579
+ def Endpoint(self):
9580
+ return self._Endpoint
9581
+
9582
+ @Endpoint.setter
9583
+ def Endpoint(self, Endpoint):
9584
+ self._Endpoint = Endpoint
9585
+
9584
9586
 
9585
9587
  def _deserialize(self, params):
9586
9588
  if params.get("Agent") is not None:
9587
9589
  self._Agent = Agent()
9588
9590
  self._Agent._deserialize(params.get("Agent"))
9589
9591
  self._ChangeType = params.get("ChangeType")
9592
+ self._Endpoint = params.get("Endpoint")
9590
9593
  memeber_set = set(params.keys())
9591
9594
  for name, value in vars(self).items():
9592
9595
  property_name = name[1:]
@@ -9701,10 +9704,10 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
9701
9704
  注:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
9702
9705
  :type MenuStatus: str
9703
9706
  :param _Endpoint: 生成链接的类型:
9704
- <ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
9707
+ <ul><li>**PC**:(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
9705
9708
  <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
9706
- <li>**SHORT_URL**:H5跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
9707
- <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
9709
+ <li>**SHORT_URL**:<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
9710
+ <li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
9708
9711
  :type Endpoint: str
9709
9712
  :param _AutoJumpBackEvent: 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
9710
9713
  <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
@@ -9862,9 +9865,11 @@ class CreateConsoleLoginUrlResponse(AbstractModel):
9862
9865
  r"""
9863
9866
  :param _ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
9864
9867
  <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>
9868
+
9865
9869
  注:
9866
- `1.链接仅单次有效,每次登录需要需要重新创建新的链接`
9867
- `2.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`
9870
+ 1. <font color="red">链接仅单次有效</font>,每次登录需要需要重新创建新的链接
9871
+ 2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
9872
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
9868
9873
 
9869
9874
  :type ConsoleUrl: str
9870
9875
  :param _IsActivated: 子客企业是否已开通腾讯电子签,
@@ -9926,6 +9931,138 @@ class CreateConsoleLoginUrlResponse(AbstractModel):
9926
9931
  self._RequestId = params.get("RequestId")
9927
9932
 
9928
9933
 
9934
+ class CreateFlowGroupSignReviewRequest(AbstractModel):
9935
+ """CreateFlowGroupSignReview请求参数结构体
9936
+
9937
+ """
9938
+
9939
+ def __init__(self):
9940
+ r"""
9941
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
9942
+
9943
+ 此接口下面信息必填。
9944
+ <ul>
9945
+ <li>渠道应用标识: Agent.AppId</li>
9946
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
9947
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
9948
+ </ul>
9949
+ 第三方平台子客企业和员工必须已经经过实名认证
9950
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9951
+ :param _FlowGroupId: 合同(流程)组的合同组Id,为32位字符串,通过接口[通过多文件创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByFiles) 或[通过多模板创建合同组签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates)创建合同组签署流程时返回。
9952
+ :type FlowGroupId: str
9953
+ :param _ReviewType: 提交的审核结果,审核结果有下面三种情况
9954
+ <ul><li><b>PASS</b>: 审核通过,合同流程可以继续执行签署等操作</li>
9955
+ <li><b>REJECT</b>: 审核拒绝,合同流程不会变动</li>
9956
+ <li><b>SIGN_REJECT</b>:拒签,合同流程直接结束,合同状态变为**合同拒签**</li></ul>
9957
+ :type ReviewType: str
9958
+ :param _ApproverInfo: 需要进行签署审核的签署人的个人信息或企业信息,签署方的匹配方式按照以下规则:
9959
+
9960
+ 个人:二选一(选择其中任意信息组合即可)
9961
+ <ul><li>姓名+证件类型+证件号</li>
9962
+ <li>姓名+手机号</li></ul>
9963
+
9964
+ 企业:二选一 (选择其中任意信息组合即可)
9965
+ <ul><li>企业名+姓名+证件类型+证件号</li>
9966
+ <li>企业名+姓名+手机号</li></ul>
9967
+ :type ApproverInfo: :class:`tencentcloud.essbasic.v20210526.models.NeedReviewApproverInfo`
9968
+ :param _ReviewMessage: 审核不通过的原因,该字段的字符串长度不超过200个字符。
9969
+
9970
+ 注:`当审核类型(ReviewType)为审核拒绝(REJECT)或拒签(SIGN_REJECT)时,审核结果原因字段必须填写`
9971
+
9972
+ :type ReviewMessage: str
9973
+ """
9974
+ self._Agent = None
9975
+ self._FlowGroupId = None
9976
+ self._ReviewType = None
9977
+ self._ApproverInfo = None
9978
+ self._ReviewMessage = None
9979
+
9980
+ @property
9981
+ def Agent(self):
9982
+ return self._Agent
9983
+
9984
+ @Agent.setter
9985
+ def Agent(self, Agent):
9986
+ self._Agent = Agent
9987
+
9988
+ @property
9989
+ def FlowGroupId(self):
9990
+ return self._FlowGroupId
9991
+
9992
+ @FlowGroupId.setter
9993
+ def FlowGroupId(self, FlowGroupId):
9994
+ self._FlowGroupId = FlowGroupId
9995
+
9996
+ @property
9997
+ def ReviewType(self):
9998
+ return self._ReviewType
9999
+
10000
+ @ReviewType.setter
10001
+ def ReviewType(self, ReviewType):
10002
+ self._ReviewType = ReviewType
10003
+
10004
+ @property
10005
+ def ApproverInfo(self):
10006
+ return self._ApproverInfo
10007
+
10008
+ @ApproverInfo.setter
10009
+ def ApproverInfo(self, ApproverInfo):
10010
+ self._ApproverInfo = ApproverInfo
10011
+
10012
+ @property
10013
+ def ReviewMessage(self):
10014
+ return self._ReviewMessage
10015
+
10016
+ @ReviewMessage.setter
10017
+ def ReviewMessage(self, ReviewMessage):
10018
+ self._ReviewMessage = ReviewMessage
10019
+
10020
+
10021
+ def _deserialize(self, params):
10022
+ if params.get("Agent") is not None:
10023
+ self._Agent = Agent()
10024
+ self._Agent._deserialize(params.get("Agent"))
10025
+ self._FlowGroupId = params.get("FlowGroupId")
10026
+ self._ReviewType = params.get("ReviewType")
10027
+ if params.get("ApproverInfo") is not None:
10028
+ self._ApproverInfo = NeedReviewApproverInfo()
10029
+ self._ApproverInfo._deserialize(params.get("ApproverInfo"))
10030
+ self._ReviewMessage = params.get("ReviewMessage")
10031
+ memeber_set = set(params.keys())
10032
+ for name, value in vars(self).items():
10033
+ property_name = name[1:]
10034
+ if property_name in memeber_set:
10035
+ memeber_set.remove(property_name)
10036
+ if len(memeber_set) > 0:
10037
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
10038
+
10039
+
10040
+
10041
+ class CreateFlowGroupSignReviewResponse(AbstractModel):
10042
+ """CreateFlowGroupSignReview返回参数结构体
10043
+
10044
+ """
10045
+
10046
+ def __init__(self):
10047
+ r"""
10048
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
10049
+ :type RequestId: str
10050
+ """
10051
+ self._RequestId = None
10052
+
10053
+ @property
10054
+ def RequestId(self):
10055
+ return self._RequestId
10056
+
10057
+ @RequestId.setter
10058
+ def RequestId(self, RequestId):
10059
+ self._RequestId = RequestId
10060
+
10061
+
10062
+ def _deserialize(self, params):
10063
+ self._RequestId = params.get("RequestId")
10064
+
10065
+
9929
10066
  class CreateFlowOption(AbstractModel):
9930
10067
  """创建合同个性化参数
9931
10068
 
@@ -10666,7 +10803,7 @@ class CreateSignUrlsRequest(AbstractModel):
10666
10803
  <ul>
10667
10804
  <li>渠道应用标识: Agent.AppId</li>
10668
10805
  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
10669
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
10806
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
10670
10807
  </ul>
10671
10808
  第三方平台子客企业和员工必须已经过实名认证
10672
10809
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
@@ -11841,10 +11978,11 @@ class DescribeExtendedServiceAuthInfoRequest(AbstractModel):
11841
11978
 
11842
11979
  此接口下面信息必填。
11843
11980
  <ul>
11844
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
11845
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
11846
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
11981
+ <li>渠道应用标识: Agent.AppId</li>
11982
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
11983
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
11847
11984
  </ul>
11985
+ 第三方平台子客企业和员工必须已经过实名认证
11848
11986
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
11849
11987
  """
11850
11988
  self._Agent = None
@@ -12755,11 +12893,12 @@ class ExtentServiceAuthInfo(AbstractModel):
12755
12893
  :param _Type: 扩展服务类型
12756
12894
  <ul>
12757
12895
  <li>AUTO_SIGN 企业自动签(自动签署)</li>
12758
- <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
12896
+ <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
12759
12897
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
12760
12898
  <li> PAGING_SEAL 骑缝章</li>
12761
12899
  <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
12762
12900
  <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
12901
+ <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
12763
12902
  </ul>
12764
12903
  :type Type: str
12765
12904
  :param _Name: 扩展服务名称
@@ -13500,7 +13639,14 @@ class FlowApproverInfo(AbstractModel):
13500
13639
  :param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人、是否为动态补充签署人等。
13501
13640
  详细操作可以参考开发者中心的ApproverOption结构体。
13502
13641
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
13503
- :param _ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
13642
+ :param _ApproverNeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
13643
+ <ul><li>**false**:(默认)不需要审批,直接签署。</li>
13644
+ <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
13645
+ 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
13646
+ <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
13647
+ <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
13648
+
13649
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
13504
13650
  :type ApproverNeedSignReview: bool
13505
13651
  :param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
13506
13652
  <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
@@ -13884,10 +14030,12 @@ class FlowApproverUrlInfo(AbstractModel):
13884
14030
 
13885
14031
  def __init__(self):
13886
14032
  r"""
13887
- :param _SignUrl: 签署短链接。</br>
14033
+ :param _SignUrl: 签署短链接。
14034
+
13888
14035
  注意:
13889
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
13890
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
14036
+ 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
14037
+ 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
14038
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
13891
14039
  :type SignUrl: str
13892
14040
  :param _ApproverType: 签署人类型。
13893
14041
  - **PERSON**: 个人
@@ -13896,10 +14044,12 @@ class FlowApproverUrlInfo(AbstractModel):
13896
14044
  :type Name: str
13897
14045
  :param _Mobile: 签署人手机号。
13898
14046
  :type Mobile: str
13899
- :param _LongUrl: 签署长链接。</br>
14047
+ :param _LongUrl: 签署长链接。
14048
+
13900
14049
  注意:
13901
- - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
13902
- - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
14050
+ 1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
14051
+ 2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
14052
+ 3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
13903
14053
  注意:此字段可能返回 null,表示取不到有效值。
13904
14054
  :type LongUrl: str
13905
14055
  """
@@ -15225,24 +15375,28 @@ class ModifyExtendedServiceRequest(AbstractModel):
15225
15375
 
15226
15376
  此接口下面信息必填。
15227
15377
  <ul>
15228
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
15229
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
15230
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
15378
+ <li>渠道应用标识: Agent.AppId</li>
15379
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
15380
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
15231
15381
  </ul>
15382
+ 第三方平台子客企业和员工必须已经过实名认证
15232
15383
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
15233
15384
  :param _ServiceType: 扩展服务类型
15234
15385
  <ul>
15235
15386
  <li>AUTO_SIGN 企业自动签(自动签署)</li>
15236
- <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
15387
+ <li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
15237
15388
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
15238
15389
  <li> PAGING_SEAL 骑缝章</li>
15239
15390
  <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
15240
15391
  <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
15392
+ <li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
15241
15393
  </ul>
15242
15394
  :type ServiceType: str
15243
- :param _Operate: 操作类型
15244
- OPEN:开通
15245
- CLOSE:关闭
15395
+ :param _Operate: 操作类型
15396
+ <ul>
15397
+ <li>OPEN : 开通</li>
15398
+ <li>CLOSE : 关闭</li>
15399
+ </ul>
15246
15400
  :type Operate: str
15247
15401
  :param _Endpoint: 链接跳转类型,支持以下类型
15248
15402
  <ul>
@@ -15316,8 +15470,8 @@ class ModifyExtendedServiceResponse(AbstractModel):
15316
15470
  :param _OperateUrl: 操作跳转链接,有效期24小时
15317
15471
  若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
15318
15472
 
15319
- 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
15320
- 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
15473
+ 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
15474
+ 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作
15321
15475
  :type OperateUrl: str
15322
15476
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
15323
15477
  :type RequestId: str
@@ -15347,6 +15501,114 @@ class ModifyExtendedServiceResponse(AbstractModel):
15347
15501
  self._RequestId = params.get("RequestId")
15348
15502
 
15349
15503
 
15504
+ class NeedReviewApproverInfo(AbstractModel):
15505
+ """需要进行签署审核的签署人信息
15506
+
15507
+ """
15508
+
15509
+ def __init__(self):
15510
+ r"""
15511
+ :param _ApproverType: 签署方经办人的类型,支持以下类型
15512
+ <ul><li> ORGANIZATION 企业(含企业自动签)</li>
15513
+ <li>PERSON 个人(含个人自动签)</li></ul>
15514
+ :type ApproverType: str
15515
+ :param _ApproverName: 签署方经办人的姓名。 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
15516
+ :type ApproverName: str
15517
+ :param _ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
15518
+ :type ApproverMobile: str
15519
+ :param _ApproverIdCardType: 签署方经办人的证件类型,支持以下类型
15520
+ <ul><li>ID_CARD 居民身份证 (默认值)</li>
15521
+ <li>HONGKONG_AND_MACAO 港澳居民来往内地通行证</li>
15522
+ <li>HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)</li>
15523
+ <li>OTHER_CARD_TYPE 其他证件</li></ul>
15524
+
15525
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
15526
+ :type ApproverIdCardType: str
15527
+ :param _ApproverIdCardNumber: 签署方经办人的证件号码,应符合以下规则
15528
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
15529
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
15530
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
15531
+ :type ApproverIdCardNumber: str
15532
+ :param _OrganizationName: 组织机构名称。
15533
+ 请确认该名称与企业营业执照中注册的名称一致。
15534
+ 如果名称中包含英文括号(),请使用中文括号()代替。
15535
+ 如果签署方是企业签署方(approverType = 0 或者 approverType = 3), 则企业名称必填。
15536
+
15537
+ :type OrganizationName: str
15538
+ """
15539
+ self._ApproverType = None
15540
+ self._ApproverName = None
15541
+ self._ApproverMobile = None
15542
+ self._ApproverIdCardType = None
15543
+ self._ApproverIdCardNumber = None
15544
+ self._OrganizationName = None
15545
+
15546
+ @property
15547
+ def ApproverType(self):
15548
+ return self._ApproverType
15549
+
15550
+ @ApproverType.setter
15551
+ def ApproverType(self, ApproverType):
15552
+ self._ApproverType = ApproverType
15553
+
15554
+ @property
15555
+ def ApproverName(self):
15556
+ return self._ApproverName
15557
+
15558
+ @ApproverName.setter
15559
+ def ApproverName(self, ApproverName):
15560
+ self._ApproverName = ApproverName
15561
+
15562
+ @property
15563
+ def ApproverMobile(self):
15564
+ return self._ApproverMobile
15565
+
15566
+ @ApproverMobile.setter
15567
+ def ApproverMobile(self, ApproverMobile):
15568
+ self._ApproverMobile = ApproverMobile
15569
+
15570
+ @property
15571
+ def ApproverIdCardType(self):
15572
+ return self._ApproverIdCardType
15573
+
15574
+ @ApproverIdCardType.setter
15575
+ def ApproverIdCardType(self, ApproverIdCardType):
15576
+ self._ApproverIdCardType = ApproverIdCardType
15577
+
15578
+ @property
15579
+ def ApproverIdCardNumber(self):
15580
+ return self._ApproverIdCardNumber
15581
+
15582
+ @ApproverIdCardNumber.setter
15583
+ def ApproverIdCardNumber(self, ApproverIdCardNumber):
15584
+ self._ApproverIdCardNumber = ApproverIdCardNumber
15585
+
15586
+ @property
15587
+ def OrganizationName(self):
15588
+ return self._OrganizationName
15589
+
15590
+ @OrganizationName.setter
15591
+ def OrganizationName(self, OrganizationName):
15592
+ self._OrganizationName = OrganizationName
15593
+
15594
+
15595
+ def _deserialize(self, params):
15596
+ self._ApproverType = params.get("ApproverType")
15597
+ self._ApproverName = params.get("ApproverName")
15598
+ self._ApproverMobile = params.get("ApproverMobile")
15599
+ self._ApproverIdCardType = params.get("ApproverIdCardType")
15600
+ self._ApproverIdCardNumber = params.get("ApproverIdCardNumber")
15601
+ self._OrganizationName = params.get("OrganizationName")
15602
+ memeber_set = set(params.keys())
15603
+ for name, value in vars(self).items():
15604
+ property_name = name[1:]
15605
+ if property_name in memeber_set:
15606
+ memeber_set.remove(property_name)
15607
+ if len(memeber_set) > 0:
15608
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
15609
+
15610
+
15611
+
15350
15612
  class OccupiedSeal(AbstractModel):
15351
15613
  """持有的电子印章信息
15352
15614
 
@@ -15517,7 +15779,7 @@ class OperateChannelTemplateRequest(AbstractModel):
15517
15779
 
15518
15780
  此接口下面信息必填。
15519
15781
  <ul>
15520
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
15782
+ <li>渠道应用标识: Agent.AppId</li>
15521
15783
  </ul>
15522
15784
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
15523
15785
  :param _OperateType: 操作类型,可取值如下:
@@ -17469,6 +17731,8 @@ class SignUrlInfo(AbstractModel):
17469
17731
  def __init__(self):
17470
17732
  r"""
17471
17733
  :param _SignUrl: 签署链接,过期时间为90天
17734
+
17735
+ 注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
17472
17736
  注意:此字段可能返回 null,表示取不到有效值。
17473
17737
  :type SignUrl: str
17474
17738
  :param _Deadline: 合同过期时间戳,单位秒
@@ -18325,13 +18589,13 @@ class TemplateInfo(AbstractModel):
18325
18589
  :type Components: list of Component
18326
18590
  :param _Recipients: 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
18327
18591
  :type Recipients: list of Recipient
18328
- :param _SignComponents: 此模版中的签署控件列表
18592
+ :param _SignComponents: 此模板中的签署控件列表
18329
18593
  :type SignComponents: list of Component
18330
18594
  :param _TemplateType: 模板类型:1-静默签;3-普通模板
18331
18595
  :type TemplateType: int
18332
18596
  :param _IsPromoter: 是否是发起人 ,已弃用
18333
18597
  :type IsPromoter: bool
18334
- :param _Creator: 模板的创建者信息,电子签系统用户ID
18598
+ :param _Creator: 模板的创建者名字
18335
18599
  :type Creator: str
18336
18600
  :param _CreatedOn: 模板创建的时间戳,格式为Unix标准时间戳(秒)
18337
18601
  :type CreatedOn: int