tencentcloud-sdk-python-essbasic 3.0.1065__tar.gz → 3.0.1075__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (20) hide show
  1. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/PKG-INFO +1 -1
  2. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/setup.py +1 -1
  3. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/__init__.py +1 -1
  4. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20210526/essbasic_client.py +63 -14
  5. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20210526/models.py +192 -200
  6. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
  7. tencentcloud-sdk-python-essbasic-3.0.1075/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
  8. tencentcloud-sdk-python-essbasic-3.0.1065/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
  9. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/README.rst +0 -0
  10. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/setup.cfg +0 -0
  11. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/__init__.py +0 -0
  12. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
  13. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
  14. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
  15. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20201222/models.py +0 -0
  16. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
  17. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
  18. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
  19. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
  20. {tencentcloud-sdk-python-essbasic-3.0.1065 → tencentcloud-sdk-python-essbasic-3.0.1075}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1065
3
+ Version: 3.0.1075
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
8
8
 
9
9
  setup(
10
10
  name='tencentcloud-sdk-python-essbasic',
11
- install_requires=["tencentcloud-sdk-python-common==3.0.1065"],
11
+ install_requires=["tencentcloud-sdk-python-common==3.0.1075"],
12
12
  version=tencentcloud.__version__,
13
13
  description='Tencent Cloud Essbasic SDK for Python',
14
14
  long_description=open('README.rst').read(),
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1065'
17
+ __version__ = '3.0.1075'
@@ -91,9 +91,9 @@ class EssbasicClient(AbstractClient):
91
91
 
92
92
 
93
93
  def ChannelCancelMultiFlowSignQRCode(self, request):
94
- """此接口(CancelMultiFlowSignQRCode)用于废除一码多扫流程签署二维码。
95
- 该接口所需的二维码ID,源自[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
96
- 如果该二维码尚处于有效期内,可通过本接口将其设置为失效状态。
94
+ """此接口(CancelMultiFlowSignQRCode)用于废除取消一码多签签署码。
95
+ 该接口所需的二维码ID,源自[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
96
+ 如果该签署码尚处于有效期内,可通过本接口将其设置为失效状态。
97
97
 
98
98
  :param request: Request instance for ChannelCancelMultiFlowSignQRCode.
99
99
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCancelMultiFlowSignQRCodeRequest`
@@ -207,7 +207,7 @@ class EssbasicClient(AbstractClient):
207
207
  注:
208
208
  - 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
209
209
  - 参与人点击链接后需短信验证码才能查看合同内容。
210
- - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。若为子客企业,请确保员工已经加入企业。
210
+ - 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。
211
211
  - 个人批量签署,签名区`仅支持手写签名`。
212
212
 
213
213
  :param request: Request instance for ChannelCreateBatchSignUrl.
@@ -721,7 +721,7 @@ class EssbasicClient(AbstractClient):
721
721
 
722
722
 
723
723
  def ChannelCreateMultiFlowSignQRCode(self, request):
724
- """此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
724
+ """此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多签签署码。
725
725
 
726
726
  **适用场景**:
727
727
  签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
@@ -731,11 +731,11 @@ class EssbasicClient(AbstractClient):
731
731
  - 模板中配置的签署顺序是无序
732
732
  - B端企业的签署方式是静默签署
733
733
  - B端企业是非首位签署
734
- 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
734
+ 2. 通过扫描一码多签签署码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
735
735
  ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
736
- 3. 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
736
+ 3. 用户通过扫描一码多签签署码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
737
737
 
738
- 二维码的样式如下图:
738
+ 签署码的样式如下图:
739
739
  ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
740
740
 
741
741
  :param request: Request instance for ChannelCreateMultiFlowSignQRCode.
@@ -815,6 +815,41 @@ class EssbasicClient(AbstractClient):
815
815
  注意:
816
816
  1. 只支持PC浏览器操作使用
817
817
 
818
+ **嵌入式签署人-各种场景传参说明**:
819
+
820
+ <table>
821
+ <thead>
822
+ <tr>
823
+ <th>场景编号</th>
824
+ <th>可作为签署方的类型</th>
825
+ <th>签署方传参说明</th>
826
+ </tr>
827
+ </thead>
828
+
829
+ <tbody>
830
+ <tr>
831
+ <td>场景一</td>
832
+ <td>第三方子企业A员工</td>
833
+ <td>OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
834
+ </tr>
835
+ <tr>
836
+ <td>场景二</td>
837
+ <td>第三方子企业B员工</td>
838
+ <td>OpenId、OrganizationOpenId、OrganizationName必传, ApproverType设置为ORGANIZATION</td>
839
+ </tr>
840
+ <tr>
841
+ <td>场景三</td>
842
+ <td>SaaS平台企业员工</td>
843
+ <td>Name、Mobile、OrganizationName必传,NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
844
+ </tr>
845
+ <tr>
846
+ <td>场景四</td>
847
+ <td>个人/自然人</td>
848
+ <td>Name、Mobile必传, ApproverType设置为PERSON</td>
849
+ </tr>
850
+ </tbody>
851
+ </table>
852
+
818
853
  嵌入的页面样式如下:
819
854
  ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
820
855
 
@@ -1489,16 +1524,26 @@ class EssbasicClient(AbstractClient):
1489
1524
 
1490
1525
 
1491
1526
  def CreateChannelOrganizationInfoChangeUrl(self, request):
1492
- """此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接(需要在移动端打开,会跳转到微信小程序),支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。
1527
+ """此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接。
1528
+
1529
+ <h3 id="1">支持变更链接类型,通过入参 Endpoint 指定,默认为WEIXINAPP。</h3>
1530
+
1531
+ <h4 id="WEIXINAPP">WEIXINAPP</h4>
1532
+ <p>创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。</p>
1533
+
1534
+ <h4 id="APP">APP</h4>
1535
+ <p>创建变更小程序链接,可从第三方App跳转到微信腾讯电子签小程序进行更换。</p>
1536
+
1493
1537
 
1538
+ <h3 id="2">支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。</h3>
1494
1539
 
1495
- <h3 id="1-企业超管变更">1. 企业超管变更</h3>
1540
+ <h4 id="1-企业超管变更">1. 企业超管变更</h4>
1496
1541
 
1497
1542
  <p>换成企业的其他员工来当超管</p>
1498
1543
 
1499
- <h3 id="2-企业基础信息变更">2. 企业基础信息变更</h3>
1544
+ <h4 id="2-企业基础信息变更">2. 企业基础信息变更</h4>
1500
1545
 
1501
- <h4 id="可以变动">可以变动</h4>
1546
+ <h5 id="可以变动">可以变动</h5>
1502
1547
 
1503
1548
  <ul>
1504
1549
  <li>企业名称<br>
@@ -1508,7 +1553,7 @@ class EssbasicClient(AbstractClient):
1508
1553
  <li>企业地址和所在地</li>
1509
1554
  </ul>
1510
1555
 
1511
- <h4 id="不可变动">不可变动</h4>
1556
+ <h5 id="不可变动">不可变动</h5>
1512
1557
 
1513
1558
  <ul>
1514
1559
  <li>统一社会信用代码<br>
@@ -1520,7 +1565,7 @@ class EssbasicClient(AbstractClient):
1520
1565
 
1521
1566
  <ul>
1522
1567
  <li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>
1523
- <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
1568
+ <li>印章: 会删除所有的印章所有的机构公章,合同专用章,财务专用章和人事专用章, 然后用新企业名称生成新的机构公章,合同专用章,财务专用章和人事专用章, 而法人章不会处理</li>
1524
1569
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
1525
1570
  </ul>
1526
1571
 
@@ -1559,6 +1604,7 @@ class EssbasicClient(AbstractClient):
1559
1604
  <th>子客企业状态</th>
1560
1605
  <th>子客企业员工状态</th>
1561
1606
  <th>点击链接进入的流程</th>
1607
+ <th>视频样例</th>
1562
1608
  </tr>
1563
1609
  </thead>
1564
1610
  <tbody>
@@ -1566,16 +1612,19 @@ class EssbasicClient(AbstractClient):
1566
1612
  <td>企业未激活</td>
1567
1613
  <td>员工未认证</td>
1568
1614
  <td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
1615
+ <td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
1569
1616
  </tr>
1570
1617
  <tr>
1571
1618
  <td>企业已激活</td>
1572
1619
  <td>员工未认证</td>
1573
1620
  <td>进入员认证并加入企业流程</td>
1621
+ <td>-</td>
1574
1622
  </tr>
1575
1623
  <tr>
1576
1624
  <td>企业已激活</td>
1577
1625
  <td>员工已认证</td>
1578
1626
  <td>进入子客企业Web控制台</td>
1627
+ <td>-</td>
1579
1628
  </tr>
1580
1629
  </tbody>
1581
1630
  </table>
@@ -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
@@ -2154,7 +2154,15 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
2154
2154
 
2155
2155
  def __init__(self):
2156
2156
  r"""
2157
- :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
+ 第三方平台子客企业和员工必须已经过实名认证
2158
2166
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
2159
2167
  :param _Name: 签署方经办人的姓名。
2160
2168
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
@@ -2200,7 +2208,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
2200
2208
  <li>请确认该名称与企业营业执照中注册的名称一致。</li>
2201
2209
  <li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
2202
2210
  <li>请确保此企业已完成腾讯电子签企业认证。</li>
2203
- <li>若为子客企业,请确保员工已经加入企业。</li>
2211
+ <li>暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。</li>
2204
2212
  </ul>
2205
2213
  :type OrganizationName: str
2206
2214
  :param _JumpToDetail: 是否直接跳转至合同内容页面进行签署
@@ -2994,9 +3002,9 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
2994
3002
 
2995
3003
  此接口下面信息必填。
2996
3004
  <ul>
2997
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2998
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2999
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
3005
+ <li>渠道应用标识: Agent.AppId</li>
3006
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3007
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3000
3008
  </ul>
3001
3009
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
3002
3010
  :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
@@ -4285,9 +4293,9 @@ class ChannelCreateMultiFlowSignQRCodeResponse(AbstractModel):
4285
4293
 
4286
4294
  def __init__(self):
4287
4295
  r"""
4288
- :param _QrCode: 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
4296
+ :param _QrCode: 一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。
4289
4297
  :type QrCode: :class:`tencentcloud.essbasic.v20210526.models.SignQrCode`
4290
- :param _SignUrls: 流程签署二维码的签署信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
4298
+ :param _SignUrls: 一码多签签署码链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
4291
4299
  :type SignUrls: :class:`tencentcloud.essbasic.v20210526.models.SignUrl`
4292
4300
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4293
4301
  :type RequestId: str
@@ -4583,8 +4591,9 @@ class ChannelCreatePrepareFlowRequest(AbstractModel):
4583
4591
  :param _ResourceId: 资源id,与ResourceType相对应,取值范围:
4584
4592
  <ul>
4585
4593
  <li>文件Id(通过UploadFiles获取文件资源Id)</li>
4586
- <li>模板Id</li>
4594
+ <li>模板Id(通过控制台创建模板后获取模板Id)</li>
4587
4595
  </ul>
4596
+ 注意:需要同时设置 ResourceType 参数指定资源类型
4588
4597
  :type ResourceId: str
4589
4598
  :param _FlowOption: 合同流程配置信息,用于配置发起合同时定制化如是否允许修改,某些按钮的隐藏等逻辑
4590
4599
  :type FlowOption: :class:`tencentcloud.essbasic.v20210526.models.CreateFlowOption`
@@ -8716,223 +8725,188 @@ class Component(AbstractModel):
8716
8725
 
8717
8726
  def __init__(self):
8718
8727
  r"""
8719
- :param _ComponentId: 控件编号
8728
+ :param _ComponentId: 控件唯一ID。
8720
8729
 
8721
- CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
8730
+ **在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
8722
8731
 
8723
- 注:
8724
- 当GenerateMode=KEYWORD时,通过"^"来决定是否使用关键字整词匹配能力。
8725
- 例:当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
8726
- 如传入的关键字为"甲方签署",则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中不可重复`
8727
8743
 
8728
- 创建控件时,此值为空
8729
- 查询时返回完整结构
8730
8744
  :type ComponentId: str
8731
- :param _ComponentType: 如果是Component控件类型,则可选的字段为:
8732
- TEXT - 普通文本控件,输入文本字符串;
8733
- MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
8734
- CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
8735
- FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
8736
- DYNAMIC_TABLE - 动态表格控件;
8737
- ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分割;
8738
- SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
8739
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
8740
- DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
8741
-
8742
- 如果是SignComponent控件类型,则可选的字段为
8743
- SIGN_SEAL - 签署印章控件;
8744
- SIGN_DATE - 签署日期控件;
8745
- SIGN_SIGNATURE - 用户签名控件;
8746
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
8747
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
8748
- SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
8749
- SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
8750
-
8751
- 表单域的控件不能作为印章和签名控件
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
+ 注:` 表单域的控件不能作为印章和签名控件`
8752
8767
  :type ComponentType: str
8753
- :param _ComponentName: 控件简称,不超过30个字符
8768
+ :param _ComponentName: **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
8769
+
8770
+ **在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
8771
+
8772
+ 注:`控件名可以在一个PDF中可以重复`
8773
+
8754
8774
  :type ComponentName: str
8755
- :param _ComponentRequired: 控件是否为必填项,
8756
- 默认为false-非必填
8775
+ :param _ComponentRequired: 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
8776
+ <ul><li>false(默认):可以不填写</li>
8777
+ <li>true :必须填写此填写控件</li></ul>
8778
+ 如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
8757
8779
  :type ComponentRequired: bool
8758
- :param _ComponentRecipientId: 控件关联的参与方ID,对应Recipient结构体中的RecipientId
8780
+ :param _ComponentRecipientId: **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
8759
8781
  :type ComponentRecipientId: str
8760
- :param _FileIndex: 控件所属文件的序号 (文档中文件的排列序号,从0开始)
8782
+ :param _FileIndex: <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
8761
8783
  :type FileIndex: int
8762
8784
  :param _GenerateMode: 控件生成的方式:
8763
- NORMAL - 普通控件
8764
- FIELD - 表单域
8765
- 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>
8766
8788
  :type GenerateMode: str
8767
- :param _ComponentWidth: 参数控件宽度,默认100,单位px
8768
- 表单域和关键字转换控件不用填
8789
+ :param _ComponentWidth: **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
8790
+
8769
8791
  :type ComponentWidth: float
8770
- :param _ComponentHeight: 参数控件高度,默认100,单位px
8771
- 表单域和关键字转换控件不用填
8792
+ :param _ComponentHeight: **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
8793
+
8772
8794
  :type ComponentHeight: float
8773
- :param _ComponentPage: 参数控件所在页码,从1开始
8795
+ :param _ComponentPage: **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
8796
+
8797
+ 注:
8798
+ 1. 页码编号是从<font color="red">1</font>开始编号的。
8799
+ 2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
8774
8800
  :type ComponentPage: int
8775
- :param _ComponentPosX: 参数控件X位置,单位px
8801
+ :param _ComponentPosX: **在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
8776
8802
  :type ComponentPosX: float
8777
- :param _ComponentPosY: 参数控件Y位置,单位px
8803
+ :param _ComponentPosY: **在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
8778
8804
  :type ComponentPosY: float
8779
- :param _ComponentExtra: 扩展参数:
8780
- 为JSON格式。
8781
- 不同类型的控件会有部分非通用参数
8782
-
8783
- ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
8784
- 1 Font:目前只支持黑体、宋体
8785
- 2 FontSize: 范围12-72
8786
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
8787
- 4 FontColor:字符串类型,格式为RGB颜色数字
8788
- 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
8789
-
8790
- ComponentType为FILL_IMAGE时,支持以下参数:
8791
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
8792
- FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
8793
-
8794
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
8795
- {“ComponentTypeLimit”: [“xxx”]}
8796
- xxx可以为:
8797
- HANDWRITE – 手写签名
8798
- OCR_ESIGN -- AI智能识别手写签名
8799
- ESIGN -- 个人印章类型
8800
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
8801
- 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
8802
-
8803
- ComponentType为SIGN_DATE时,支持以下参数:
8804
- 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
8805
- 2 FontSize: 数字类型,范围6-72,默认值为12
8806
- 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
8807
- 4 Format: 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
8808
- 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>
8809
8834
  如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
8810
8835
  特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
8811
- 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
8812
-
8813
- ComponentType为SIGN_SEAL类型时,支持以下参数:
8814
- 1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
8815
- 参数样例: "ComponentExtra":"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"
8816
- :type ComponentExtra: str
8817
- :param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
8818
- TEXT - 文本内容
8819
- MULTI_LINE_TEXT - 文本内容
8820
- CHECK_BOX - true/false
8821
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
8822
- SELECTOR - 选项值
8823
- DATE - 默认是格式化为xxxx年xx月xx日
8824
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
8825
- SIGN_SEAL - 印章ID
8826
- SIGN_PAGING_SEAL - 可以指定印章ID
8827
-
8828
- 控件值约束说明:
8829
- 企业全称控件:
8830
- 约束:企业名称中文字符中文括号
8831
- 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
8832
-
8833
- 统一社会信用代码控件:
8834
- 检查正则表达式:/^[A-Z0-9]{1,18}$/
8835
-
8836
- 法人名称控件:
8837
- 约束:最大50个字符,2到25个汉字或者1到50个字母
8838
- 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
8839
-
8840
- 签署意见控件:
8841
- 约束:签署意见最大长度为50字符
8842
-
8843
- 签署人手机号控件:
8844
- 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
8845
-
8846
- 签署人身份证控件:
8847
- 约束:合法的身份证号码检查
8848
-
8849
- 控件名称:
8850
- 约束:控件名称最大长度为20字符
8851
-
8852
- 单行文本控件:
8853
- 约束:只允许输入中文,英文,数字,中英文标点符号
8836
+ <b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
8854
8837
 
8855
- 多行文本控件:
8856
- 约束:只允许输入中文,英文,数字,中英文标点符号
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}]}"`
8857
8841
 
