tencentcloud-sdk-python 3.0.1081__py2.py3-none-any.whl → 3.0.1083__py2.py3-none-any.whl

tencentcloud/ess/v20201111/models.py

@@ -319,6 +319,10 @@ class ApproverInfo(AbstractModel):
         :type AddSignComponentsLimits: list of ComponentLimit
         :param _SignInstructionContent: 签署须知：支持传入富文本，最长字数：500个中文字符
         :type SignInstructionContent: str
+        :param _Deadline: 签署人的签署截止时间，格式为Unix标准时间戳（秒）
+
+注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
+        :type Deadline: int
         """
         self._ApproverType = None
         self._ApproverName = None
@@ -341,6 +345,7 @@ class ApproverInfo(AbstractModel):
         self._ApproverNeedSignReview = None
         self._AddSignComponentsLimits = None
         self._SignInstructionContent = None
+        self._Deadline = None
 
     @property
     def ApproverType(self):
@@ -510,6 +515,14 @@ class ApproverInfo(AbstractModel):
     def SignInstructionContent(self, SignInstructionContent):
         self._SignInstructionContent = SignInstructionContent
 
+    @property
+    def Deadline(self):
+        return self._Deadline
+
+    @Deadline.setter
+    def Deadline(self, Deadline):
+        self._Deadline = Deadline
+
 
     def _deserialize(self, params):
         self._ApproverType = params.get("ApproverType")
@@ -545,6 +558,7 @@ class ApproverInfo(AbstractModel):
                 obj._deserialize(item)
                 self._AddSignComponentsLimits.append(obj)
         self._SignInstructionContent = params.get("SignInstructionContent")
+        self._Deadline = params.get("Deadline")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -3167,12 +3181,13 @@ class CreateDocumentRequest(AbstractModel):
         r"""
         :param _Operator: 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
+
+[点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/253071cc2f7becb063c7cf71b37b7861.png)
+        :type TemplateId: str
         :param _FlowId: 合同流程ID，为32位字符串。
 此接口的合同流程ID需要由[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)接口创建得到。
         :type FlowId: str
