tencentcloud-sdk-python-essbasic 3.0.965__py2.py3-none-any.whl → 3.0.977__py2.py3-none-any.whl

tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.965'
+__version__ = '3.0.977'

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -393,6 +393,11 @@ class EssbasicClient(AbstractClient):
         - B端企业的签署方式是静默签署
         - B端企业是非首位签署
 
+        通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+        ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
+
+        用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](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)
+
         :param request: Request instance for ChannelCreateMultiFlowSignQRCode.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateMultiFlowSignQRCodeRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateMultiFlowSignQRCodeResponse`
@@ -986,6 +991,13 @@ class EssbasicClient(AbstractClient):
         其中小程序的原始Id，请联系<对接技术人员>获取，或者查看小程序信息自助获取。
         使用CreateSignUrls，设置EndPoint为APP，得到path。
 
+        其中小程序的原始Id如下，或者查看小程序信息自助获取。
+
+        | 小程序 | AppID | 原始ID |
+        | ------------ | ------------ | ------------ |
+        | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
+        | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
+
         :param request: Request instance for CreateSignUrls.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateSignUrlsRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateSignUrlsResponse`

tencentcloud/essbasic/v20210526/models.py

@@ -429,6 +429,8 @@ class BaseFlowInfo(AbstractModel):
 <br/>false：不开启发起方发起前审核
 <br/>当指定NeedCreateReview=true，则提交审核后，需要使用接口：ChannelCreateFlowSignReview，来完成发起前审核，审核通过后，可以继续查看，签署合同
         :type NeedCreateReview: bool
+        :param _Components: 填写控件：文件发起使用
+        :type Components: list of Component
         """
         self._FlowName = None
         self._FlowType = None
@@ -441,6 +443,7 @@ class BaseFlowInfo(AbstractModel):
         self._UserData = None
         self._CcInfos = None
         self._NeedCreateReview = None
+        self._Components = None
 
     @property
     def FlowName(self):
@@ -530,6 +533,14 @@ class BaseFlowInfo(AbstractModel):
     def NeedCreateReview(self, NeedCreateReview):
         self._NeedCreateReview = NeedCreateReview
 
+    @property
+    def Components(self):
+        return self._Components
+
+    @Components.setter
+    def Components(self, Components):
+        self._Components = Components
+
 
     def _deserialize(self, params):
         self._FlowName = params.get("FlowName")
@@ -553,6 +564,12 @@ class BaseFlowInfo(AbstractModel):
                 obj._deserialize(item)
                 self._CcInfos.append(obj)
         self._NeedCreateReview = params.get("NeedCreateReview")
+        if params.get("Components") is not None:
+            self._Components = []
+            for item in params.get("Components"):
+                obj = Component()
+                obj._deserialize(item)
+                self._Components.append(obj)
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -2589,9 +2606,9 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
         :param _Restrictions: 指定的签署二维码签署人
 <br/>指定后，只允许知道的人操作和签署
         :type Restrictions: list of ApproverRestriction
-        :param _CallbackUrl: 回调地址，最大长度1000个字符
-不传默认使用第三方应用号配置的回调地址
-回调时机:用户通过签署二维码发起合同时，企业额度不足导致失败
+        :param _CallbackUrl: 已废弃，回调配置统一使用企业应用管理-应用集成-第三方应用中的配置
+<br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/partner/callback_types_contracts_sign
+<br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
         :type CallbackUrl: str
         :param _ApproverRestrictions: 限制二维码用户条件（已弃用）
         :type ApproverRestrictions: :class:`tencentcloud.essbasic.v20210526.models.ApproverRestriction`
@@ -2667,10 +2684,14 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
 
     @property
     def CallbackUrl(self):
+        warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning) 
+
         return self._CallbackUrl
 
     @CallbackUrl.setter
     def CallbackUrl(self, CallbackUrl):
+        warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning) 
+
         self._CallbackUrl = CallbackUrl
 
     @property
@@ -2876,7 +2897,7 @@ class ChannelCreatePrepareFlowRequest(AbstractModel):
         r"""
         :param _ResourceId: 资源id，与ResourceType对应
         :type ResourceId: str
-        :param _ResourceType: 资源类型，1：模板，目前仅支持模板，与ResourceId对应
+        :param _ResourceType: 资源类型，与ResourceId对应1：模板   2: 文件
         :type ResourceType: int
         :param _FlowInfo: 合同流程基础信息
         :type FlowInfo: :class:`tencentcloud.essbasic.v20210526.models.BaseFlowInfo`