8858
- 勾选框控件:
8859
- 约束:选择填字符串true,不选填字符串false
8860
8842
 
8861
- 选择器控件:
8862
- 约束:同单行文本控件约束,填写选择值中的字符串
8863
-
8864
- 数字控件:
8865
- 约束:请输入有效的数字(可带小数点)
8866
- 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
8867
-
8868
- 日期控件:
8869
- 约束:格式:yyyy年mm月dd日
8870
-
8871
- 附件控件:
8872
- 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
8873
-
8874
- 图片控件:
8875
- 约束:JPG或PNG图片,填写上传的图片资源ID
8876
-
8877
- 邮箱控件:
8878
- 约束:请输入有效的邮箱地址, w3c标准
8879
- 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
8880
- 参考:https://emailregex.com/
8881
-
8882
- 地址控件:
8883
- 同单行文本控件约束
8884
-
8885
- 省市区控件:
8886
- 同单行文本控件约束
8887
-
8888
- 性别控件:
8889
- 同单行文本控件约束,填写选择值中的字符串
8890
-
8891
- 学历控件:
8892
- 同单行文本控件约束,填写选择值中的字符串
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
+ 注: `部分特殊控件需要在控制台配置模板形式创建`
8893
8863
  :type ComponentValue: str
8894
- :param _ComponentDateFontSize: 日期签署控件的字号,默认为 12
8895
-
8896
- 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
8864
+ :param _ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
8897
8865
  :type ComponentDateFontSize: int