-        :param _TemplateId: 用户配置的合同模板ID，会基于此模板创建合同文档，为32位字符串。
-可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
-        :type TemplateId: str
         :param _FileNames: 文件名列表，单个文件名最大长度200个字符，暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
         :type FileNames: list of str
         :param _FormFields: 电子文档的填写控件的填充内容。具体方式可以参考[FormField](https://qian.tencent.com/developers/companyApis/dataTypes/#formfield)结构体的定义。
@@ -3201,8 +3216,8 @@ class CreateDocumentRequest(AbstractModel):
         :type ClientToken: str
         """
         self._Operator = None
-        self._FlowId = None
         self._TemplateId = None
+        self._FlowId = None
         self._FileNames = None
         self._FormFields = None
         self._NeedPreview = None
@@ -3218,14 +3233,6 @@ class CreateDocumentRequest(AbstractModel):
     def Operator(self, Operator):
         self._Operator = Operator
 
-    @property
-    def FlowId(self):
-        return self._FlowId
-
-    @FlowId.setter
-    def FlowId(self, FlowId):
-        self._FlowId = FlowId
-
     @property
     def TemplateId(self):
         return self._TemplateId
@@ -3234,6 +3241,14 @@ class CreateDocumentRequest(AbstractModel):
     def TemplateId(self, TemplateId):
         self._TemplateId = TemplateId
 
+    @property
+    def FlowId(self):
+        return self._FlowId
+
+    @FlowId.setter
+    def FlowId(self, FlowId):
+        self._FlowId = FlowId
+
     @property
     def FileNames(self):
         return self._FileNames
@@ -3287,8 +3302,8 @@ class CreateDocumentRequest(AbstractModel):
         if params.get("Operator") is not None:
             self._Operator = UserInfo()
             self._Operator._deserialize(params.get("Operator"))
-        self._FlowId = params.get("FlowId")
         self._TemplateId = params.get("TemplateId")
+        self._FlowId = params.get("FlowId")
         self._FileNames = params.get("FileNames")
         if params.get("FormFields") is not None:
             self._FormFields = []
@@ -4186,9 +4201,10 @@ class CreateFlowByFilesResponse(AbstractModel):
         r"""
         :param _FlowId: 合同流程ID，为32位字符串。
 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
-可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
 
 注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
+
+[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         :type FlowId: str
         :param _PreviewUrl: 合同预览链接URL。
 
@@ -5383,7 +5399,7 @@ class CreateFlowResponse(AbstractModel):
 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
 
 注:
-此返回的合同流程ID，需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后，合同才能进入签署环节
+此返回的合同流程ID，需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后，合同才能进入签署环节，[点击产看FlowId在控制台中的位置（只在进如签署环节后有效）](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
 
 
         :type FlowId: str
@@ -10455,6 +10471,8 @@ class DescribeFlowBriefsRequest(AbstractModel):
 如果某个合同流程ID不存在，系统会跳过此ID的查询，继续查询剩余存在的合同流程。
 
 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+
+[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         :type FlowIds: list of str
         :param _Agent: 代理企业和员工的信息。
 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -10786,6 +10804,11 @@ class DescribeFlowInfoRequest(AbstractModel):
         :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
         :param _FlowIds: 需要查询的流程ID列表，最多可传入100个ID。
 如果要查询合同组的信息，则不需要传入此参数，只需传入 FlowGroupId 参数即可。
+
+
+可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
+
+[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
         :type FlowIds: list of str
         :param _Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。	
         :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
@@ -14016,6 +14039,11 @@ class FlowCreateApprover(AbstractModel):
 注：
 `不指定该值时，默认为签署方自行选择。`
         :type SignTypeSelector: int
+        :param _Deadline: Deadline
+签署人的签署截止时间，格式为Unix标准时间戳（秒）
+
+注: `若不设置此参数，则默认使用合同的截止时间，此参数暂不支持合同组子合同`
+        :type Deadline: int
         """
         self._ApproverType = None
         self._OrganizationName = None
@@ -14043,6 +14071,7 @@ class FlowCreateApprover(AbstractModel):
         self._ApproverVerifyTypes = None
         self._ApproverSignTypes = None
         self._SignTypeSelector = None
+        self._Deadline = None
 
     @property
     def ApproverType(self):
@@ -14256,6 +14285,14 @@ class FlowCreateApprover(AbstractModel):
     def SignTypeSelector(self, SignTypeSelector):
         self._SignTypeSelector = SignTypeSelector
 
+    @property
+    def Deadline(self):
+        return self._Deadline
+
+    @Deadline.setter
+    def Deadline(self, Deadline):
+        self._Deadline = Deadline
+
 
     def _deserialize(self, params):
         self._ApproverType = params.get("ApproverType")
@@ -14298,6 +14335,7 @@ class FlowCreateApprover(AbstractModel):
         self._ApproverVerifyTypes = params.get("ApproverVerifyTypes")
         self._ApproverSignTypes = params.get("ApproverSignTypes")
         self._SignTypeSelector = params.get("SignTypeSelector")
+        self._Deadline = params.get("Deadline")
         memeber_set = set(params.keys())
         for name, value in vars(self).items():
             property_name = name[1:]
@@ -16032,6 +16070,122 @@ class ModifyExtendedServiceResponse(AbstractModel):
         self._RequestId = params.get("RequestId")
 
 
+class ModifyFlowDeadlineRequest(AbstractModel):
+    """ModifyFlowDeadline请求参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _Operator: 执行本接口操作的员工信息。
+注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
+        :param _FlowId: 合同流程ID，为32位字符串。
+<ul><li>建议开发者妥善保存此流程ID，以便于顺利进行后续操作。</li>
+<li>可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。</li></ul>
+        :type FlowId: str
+        :param _Deadline: 签署流程或签署人新的签署截止时间，格式为Unix标准时间戳（秒）
+        :type Deadline: int
+        :param _Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
+        :param _RecipientId: 签署方角色编号，为32位字符串
+<ul><li>若指定了此参数，则只调整签署流程中此签署人的签署截止时间，否则调整合同整体的签署截止时间（合同截止时间+发起时未设置签署人截止时间的参与人的签署截止时间）</li>
+<li>通过[用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)发起合同，或通过[模板发起合同-创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)时，返回参数[Approvers](https://qian.tencent.com/developers/companyApis/dataTypes/#approveritem)会返回此信息，建议开发者妥善保存</li>
+<li>也可通过[查询合同流程的详情信息](https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo)接口查询签署人的RecipientId编号</li></ul>
+        :type RecipientId: str
+        """
+        self._Operator = None
+        self._FlowId = None
+        self._Deadline = None
+        self._Agent = None
+        self._RecipientId = None
+
+    @property
+    def Operator(self):
+        return self._Operator
+
+    @Operator.setter
+    def Operator(self, Operator):
+        self._Operator = Operator
+
+    @property
+    def FlowId(self):
+        return self._FlowId
+
+    @FlowId.setter
+    def FlowId(self, FlowId):
+        self._FlowId = FlowId
+
+    @property
+    def Deadline(self):
+        return self._Deadline
+
+    @Deadline.setter
+    def Deadline(self, Deadline):
+        self._Deadline = Deadline
+
+    @property
+    def Agent(self):
+        return self._Agent
+
+    @Agent.setter
+    def Agent(self, Agent):
+        self._Agent = Agent
+
+    @property
+    def RecipientId(self):
+        return self._RecipientId
+
+    @RecipientId.setter
+    def RecipientId(self, RecipientId):
+        self._RecipientId = RecipientId
+
+
+    def _deserialize(self, params):
+        if params.get("Operator") is not None:
+            self._Operator = UserInfo()
+            self._Operator._deserialize(params.get("Operator"))
+        self._FlowId = params.get("FlowId")
+        self._Deadline = params.get("Deadline")
+        if params.get("Agent") is not None:
+            self._Agent = Agent()
+            self._Agent._deserialize(params.get("Agent"))
+        self._RecipientId = params.get("RecipientId")
+        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 ModifyFlowDeadlineResponse(AbstractModel):
+    """ModifyFlowDeadline返回参数结构体
+
+    """
+
+    def __init__(self):
+        r"""
+        :param _RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        :type RequestId: str
+        """
+        self._RequestId = None
+
+    @property
+    def RequestId(self):
+        return self._RequestId
+
+    @RequestId.setter
+    def RequestId(self, RequestId):
+        self._RequestId = RequestId
+
+
+    def _deserialize(self, params):
+        self._RequestId = params.get("RequestId")
+
+
 class ModifyIntegrationDepartmentRequest(AbstractModel):
     """ModifyIntegrationDepartment请求参数结构体
 

tencentcloud/essbasic/v20210526/essbasic_client.py

@@ -1032,6 +1032,9 @@ class EssbasicClient(AbstractClient):
         """使用此接口，用来绑定企业实名员工的角色，
         支持以电子签userId、客户系统openId两种方式进行绑定。
 
+        对应控制台的操作如下图
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)
+
         :param request: Request instance for ChannelCreateUserRoles.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateUserRolesRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateUserRolesResponse`
@@ -1104,6 +1107,9 @@ class EssbasicClient(AbstractClient):
     def ChannelDeleteRoleUsers(self, request):
         """通过此接口，删除员工绑定的角色，支持以电子签userId、客户系统userId两种方式调用。
 
+        对应控制台的操作如下图
+        ![image](https://qcloudimg.tencent-cloud.cn/raw/5b41194d3cb3f2058ec0ba0fb5ebc6a6.png)
+
         :param request: Request instance for ChannelDeleteRoleUsers.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDeleteRoleUsersRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelDeleteRoleUsersResponse`
@@ -1263,7 +1269,7 @@ class EssbasicClient(AbstractClient):
         """分页查询企业角色列表，法人的角色是系统保留角色，不会返回，按照角色创建时间升序排列。
 
 
-        <font color="red">**系统默认角色**</font>说明可参考下表
+        <font color="red">系统默认角色</font>说明可参考下表
 
         | 角色名称| 建议授予对象 | 角色描述 |
         | --- | --- | --- |
@@ -1272,6 +1278,8 @@ class EssbasicClient(AbstractClient):
         | **经办人**|企业法务负责人等 | 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看企业所有合同数据。 |
         | **业务员**|销售员、采购员 等| 发起合同、签署合同（含填写、拒签）、撤销合同、持有印章等权限能力，可查看自己相关所有合同数据。 |
 
+        附件：<a href="https://dyn.ess.tencent.cn/guide/apivideo/roles.xlsx" target="_blank">点击下载角色对应的权限点的excel文档</a>
+
         :param request: Request instance for ChannelDescribeRoles.
         :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeRolesRequest`
         :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeRolesResponse`
@@ -2264,6 +2272,39 @@ class EssbasicClient(AbstractClient):
                 raise TencentCloudSDKException(type(e).__name__, str(e))
 
 
+    def ModifyFlowDeadline(self, request):
+        """在已发起的签署流程中，支持对签署截止日期进行延期操作，主要涉及以下两个维度：
+        1. 合同（流程）维度：只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
+        2. 签署人维度：需要传递流程ID和签署人ID。此操作将对签署人进行延期操作，尤其对于有序的合同（流程），签署截止时间不能超过后一位合同（流程）签署人的流程截止时间。
+
+        此接口有如下限制条件：
+        1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
+        2. 在延长整个签署流程时，签署流程应至少还有一方未签署（即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态）。
+        3. 在延长整个签署流程时，新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
+        4. 在延长签署方的截止时间时，签署方不能处于流程完结或已终止状态（即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态）。
+        5. 在延长签署方的截止时间时，签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同，还应早于或等于下一签署人的截止日期，且早于签署流程整体的截止日期。
+        6. 不支持操作合同组合同。
+
+        :param request: Request instance for ModifyFlowDeadline.
+        :type request: :class:`tencentcloud.essbasic.v20210526.models.ModifyFlowDeadlineRequest`
+        :rtype: :class:`tencentcloud.essbasic.v20210526.models.ModifyFlowDeadlineResponse`
+
+        """
+        try:
+            params = request._serialize()
+            headers = request.headers
+            body = self.call("ModifyFlowDeadline", params, headers=headers)
+            response = json.loads(body)
+            model = models.ModifyFlowDeadlineResponse()
+            model._deserialize(response["Response"])
+            return model
+        except Exception as e:
+            if isinstance(e, TencentCloudSDKException):
+                raise
+            else:
+                raise TencentCloudSDKException(type(e).__name__, str(e))
+
+
     def OperateChannelTemplate(self, request):
         """此接口（OperateChannelTemplate）用于针对第三方应用平台模板库中的模板对子客企业发布授权的查询和设置。
         平台模板库中的模板的位置在控制台 企业应用管理 中下面的应用模板库管理目录, 可以参照下图位置