tencentcloud-sdk-python-essbasic 3.0.1333__tar.gz → 3.0.1338__tar.gz

{tencentcloud-sdk-python-essbasic-3.0.1333 → tencentcloud-sdk-python-essbasic-3.0.1338}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1333
+Version: 3.0.1338
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

{tencentcloud-sdk-python-essbasic-3.0.1333 → tencentcloud-sdk-python-essbasic-3.0.1338}/setup.py

@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
 
 setup(
     name='tencentcloud-sdk-python-essbasic',
-    install_requires=["tencentcloud-sdk-python-common==3.0.1333"],
+    install_requires=["tencentcloud-sdk-python-common==3.0.1338"],
     version=tencentcloud.__version__,
     description='Tencent Cloud Essbasic SDK for Python',
     long_description=open('README.rst').read(),

{tencentcloud-sdk-python-essbasic-3.0.1333 → tencentcloud-sdk-python-essbasic-3.0.1338}/tencentcloud/__init__.py

@@ -14,4 +14,4 @@
 # limitations under the License.
 
 
-__version__ = '3.0.1333'
+__version__ = '3.0.1338'

{tencentcloud-sdk-python-essbasic-3.0.1333 → tencentcloud-sdk-python-essbasic-3.0.1338}/tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -785,10 +785,11 @@ class EssbasicClient(AbstractClient):
         签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
         **注意**:
-        1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**,  若是B2C模板,还要满足以下任意一个条件
-            - 模板中配置的签署顺序是无序
-            - B端企业的签署方式是静默签署
-            - B端企业是非首位签署
+        1.满足以下条件的模板支持创建签署码：
+         - 签署对象：企业与个人（无序签署）、企业与个人（顺序签署&企业非首位）、 仅个人签署。
+         - 其发起方没有填写控件,签署方（B端或C端）可以有填写控件。
+         - 如签署对象中含企业方，企业方签署区只能由发起方企业签署。
+
         2. 通过扫描一码多签签署码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
         ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
         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)
@@ -2771,6 +2772,33 @@ class EssbasicClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def DescribeUserFlowType(self, request):
+        """查询用户模版类型，分为两种模式：
+        <ul>
+        <li>QueryBindTemplate:false，查询用户合同模版类型，返回用户合同模版类型ID，用户合同模版类型名称，用户合同模版类型描述信息</li>
+        <li>QueryBindTemplate:false，查询用户合同模版类型，返回用户合同模版类型ID，用户合同模版类型名称，用户合同模版类型描述信息，被绑定的模版数量</li>
+        </ul>
+
+        :param request: Request instance for DescribeUserFlowType.
+        :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeUserFlowTypeRequest`
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeUserFlowTypeResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("DescribeUserFlowType", params, headers=headers)
+            response = json.loads(body)
+            model = models.DescribeUserFlowTypeResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def GetDownloadFlowUrl(self, request):
         """此接口（GetDownloadFlowUrl）用户获取合同控制台下载页面链接,  点击链接后会跳转至本企业合同管理控制台(会筛选出传入的合同列表), 点击**下载**按钮后就会下载传入的合同列表, 下载页面如下图
         ![image](https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl.png)

{tencentcloud-sdk-python-essbasic-3.0.1333 → tencentcloud-sdk-python-essbasic-3.0.1338}/tencentcloud/essbasic/v20210526/models.py

@@ -4301,7 +4301,10 @@ MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverM
         :param _SignBeanTag: 签署方签署控件（印章/签名等）的生成方式：
 <ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
 <li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
-**注**: `发起后添加控件功能不支持添加签批控件`
+
+**注**: 
+1.发起后添加控件功能不支持添加签批控件 
+2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5
         :type SignBeanTag: int
         :param _CcInfos: 合同流程的抄送人列表，最多可支持50个抄送人，抄送人可查看合同内容及签署进度，但无需参与合同签署。
 