8898
- :param _DocumentId: 控件所属文档的Id, 模板相关接口为空值
8866
+ :param _DocumentId: <font color="red">【暂未使用】</font>控件归属的文档的ID, **发起合同时候不要填写此字段留空即可**
8899
8867
  :type DocumentId: str
8900
- :param _ComponentDescription: 控件描述,不超过30个字符
8868
+ :param _ComponentDescription: <font color="red">【暂未使用】</font>控件描述,用户自定义,不影响合同发起流程
8901
8869
  :type ComponentDescription: str
8902
- :param _OffsetX: 指定关键字时横坐标偏移量,单位pt
8870
+ :param _OffsetX: **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
8871
+ 注意: `向左调整设置为负数, 向右调整设置成正数`
8903
8872
  :type OffsetX: float
8904
- :param _OffsetY: 指定关键字时纵坐标偏移量,单位pt
8873
+ :param _OffsetY: **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
8874
+ 注意: `向上调整设置为负数, 向下调整设置成正数`
8905
8875
  :type OffsetY: float
8906
- :param _ChannelComponentId: 平台企业控件ID。
8907
- 如果不为空,属于平台企业预设控件;
8876
+ :param _ChannelComponentId: <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
8908
8877
  :type ChannelComponentId: str
8909
- :param _KeywordOrder: 指定关键字排序规则,
8910
- Positive-正序,
8911
- Reverse-倒序。
8912
- 传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
8913
- 传入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内查找内容时,查找到的最后一个关键字。
8914
8883
  :type KeywordOrder: str