@@ -5667,6 +5688,8 @@ class CommonFlowApprover(AbstractModel):
         :type NotifyType: str
         :param _ApproverOption: 签署人配置
         :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.CommonApproverOption`
+        :param _SignComponents: 签署控件：文件发起使用
+        :type SignComponents: list of Component
         """
         self._NotChannelOrganization = None
         self._ApproverType = None
@@ -5682,6 +5705,7 @@ class CommonFlowApprover(AbstractModel):
         self._IsFullText = None
         self._NotifyType = None
         self._ApproverOption = None
+        self._SignComponents = None
 
     @property
     def NotChannelOrganization(self):
@@ -5799,6 +5823,14 @@ class CommonFlowApprover(AbstractModel):
     def ApproverOption(self, ApproverOption):
         self._ApproverOption = ApproverOption
 
+    @property
+    def SignComponents(self):
+        return self._SignComponents
+
+    @SignComponents.setter
+    def SignComponents(self, SignComponents):
+        self._SignComponents = SignComponents
+
 
     def _deserialize(self, params):
         self._NotChannelOrganization = params.get("NotChannelOrganization")
@@ -5817,6 +5849,12 @@ class CommonFlowApprover(AbstractModel):
         if params.get("ApproverOption") is not None:
             self._ApproverOption = CommonApproverOption()
             self._ApproverOption._deserialize(params.get("ApproverOption"))
+        if params.get("SignComponents") is not None:
+            self._SignComponents = []
+            for item in params.get("SignComponents"):
+                obj = Component()
+                obj._deserialize(item)
+                self._SignComponents.append(obj)
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -7124,24 +7162,31 @@ class CreateSignUrlsRequest(AbstractModel):
         r"""
         :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
         :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
-        :param _FlowIds: 签署流程编号数组，最多支持100个。(备注：该参数和合同组编号必须二选一)
+        :param _FlowIds: 流程(合同)的编号列表，最多支持100个。(备注：该参数和合同组编号必须二选一)
         :type FlowIds: list of str
         :param _FlowGroupId: 合同组编号(备注：该参数和合同(流程)编号数组必须二选一)
         :type FlowGroupId: str
-        :param _Endpoint: 签署链接类型：“WEIXINAPP”-短链直接跳小程序；“CHANNEL”-跳转H5页面；“APP”-第三方APP或小程序跳转电子签小程序；"LONGURL2WEIXINAPP"-长链接跳转小程序；默认“WEIXINAPP”类型，即跳转至小程序；
+        :param _Endpoint: 签署链接类型,可以设置的参数如下
+
+- WEIXINAPP:短链直接跳小程序 (默认类型)
+- CHANNEL:跳转H5页面
+- APP:第三方APP或小程序跳转电子签小程序
+- LONGURL2WEIXINAPP:长链接跳转小程序
         :type Endpoint: str
-        :param _GenerateType: 签署链接生成类型，默认是 "ALL"；
-"ALL"：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接；
-"CHANNEL"：第三方平台子客企业企业；
-"NOT_CHANNEL"：非第三方平台子客企业企业；
-"PERSON"：个人；
-"FOLLOWER"：关注方，目前是合同抄送方；
+        :param _GenerateType: 签署链接生成类型，可以选择的类型如下
+
+- ALL：全部签署方签署链接，此时不会给自动签署的签署方创建签署链接(默认类型)
+- CHANNEL：第三方平台子客企业企业
+- NOT_CHANNEL：非第三方平台子客企业企业
+- PERSON：个人
+- FOLLOWER：关注方，目前是合同抄送方
         :type GenerateType: str
         :param _OrganizationName: 非第三方平台子客企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
         :type OrganizationName: str
-        :param _Name: 参与人姓名，GenerateType为"PERSON"时必填
+        :param _Name: 参与人姓名
+GenerateType为"PERSON"(即个人签署方)时必填
         :type Name: str
-        :param _Mobile: 参与人手机号；
+        :param _Mobile: 参与人手机号
 GenerateType为"PERSON"或"FOLLOWER"时必填
         :type Mobile: str
         :param _OrganizationOpenId: 第三方平台子客企业的企业OpenId，GenerateType为"CHANNEL"时必填
@@ -7156,10 +7201,10 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
         :param _Hides: 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
 
-0:合同签署页面更多操作按钮
-1:合同签署页面更多操作的拒绝签署按钮
-2:合同签署页面更多操作的转他人处理按钮
-3:签署成功页的查看详情按钮
+- 0:合同签署页面更多操作按钮
+- 1:合同签署页面更多操作的拒绝签署按钮
+- 2:合同签署页面更多操作的转他人处理按钮
+- 3:签署成功页的查看详情按钮
         :type Hides: list of int
         """
         self._Agent = None
@@ -8834,7 +8879,7 @@ class FlowApproverInfo(AbstractModel):
     4-非第三方平台子客企业：Name、Mobile必传，OrgName必传，且NotChannelOrganization=True。
 
     RecipientId参数：
-    从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId
+    从DescribeTemplates接口中，可以得到模板下的签署方Recipient列表，根据模板自定义的Rolename在此结构体中确定其RecipientId。
 
     """
 
@@ -11894,7 +11939,7 @@ class SignUrlInfo(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _SignUrl: 签署链接，过期时间为30天
+        :param _SignUrl: 签署链接，过期时间为90天
 注意：此字段可能返回 null，表示取不到有效值。
         :type SignUrl: str
         :param _Deadline: 合同过期时间戳，单位秒

{tencentcloud_sdk_python_essbasic-3.0.965.dist-info → tencentcloud_sdk_python_essbasic-3.0.977.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.965
+Version: 3.0.977
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 2.7
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.6
 Classifier: Programming Language :: Python :: 3.7
-Requires-Dist: tencentcloud-sdk-python-common (==3.0.965)
+Requires-Dist: tencentcloud-sdk-python-common (==3.0.977)
 
 ============================
 Tencent Cloud SDK for Python

{tencentcloud_sdk_python_essbasic-3.0.965.dist-info → tencentcloud_sdk_python_essbasic-3.0.977.dist-info}/RECORD

@@ -1,4 +1,4 @@
-tencentcloud/__init__.py,sha256=mIvqII2tuwyaq0i1KI_Cp498vSvtDE3fO691q9x3acQ,630
+tencentcloud/__init__.py,sha256=0uUHDJR6CGYoWWxK6We6LBdwdNT-8vocz9d55Wvm_6E,630
 tencentcloud/essbasic/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20201222/errorcodes.py,sha256=cZPs0vLmArRFQoZqxM4alb0WeBF9f0V0IHmt65dUdxs,5392
@@ -6,9 +6,9 @@ tencentcloud/essbasic/v20201222/essbasic_client.py,sha256=kua9joup-BLKbyITYpVovM
 tencentcloud/essbasic/v20201222/models.py,sha256=Q2E6jmVT1emRziwRN-qj8XpdzpxvqqHTKOEQz8JaM_s,270905
 tencentcloud/essbasic/v20210526/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 tencentcloud/essbasic/v20210526/errorcodes.py,sha256=KK7N259j7gk-2_DQ93PA68N6PqDEOgL_j5yGX1uiCyk,17658
-tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=9osZbsCh44hQqztZnm9vOD_vvXh2WCfgRyURKFl05LQ,64119
-tencentcloud/essbasic/v20210526/models.py,sha256=5vI-5-cCD62s_UYbkJSEXGAP-5rAt0ZisOtJ5W6HQCo,429871
-tencentcloud_sdk_python_essbasic-3.0.965.dist-info/METADATA,sha256=btBD23OzUPNoj0QD3l96C7dq2e1yJA5kXCiCEXj4pq0,1515
-tencentcloud_sdk_python_essbasic-3.0.965.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
-tencentcloud_sdk_python_essbasic-3.0.965.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
-tencentcloud_sdk_python_essbasic-3.0.965.dist-info/RECORD,,
+tencentcloud/essbasic/v20210526/essbasic_client.py,sha256=Gxk3JB2ZJfM1hY_5f3rQN3-SPbM77m0WHXUYQvr2coU,64999
+tencentcloud/essbasic/v20210526/models.py,sha256=BK_LS-cRtvCL1on63PEbWysXeHIuTf7zbDs1zXqKXYs,431564
+tencentcloud_sdk_python_essbasic-3.0.977.dist-info/METADATA,sha256=zdr1W2Sb1eySo_HcwRLtnbvi9HT3ZNU7mk3nrVmpZFI,1515
+tencentcloud_sdk_python_essbasic-3.0.977.dist-info/WHEEL,sha256=z9j0xAa_JmUKMpmz72K0ZGALSM_n-wQVmGbleXx2VHg,110
+tencentcloud_sdk_python_essbasic-3.0.977.dist-info/top_level.txt,sha256=g-8OyzoqI6O6LiS85zkeNzhB-osEnRIPZMdyRd_0eL0,13
+tencentcloud_sdk_python_essbasic-3.0.977.dist-info/RECORD,,