@@ -4571,7 +4574,10 @@ MobileCheck：手机号验证，用户手机号和参与方手机号（ApproverM
         """签署方签署控件（印章/签名等）的生成方式：
 <ul><li> **0**：在合同流程发起时，由发起人指定签署方的签署控件的位置和数量。</li>
 <li> **1**：签署方在签署时自行添加签署控件，可以拖动位置和控制数量。</li></ul>
-**注**: `发起后添加控件功能不支持添加签批控件`
+
+**注**: 
+1.发起后添加控件功能不支持添加签批控件 
+2.签署方在签署时自行添加签署控件仅支持电子签小程序或web控制台签署，不支持H5
         :rtype: int
         """
         return self._SignBeanTag
@@ -19368,6 +19374,8 @@ class DescribeTemplatesRequest(AbstractModel):
         :type WithPdfUrl: bool
         :param _Operator: 操作者的信息
         :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
+        :param _UserFlowTypeId: 用户合同类型id
+        :type UserFlowTypeId: str
         """
         self._Agent = None
         self._TemplateId = None
@@ -19381,6 +19389,7 @@ class DescribeTemplatesRequest(AbstractModel):
         self._WithPreviewUrl = None
         self._WithPdfUrl = None
         self._Operator = None
+        self._UserFlowTypeId = None
 
     @property
     def Agent(self):
@@ -19563,6 +19572,17 @@ class DescribeTemplatesRequest(AbstractModel):
 
         self._Operator = Operator
 
+    @property
+    def UserFlowTypeId(self):
+        """用户合同类型id
+        :rtype: str
+        """
+        return self._UserFlowTypeId
+
+    @UserFlowTypeId.setter
+    def UserFlowTypeId(self, UserFlowTypeId):
+        self._UserFlowTypeId = UserFlowTypeId
+
 
     def _deserialize(self, params):
         if params.get("Agent") is not None:
@@ -19581,6 +19601,7 @@ class DescribeTemplatesRequest(AbstractModel):
         if params.get("Operator") is not None:
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
+        self._UserFlowTypeId = params.get("UserFlowTypeId")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -19913,6 +19934,135 @@ class DescribeUsageResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class DescribeUserFlowTypeRequest(AbstractModel):
+    """DescribeUserFlowType请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证	
+        :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
+        :param _Filters: 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。 <ul><li><strong>模板的用户合同类型</strong>：<strong>Key</strong>设置为 <code>user-flow-type-id</code> ，<strong>Values</strong>为您想要查询的用户模版类型id列表。</li></ul>	
+        :type Filters: list of Filter
+        :param _QueryBindTemplate: 查询绑定了模版的用户合同类型
+<ul>
+<li>false（默认值），查询用户合同类型</li>
+<li>true，查询绑定了模版的用户合同类型</li>
+</ul>
+        :type QueryBindTemplate: bool
+        """
+        self._Agent = None
+        self._Filters = None
+        self._QueryBindTemplate = None
+
+    @property
+    def Agent(self):
+        """关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。 此接口下面信息必填。 <ul> <li>渠道应用标识: Agent.AppId</li> <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li> <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li> </ul> 第三方平台子客企业和员工必须已经经过实名认证	
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.Agent`
+        """
+        return self._Agent
+
+    @Agent.setter
+    def Agent(self, Agent):
+        self._Agent = Agent
+
+    @property
+    def Filters(self):
+        """搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。 <ul><li><strong>模板的用户合同类型</strong>：<strong>Key</strong>设置为 <code>user-flow-type-id</code> ，<strong>Values</strong>为您想要查询的用户模版类型id列表。</li></ul>	
+        :rtype: list of Filter
+        """
+        return self._Filters
+
+    @Filters.setter
+    def Filters(self, Filters):
+        self._Filters = Filters
+
+    @property
+    def QueryBindTemplate(self):
+        """查询绑定了模版的用户合同类型
+<ul>
+<li>false（默认值），查询用户合同类型</li>
+<li>true，查询绑定了模版的用户合同类型</li>
+</ul>
+        :rtype: bool
+        """
+        return self._QueryBindTemplate
+
+    @QueryBindTemplate.setter
+    def QueryBindTemplate(self, QueryBindTemplate):
+        self._QueryBindTemplate = QueryBindTemplate
+
+
+    def _deserialize(self, params):
+        if params.get("Agent") is not None:
+            self._Agent = Agent()
+            self._Agent._deserialize(params.get("Agent"))
+        if params.get("Filters") is not None:
+            self._Filters = []
+            for item in params.get("Filters"):
+                obj = Filter()
+                obj._deserialize(item)
+                self._Filters.append(obj)
+        self._QueryBindTemplate = params.get("QueryBindTemplate")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class DescribeUserFlowTypeResponse(AbstractModel):
+    """DescribeUserFlowType返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _AllUserFlowTypes: 查询到的所有用户合同类型列表
+        :type AllUserFlowTypes: list of TemplateUserFlowType
+        :param _RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._AllUserFlowTypes = None
+        self._RequestId = None
+
+    @property
+    def AllUserFlowTypes(self):
+        """查询到的所有用户合同类型列表
+        :rtype: list of TemplateUserFlowType
+        """
+        return self._AllUserFlowTypes
+
+    @AllUserFlowTypes.setter
+    def AllUserFlowTypes(self, AllUserFlowTypes):
+        self._AllUserFlowTypes = AllUserFlowTypes
+
+    @property
+    def RequestId(self):
+        """唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        :rtype: str
+        """
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        if params.get("AllUserFlowTypes") is not None:
+            self._AllUserFlowTypes = []
+            for item in params.get("AllUserFlowTypes"):
+                obj = TemplateUserFlowType()
+                obj._deserialize(item)
+                self._AllUserFlowTypes.append(obj)
+        self._RequestId = params.get("RequestId")
+
+
 class DetectInfoVideoData(AbstractModel):
     """视频认证结果
 
@@ -28858,6 +29008,8 @@ class TemplateInfo(AbstractModel):
 <ul><li>1：启用（默认），表示模板处于启用状态，可以被用户正常使用。</li>
 <li>2：停用，表示模板处于停用状态，禁止用户使用该模板。</li></ul>
         :type Available: int
+        :param _UserFlowType: 模版的用户合同类型
+        :type UserFlowType: :class:`tencentcloud.essbasic.v20210526.models.UserFlowType`
         """
         self._TemplateId = None
         self._TemplateName = None
@@ -28876,6 +29028,7 @@ class TemplateInfo(AbstractModel):
         self._ChannelAutoSave = None
         self._TemplateVersion = None
         self._Available = None
+        self._UserFlowType = None
 
     @property
     def TemplateId(self):
@@ -29089,6 +29242,17 @@ class TemplateInfo(AbstractModel):
     def Available(self, Available):
         self._Available = Available
 
+    @property
+    def UserFlowType(self):
+        """模版的用户合同类型
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.UserFlowType`
+        """
+        return self._UserFlowType
+
+    @UserFlowType.setter
+    def UserFlowType(self, UserFlowType):
+        self._UserFlowType = UserFlowType
+
 
     def _deserialize(self, params):
         self._TemplateId = params.get("TemplateId")
@@ -29123,6 +29287,90 @@ class TemplateInfo(AbstractModel):
         self._ChannelAutoSave = params.get("ChannelAutoSave")
         self._TemplateVersion = params.get("TemplateVersion")
         self._Available = params.get("Available")
+        if params.get("UserFlowType") is not None:
+            self._UserFlowType = UserFlowType()
+            self._UserFlowType._deserialize(params.get("UserFlowType"))
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
+class TemplateUserFlowType(AbstractModel):
+    """模版对应的合同类型
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _UserFlowTypeId: 合同类型id
+        :type UserFlowTypeId: str
+        :param _Name: 用户合同类型名称
+        :type Name: str
+        :param _TemplateNum: 每个合同类型绑定的模版数量	
+        :type TemplateNum: int
+        :param _Description: 合同类型的具体描述
+        :type Description: str
+        """
+        self._UserFlowTypeId = None
+        self._Name = None
+        self._TemplateNum = None
+        self._Description = None
+
+    @property
+    def UserFlowTypeId(self):
+        """合同类型id
+        :rtype: str
+        """
+        return self._UserFlowTypeId
+
+    @UserFlowTypeId.setter
+    def UserFlowTypeId(self, UserFlowTypeId):
+        self._UserFlowTypeId = UserFlowTypeId
+
+    @property
+    def Name(self):
+        """用户合同类型名称
+        :rtype: str
+        """
+        return self._Name
+
+    @Name.setter
+    def Name(self, Name):
+        self._Name = Name
+
+    @property
+    def TemplateNum(self):
+        """每个合同类型绑定的模版数量	
+        :rtype: int
+        """
+        return self._TemplateNum
+
+    @TemplateNum.setter
+    def TemplateNum(self, TemplateNum):
+        self._TemplateNum = TemplateNum
+
+    @property
+    def Description(self):
+        """合同类型的具体描述
+        :rtype: str
+        """
+        return self._Description
+
+    @Description.setter
+    def Description(self, Description):
+        self._Description = Description
+
+
+    def _deserialize(self, params):
+        self._UserFlowTypeId = params.get("UserFlowTypeId")
+        self._Name = params.get("Name")
+        self._TemplateNum = params.get("TemplateNum")
+        self._Description = params.get("Description")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -29498,6 +29746,72 @@ class UsageDetail(AbstractModel):
         
 
 
+class UserFlowType(AbstractModel):
+    """用户合同类型信息
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _UserFlowTypeId: 用户合同类型id
+        :type UserFlowTypeId: str
+        :param _Name: 用户合同类型名称
+        :type Name: str
+        :param _Description: 用户合同类型的描述信息
+        :type Description: str
+        """
+        self._UserFlowTypeId = None
+        self._Name = None
+        self._Description = None
+
+    @property
+    def UserFlowTypeId(self):
+        """用户合同类型id
+        :rtype: str
+        """
+        return self._UserFlowTypeId
+
+    @UserFlowTypeId.setter
+    def UserFlowTypeId(self, UserFlowTypeId):
+        self._UserFlowTypeId = UserFlowTypeId
+
+    @property
+    def Name(self):
+        """用户合同类型名称
+        :rtype: str
+        """
+        return self._Name
+
+    @Name.setter
+    def Name(self, Name):
+        self._Name = Name
+
+    @property
+    def Description(self):
+        """用户合同类型的描述信息
+        :rtype: str
+        """
+        return self._Description
+
+    @Description.setter
+    def Description(self, Description):
+        self._Description = Description
+
+
+    def _deserialize(self, params):
+        self._UserFlowTypeId = params.get("UserFlowTypeId")
+        self._Name = params.get("Name")
+        self._Description = params.get("Description")
+        memeber_set = set(params.keys())
+        for name, value in vars(self).items():
+            property_name = name[1:]
+            if property_name in memeber_set:
+                memeber_set.remove(property_name)
+        if len(memeber_set) > 0:
+            warnings.warn("%s fileds are useless." % ",".join(memeber_set))
+        
+
+
 class UserInfo(AbstractModel):
     """接口调用的员工信息
 

{tencentcloud-sdk-python-essbasic-3.0.1333 → tencentcloud-sdk-python-essbasic-3.0.1338}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.2
 Name: tencentcloud-sdk-python-essbasic
-Version: 3.0.1333
+Version: 3.0.1338
 Summary: Tencent Cloud Essbasic SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python
 Author: Tencent Cloud

tencentcloud-sdk-python-essbasic-3.0.1338/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

@@ -0,0 +1 @@
+tencentcloud-sdk-python-common==3.0.1338

tencentcloud-sdk-python-essbasic-3.0.1333/tencentcloud_sdk_python_essbasic.egg-info/requires.txt

@@ -1 +0,0 @@
-tencentcloud-sdk-python-common==3.0.1333