8915
- :param _KeywordPage: 指定关键字页码。
8916
- 指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
8884
+ :param _KeywordPage: **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
8917
8885
  :type KeywordPage: int
8918
- :param _RelativeLocation: 关键字位置模式,
8919
- Middle-居中,
8920
- Below-正下方,
8921
- Right-正右方,
8922
- LowerRight-右上角,
8923
- 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>
8924
8892
  示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
8925
8893
  :type RelativeLocation: str
8926
- :param _KeywordIndexes: 关键字索引,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。
8927
- 示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
8894
+ :param _KeywordIndexes: **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
8895
+
8896
+ 注意:关键字索引是从0开始计数的
8928
8897
  :type KeywordIndexes: list of int
8929
- :param _Placeholder: 填写提示的内容
8898
+ :param _Placeholder: 填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。
8899
+ 注:`签署控件设置此字段无效`
8930
8900
  注意:此字段可能返回 null,表示取不到有效值。
8931
8901
  :type Placeholder: str
8932
- :param _LockComponentValue: 是否锁定控件值不允许编辑(嵌入式发起使用) <br/>默认false:不锁定控件值,允许在页面编辑控件值
8902
+ :param _LockComponentValue: **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
8903
+ <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
8904
+ <li>true:锁定控件值,在页面编辑控件值</li></ul>
8933
8905
  注意:此字段可能返回 null,表示取不到有效值。
8934
8906
  :type LockComponentValue: bool
8935
- :param _ForbidMoveAndDelete: 是否禁止移动和删除控件 <br/>默认false,不禁止移动和删除控件
8907
+ :param _ForbidMoveAndDelete: **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
8908
+ <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
8909
+ <li> <b>true</b> : 可以移动和删除控件</li></ul>
8936
8910
  注意:此字段可能返回 null,表示取不到有效值。
8937
8911
  :type ForbidMoveAndDelete: bool
8938
8912
  """
@@ -9565,17 +9539,25 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
9565
9539
  此接口下面信息必填。
9566
9540
  <ul>
9567
9541
  <li>渠道应用标识: Agent.AppId</li>
9568
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
9569
- <li>第三方平台子客企业中的员工标识: Agent.ProxyOrganizationOpenId</li>
9542
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
9543
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
9570
9544
  </ul>
9545
+ 第三方平台子客企业和员工必须已经过实名认证
9571
9546
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
9572
9547
  :param _ChangeType: 企业信息变更类型,可选类型如下:
9573
9548
  <ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
9574
9549
  <li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
9575
9550
  :type ChangeType: int
9551
+ :param _Endpoint: 变更链接类型:
9552
+ <ul>
9553
+ <li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>
9554
+ <li>**APP** : 创建变更小程序链接,可从第三方App或者小程序跳转到微信腾讯电子签小程序进行更换。</li>
9555
+ </ul>
9556
+ :type Endpoint: str
9576
9557
  """
9577
9558
  self._Agent = None
9578
9559
  self._ChangeType = None
9560
+ self._Endpoint = None
9579
9561
 
9580
9562
  @property
9581
9563
  def Agent(self):
@@ -9593,12 +9575,21 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
9593
9575
  def ChangeType(self, ChangeType):
9594
9576
  self._ChangeType = ChangeType
9595
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
+
9596
9586
 
9597
9587
  def _deserialize(self, params):
9598
9588
  if params.get("Agent") is not None:
9599
9589
  self._Agent = Agent()
9600
9590
  self._Agent._deserialize(params.get("Agent"))
9601
9591
  self._ChangeType = params.get("ChangeType")
9592
+ self._Endpoint = params.get("Endpoint")
9602
9593
  memeber_set = set(params.keys())
9603
9594
  for name, value in vars(self).items():
9604
9595
  property_name = name[1:]
@@ -10812,7 +10803,7 @@ class CreateSignUrlsRequest(AbstractModel):
10812
10803
  <ul>
10813
10804
  <li>渠道应用标识: Agent.AppId</li>
10814
10805
  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
10815
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
10806
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
10816
10807
  </ul>
10817
10808
  第三方平台子客企业和员工必须已经过实名认证
10818
10809
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
@@ -11989,9 +11980,9 @@ class DescribeExtendedServiceAuthInfoRequest(AbstractModel):
11989
11980
  <ul>
11990
11981
  <li>渠道应用标识: Agent.AppId</li>
11991
11982
  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
11992
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
11983
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
11993
11984
  </ul>
11994
- 第三方平台子客企业和员工必须已经经过实名认证
11985
+ 第三方平台子客企业和员工必须已经过实名认证
11995
11986
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
11996
11987
  """
11997
11988
  self._Agent = None
@@ -15384,10 +15375,11 @@ class ModifyExtendedServiceRequest(AbstractModel):
15384
15375
 
15385
15376
  此接口下面信息必填。
15386
15377
  <ul>
15387
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
15388
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
15389
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
15378
+ <li>渠道应用标识: Agent.AppId</li>
15379
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
15380
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
15390
15381
  </ul>
15382
+ 第三方平台子客企业和员工必须已经过实名认证
15391
15383
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
15392
15384
  :param _ServiceType: 扩展服务类型
15393
15385
  <ul>
@@ -15787,7 +15779,7 @@ class OperateChannelTemplateRequest(AbstractModel):
15787
15779
 
15788
15780
  此接口下面信息必填。
15789
15781
  <ul>
15790
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
15782
+ <li>渠道应用标识: Agent.AppId</li>
15791
15783
  </ul>
15792
15784
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
15793
15785
  :param _OperateType: 操作类型,可取值如下:
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 1.1
2
2
  Name: tencentcloud-sdk-python-essbasic
3
- Version: 3.0.1065
3
+ Version: 3.0.1075
4
4
  Summary: Tencent Cloud Essbasic SDK for Python
5
5
  Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
6
6
  Author: Tencent Cloud
@@ -0,0 +1 @@
1
+ tencentcloud-sdk-python-common==3.0.1075
@@ -1 +0,0 @@
1
- tencentcloud-sdk-python-common==3.0.1065