tencentcloud-sdk-python-essbasic 3.0.992__py2.py3-none-any.whl → 3.0.1001__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.
@@ -166,6 +166,8 @@ class ApproverItem(AbstractModel):
166
166
  def __init__(self):
167
167
  r"""
168
168
  :param _SignId: 签署方唯一编号
169
+
170
+ 在动态签署人场景下,可以用此编号确定参与方
169
171
  注意:此字段可能返回 null,表示取不到有效值。
170
172
  :type SignId: str
171
173
  :param _RecipientId: 签署方角色编号
@@ -1964,6 +1966,147 @@ class ChannelCreateEmbedWebUrlResponse(AbstractModel):
1964
1966
  self._RequestId = params.get("RequestId")
1965
1967
 
1966
1968
 
1969
+ class ChannelCreateFlowApproversRequest(AbstractModel):
1970
+ """ChannelCreateFlowApprovers请求参数结构体
1971
+
1972
+ """
1973
+
1974
+ def __init__(self):
1975
+ r"""
1976
+ :param _Agent: 渠道应用相关信息
1977
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1978
+ :param _FlowId: 合同唯一编号
1979
+ :type FlowId: str
1980
+ :param _Approvers: 补充企业签署人信息。
1981
+
1982
+ - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
1983
+
1984
+ - 如果不指定,则使用姓名和手机号进行补充。
1985
+ :type Approvers: list of FillApproverInfo
1986
+ :param _Operator: 操作人信息
1987
+ :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
1988
+ :param _FillApproverType: 签署人信息补充方式
1989
+
1990
+ <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
1991
+ <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
1992
+ :type FillApproverType: int
1993
+ """
1994
+ self._Agent = None
1995
+ self._FlowId = None
1996
+ self._Approvers = None
1997
+ self._Operator = None
1998
+ self._FillApproverType = None
1999
+
2000
+ @property
2001
+ def Agent(self):
2002
+ return self._Agent
2003
+
2004
+ @Agent.setter
2005
+ def Agent(self, Agent):
2006
+ self._Agent = Agent
2007
+
2008
+ @property
2009
+ def FlowId(self):
2010
+ return self._FlowId
2011
+
2012
+ @FlowId.setter
2013
+ def FlowId(self, FlowId):
2014
+ self._FlowId = FlowId
2015
+
2016
+ @property
2017
+ def Approvers(self):
2018
+ return self._Approvers
2019
+
2020
+ @Approvers.setter
2021
+ def Approvers(self, Approvers):
2022
+ self._Approvers = Approvers
2023
+
2024
+ @property
2025
+ def Operator(self):
2026
+ return self._Operator
2027
+
2028
+ @Operator.setter
2029
+ def Operator(self, Operator):
2030
+ self._Operator = Operator
2031
+
2032
+ @property
2033
+ def FillApproverType(self):
2034
+ return self._FillApproverType
2035
+
2036
+ @FillApproverType.setter
2037
+ def FillApproverType(self, FillApproverType):
2038
+ self._FillApproverType = FillApproverType
2039
+
2040
+
2041
+ def _deserialize(self, params):
2042
+ if params.get("Agent") is not None:
2043
+ self._Agent = Agent()
2044
+ self._Agent._deserialize(params.get("Agent"))
2045
+ self._FlowId = params.get("FlowId")
2046
+ if params.get("Approvers") is not None:
2047
+ self._Approvers = []
2048
+ for item in params.get("Approvers"):
2049
+ obj = FillApproverInfo()
2050
+ obj._deserialize(item)
2051
+ self._Approvers.append(obj)
2052
+ if params.get("Operator") is not None:
2053
+ self._Operator = UserInfo()
2054
+ self._Operator._deserialize(params.get("Operator"))
2055
+ self._FillApproverType = params.get("FillApproverType")
2056
+ memeber_set = set(params.keys())
2057
+ for name, value in vars(self).items():
2058
+ property_name = name[1:]
2059
+ if property_name in memeber_set:
2060
+ memeber_set.remove(property_name)
2061
+ if len(memeber_set) > 0:
2062
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
2063
+
2064
+
2065
+
2066
+ class ChannelCreateFlowApproversResponse(AbstractModel):
2067
+ """ChannelCreateFlowApprovers返回参数结构体
2068
+
2069
+ """
2070
+
2071
+ def __init__(self):
2072
+ r"""
2073
+ :param _FillError: 批量补充签署人时,补充失败的报错说明
2074
+ 注:`目前仅补充动态签署人时会返回补充失败的原因`
2075
+ 注意:此字段可能返回 null,表示取不到有效值。
2076
+ :type FillError: list of FillError
2077
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2078
+ :type RequestId: str
2079
+ """
2080
+ self._FillError = None
2081
+ self._RequestId = None
2082
+
2083
+ @property
2084
+ def FillError(self):
2085
+ return self._FillError
2086
+
2087
+ @FillError.setter
2088
+ def FillError(self, FillError):
2089
+ self._FillError = FillError
2090
+
2091
+ @property
2092
+ def RequestId(self):
2093
+ return self._RequestId
2094
+
2095
+ @RequestId.setter
2096
+ def RequestId(self, RequestId):
2097
+ self._RequestId = RequestId
2098
+
2099
+
2100
+ def _deserialize(self, params):
2101
+ if params.get("FillError") is not None:
2102
+ self._FillError = []
2103
+ for item in params.get("FillError"):
2104
+ obj = FillError()
2105
+ obj._deserialize(item)
2106
+ self._FillError.append(obj)
2107
+ self._RequestId = params.get("RequestId")
2108
+
2109
+
1967
2110
  class ChannelCreateFlowByFilesRequest(AbstractModel):
1968
2111
  """ChannelCreateFlowByFiles请求参数结构体
1969
2112
 
@@ -1971,56 +2114,103 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
1971
2114
 
1972
2115
  def __init__(self):
1973
2116
  r"""
1974
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
2117
+ :param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2118
+
2119
+ 此接口下面信息必填。
2120
+ <ul>
2121
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2122
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2123
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2124
+ </ul>
1975
2125
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
1976
- :param _FlowName: 签署流程名称,长度不超过200个字符
2126
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1977
2127
  :type FlowName: str
1978
- :param _FlowDescription: 签署流程的描述,长度不超过1000个字符
2128
+ :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
1979
2129
  :type FlowDescription: str
1980
- :param _FlowApprovers: 签署流程签约方列表,最多不超过50个参与方
2130
+ :param _FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo" target="_blank">FlowApproverInfo结构体</a>。
2131
+
2132
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
1981
2133
  :type FlowApprovers: list of FlowApproverInfo
1982
- :param _FileIds: 签署文件资源Id列表,目前仅支持单个文件
2134
+ :param _FileIds: 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
2135
+
2136
+ 注: `目前,此接口仅支持单个文件发起。`
1983
2137
  :type FileIds: list of str
1984
- :param _Components: 签署文件中的发起方的填写控件,需要在发起的时候进行填充
2138
+ :param _Components: 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
2139
+ <ul><li>单行文本控件</li>
2140
+ <li>多行文本控件</li>
2141
+ <li>勾选框控件</li>
2142
+ <li>数字控件</li>
2143
+ <li>图片控件</li>
2144
+ <li>数据表格等填写控件</li></ul>
1985
2145
  :type Components: list of Component
1986
- :param _Deadline: 签署流程的签署截止时间。
1987
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1988
- 不能早于当前时间
2146
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
2147
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1989
2148
  :type Deadline: int
1990
- :param _CallbackUrl: 签署流程回调地址,长度不超过255个字符
1991
- 如果不传递回调地址, 则默认是配置应用号时候使用的回调地址
2149
+ :param _CallbackUrl: 执行结果的回调URL,长度不超过255个字符,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
2150
+ 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
2151
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块。
2152
+
2153
+ 注:
2154
+ `如果不传递回调地址, 则默认是配置应用号时候使用的回调地址`
1992
2155
  :type CallbackUrl: str
1993
- :param _Unordered: 合同签署顺序类型
1994
- true - 无序签,
1995
- false - 顺序签,
1996
- 默认为false,即有序签署。
1997
- 有序签署时以传入FlowApprovers数组的顺序作为签署顺序
2156
+ :param _Unordered: 合同流程的签署顺序类型:
2157
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
2158
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
2159
+
2160
+ 注
2161
+ `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
1998
2162
  :type Unordered: bool
1999
- :param _FlowType: 签署流程的类型,长度不超过255个字符
2163
+ :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为255个字符,仅限中文、字母、数字和下划线组成。
2000
2164
  :type FlowType: str
2001
- :param _CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
2165
+ :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
2166
+ <ul><li>{合同名称} </li>
2167
+ <li>{发起方企业} </li>
2168
+ <li>{发起方姓名} </li>
2169
+ <li>{签署方N企业}</li>
2170
+ <li>{签署方N姓名}</li></ul>
2171
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
2172
+
2173
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
2174
+
2175
+ 合同名称:租房合同
2176
+ 发起方:腾讯公司(张三)
2177
+ 签署方:李四
2178
+
2179
+
2002
2180
  :type CustomShowMap: str
2003
- :param _CustomerData: 业务信息,最大长度1000个字符。
2181
+ :param _CustomerData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1000长度。
2182
+
2183
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">回调通知</a>模块。
2004
2184
  :type CustomerData: str
2005
- :param _NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
2185
+ :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
2186
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
2187
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
2188
+ 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
2189
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
2190
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
2191
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
2006
2192
  :type NeedSignReview: bool
2007
2193
  :param _ApproverVerifyType: 签署人校验方式
2008
2194
  VerifyCheck: 人脸识别(默认)
2009
2195
  MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
2010
2196
  参数说明:可选人脸识别或手机号验证两种方式,若选择后者,未实名个人签署方在签署合同时,无需经过实名认证和意愿确认两次人脸识别,该能力仅适用于个人签署方。
2011
2197
  :type ApproverVerifyType: str
2012
- :param _SignBeanTag: 标识是否允许发起后添加控件。
2013
- 0为不允许
2014
- 1为允许。
2015
- 如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
2198
+ :param _SignBeanTag: 签署方签署控件(印章/签名等)的生成方式:
2199
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
2200
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
2201
+
2202
+ 注:
2203
+ `发起后添加控件功能不支持添加签批控件`
2016
2204
  :type SignBeanTag: int
2017
- :param _CcInfos: 被抄送人信息列表
2205
+ :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
2018
2206
  :type CcInfos: list of CcInfo
2019
- :param _CcNotifyType: 给关注人发送短信通知的类型,
2020
- 0-合同发起时通知
2021
- 1-签署完成后通知
2207
+ :param _CcNotifyType: 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
2208
+ <ul><li> **0**:合同发起时通知(默认值)</li>
2209
+ <li> **1**:签署完成后通知</li></ul>
2022
2210
  :type CcNotifyType: int
2023
- :param _AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
2211
+ :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
2212
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
2213
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
2024
2214
  :type AutoSignScene: str
2025
2215
  :param _Operator: 操作者的信息,不用传
2026
2216
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -3211,6 +3401,141 @@ class ChannelCreateMultiFlowSignQRCodeResponse(AbstractModel):
3211
3401
  self._RequestId = params.get("RequestId")
3212
3402
 
3213
3403
 
3404
+ class ChannelCreateOrganizationBatchSignUrlRequest(AbstractModel):
3405
+ """ChannelCreateOrganizationBatchSignUrl请求参数结构体
3406
+
3407
+ """
3408
+
3409
+ def __init__(self):
3410
+ r"""
3411
+ :param _Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3412
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
3413
+ :param _FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
3414
+ :type FlowIds: list of str
3415
+ :param _OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
3416
+ :type OpenId: str
3417
+ :param _Name: 签署方经办人的姓名。
3418
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
3419
+
3420
+ 注:`请确保和合同中填入的一致`
3421
+ :type Name: str
3422
+ :param _Mobile: 员工手机号,必须与姓名一起使用。 如果OpenId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
3423
+ :type Mobile: str
3424
+ """
3425
+ self._Agent = None
3426
+ self._FlowIds = None
3427
+ self._OpenId = None
3428
+ self._Name = None
3429
+ self._Mobile = None
3430
+
3431
+ @property
3432
+ def Agent(self):
3433
+ return self._Agent
3434
+
3435
+ @Agent.setter
3436
+ def Agent(self, Agent):
3437
+ self._Agent = Agent
3438
+
3439
+ @property
3440
+ def FlowIds(self):
3441
+ return self._FlowIds
3442
+
3443
+ @FlowIds.setter
3444
+ def FlowIds(self, FlowIds):
3445
+ self._FlowIds = FlowIds
3446
+
3447
+ @property
3448
+ def OpenId(self):
3449
+ return self._OpenId
3450
+
3451
+ @OpenId.setter
3452
+ def OpenId(self, OpenId):
3453
+ self._OpenId = OpenId
3454
+
3455
+ @property
3456
+ def Name(self):
3457
+ return self._Name
3458
+
3459
+ @Name.setter
3460
+ def Name(self, Name):
3461
+ self._Name = Name
3462
+
3463
+ @property
3464
+ def Mobile(self):
3465
+ return self._Mobile
3466
+
3467
+ @Mobile.setter
3468
+ def Mobile(self, Mobile):
3469
+ self._Mobile = Mobile
3470
+
3471
+
3472
+ def _deserialize(self, params):
3473
+ if params.get("Agent") is not None:
3474
+ self._Agent = Agent()
3475
+ self._Agent._deserialize(params.get("Agent"))
3476
+ self._FlowIds = params.get("FlowIds")
3477
+ self._OpenId = params.get("OpenId")
3478
+ self._Name = params.get("Name")
3479
+ self._Mobile = params.get("Mobile")
3480
+ memeber_set = set(params.keys())
3481
+ for name, value in vars(self).items():
3482
+ property_name = name[1:]
3483
+ if property_name in memeber_set:
3484
+ memeber_set.remove(property_name)
3485
+ if len(memeber_set) > 0:
3486
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
3487
+
3488
+
3489
+
3490
+ class ChannelCreateOrganizationBatchSignUrlResponse(AbstractModel):
3491
+ """ChannelCreateOrganizationBatchSignUrl返回参数结构体
3492
+
3493
+ """
3494
+
3495
+ def __init__(self):
3496
+ r"""
3497
+ :param _SignUrl: 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
3498
+ :type SignUrl: str
3499
+ :param _ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
3500
+ :type ExpiredTime: int
3501
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3502
+ :type RequestId: str
3503
+ """
3504
+ self._SignUrl = None
3505
+ self._ExpiredTime = None
3506
+ self._RequestId = None
3507
+
3508
+ @property
3509
+ def SignUrl(self):
3510
+ return self._SignUrl
3511
+
3512
+ @SignUrl.setter
3513
+ def SignUrl(self, SignUrl):
3514
+ self._SignUrl = SignUrl
3515
+
3516
+ @property
3517
+ def ExpiredTime(self):
3518
+ return self._ExpiredTime
3519
+
3520
+ @ExpiredTime.setter
3521
+ def ExpiredTime(self, ExpiredTime):
3522
+ self._ExpiredTime = ExpiredTime
3523
+
3524
+ @property
3525
+ def RequestId(self):
3526
+ return self._RequestId
3527
+
3528
+ @RequestId.setter
3529
+ def RequestId(self, RequestId):
3530
+ self._RequestId = RequestId
3531
+
3532
+
3533
+ def _deserialize(self, params):
3534
+ self._SignUrl = params.get("SignUrl")
3535
+ self._ExpiredTime = params.get("ExpiredTime")
3536
+ self._RequestId = params.get("RequestId")
3537
+
3538
+
3214
3539
  class ChannelCreateOrganizationModifyQrCodeRequest(AbstractModel):
3215
3540
  """ChannelCreateOrganizationModifyQrCode请求参数结构体
3216
3541
 
@@ -4349,6 +4674,182 @@ class ChannelCreateUserAutoSignEnableUrlResponse(AbstractModel):
4349
4674
  self._RequestId = params.get("RequestId")
4350
4675
 
4351
4676
 
4677
+ class ChannelCreateUserAutoSignSealUrlRequest(AbstractModel):
4678
+ """ChannelCreateUserAutoSignSealUrl请求参数结构体
4679
+
4680
+ """
4681
+
4682
+ def __init__(self):
4683
+ r"""
4684
+ :param _Agent: 渠道应用相关信息。
4685
+ :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
4686
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
4687
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
4688
+
4689
+ 注: `现在仅支持电子处方场景`
4690
+ :type SceneKey: str
4691
+ :param _UserInfo: 自动签开通个人用户信息,包括名字,身份证等。
4692
+ :type UserInfo: :class:`tencentcloud.essbasic.v20210526.models.UserThreeFactor`
4693
+ :param _Operator: 执行本接口操作的员工信息。
4694
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4695
+ :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
4696
+ :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
4697
+ :type ExpiredTime: int
4698
+ """
4699
+ self._Agent = None
4700
+ self._SceneKey = None
4701
+ self._UserInfo = None
4702
+ self._Operator = None
4703
+ self._ExpiredTime = None
4704
+
4705
+ @property
4706
+ def Agent(self):
4707
+ return self._Agent
4708
+
4709
+ @Agent.setter
4710
+ def Agent(self, Agent):
4711
+ self._Agent = Agent
4712
+
4713
+ @property
4714
+ def SceneKey(self):
4715
+ return self._SceneKey
4716
+
4717
+ @SceneKey.setter
4718
+ def SceneKey(self, SceneKey):
4719
+ self._SceneKey = SceneKey
4720
+
4721
+ @property
4722
+ def UserInfo(self):
4723
+ return self._UserInfo
4724
+
4725
+ @UserInfo.setter
4726
+ def UserInfo(self, UserInfo):
4727
+ self._UserInfo = UserInfo
4728
+
4729
+ @property
4730
+ def Operator(self):
4731
+ return self._Operator
4732
+
4733
+ @Operator.setter
4734
+ def Operator(self, Operator):
4735
+ self._Operator = Operator
4736
+
4737
+ @property
4738
+ def ExpiredTime(self):
4739
+ return self._ExpiredTime
4740
+
4741
+ @ExpiredTime.setter
4742
+ def ExpiredTime(self, ExpiredTime):
4743
+ self._ExpiredTime = ExpiredTime
4744
+
4745
+
4746
+ def _deserialize(self, params):
4747
+ if params.get("Agent") is not None:
4748
+ self._Agent = Agent()
4749
+ self._Agent._deserialize(params.get("Agent"))
4750
+ self._SceneKey = params.get("SceneKey")
4751
+ if params.get("UserInfo") is not None:
4752
+ self._UserInfo = UserThreeFactor()
4753
+ self._UserInfo._deserialize(params.get("UserInfo"))
4754
+ if params.get("Operator") is not None:
4755
+ self._Operator = UserInfo()
4756
+ self._Operator._deserialize(params.get("Operator"))
4757
+ self._ExpiredTime = params.get("ExpiredTime")
4758
+ memeber_set = set(params.keys())
4759
+ for name, value in vars(self).items():
4760
+ property_name = name[1:]
4761
+ if property_name in memeber_set:
4762
+ memeber_set.remove(property_name)
4763
+ if len(memeber_set) > 0:
4764
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
4765
+
4766
+
4767
+
4768
+ class ChannelCreateUserAutoSignSealUrlResponse(AbstractModel):
4769
+ """ChannelCreateUserAutoSignSealUrl返回参数结构体
4770
+
4771
+ """
4772
+
4773
+ def __init__(self):
4774
+ r"""
4775
+ :param _AppId: 腾讯电子签小程序的AppId,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
4776
+ :type AppId: str
4777
+ :param _AppOriginalId: 腾讯电子签小程序的原始Id,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
4778
+ :type AppOriginalId: str
4779
+ :param _Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
4780
+ :type Url: str
4781
+ :param _Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
4782
+ :type Path: str
4783
+ :param _QrCode: base64格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
4784
+ :type QrCode: str
4785
+ :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4786
+ :type RequestId: str
4787
+ """
4788
+ self._AppId = None
4789
+ self._AppOriginalId = None
4790
+ self._Url = None
4791
+ self._Path = None
4792
+ self._QrCode = None
4793
+ self._RequestId = None
4794
+
4795
+ @property
4796
+ def AppId(self):
4797
+ return self._AppId
4798
+
4799
+ @AppId.setter
4800
+ def AppId(self, AppId):
4801
+ self._AppId = AppId
4802
+
4803
+ @property
4804
+ def AppOriginalId(self):
4805
+ return self._AppOriginalId
4806
+
4807
+ @AppOriginalId.setter
4808
+ def AppOriginalId(self, AppOriginalId):
4809
+ self._AppOriginalId = AppOriginalId
4810
+
4811
+ @property
4812
+ def Url(self):
4813
+ return self._Url
4814
+
4815
+ @Url.setter
4816
+ def Url(self, Url):
4817
+ self._Url = Url
4818
+
4819
+ @property
4820
+ def Path(self):
4821
+ return self._Path
4822
+
4823
+ @Path.setter
4824
+ def Path(self, Path):
4825
+ self._Path = Path
4826
+
4827
+ @property
4828
+ def QrCode(self):
4829
+ return self._QrCode
4830
+
4831
+ @QrCode.setter
4832
+ def QrCode(self, QrCode):
4833
+ self._QrCode = QrCode
4834
+
4835
+ @property
4836
+ def RequestId(self):
4837
+ return self._RequestId
4838
+
4839
+ @RequestId.setter
4840
+ def RequestId(self, RequestId):
4841
+ self._RequestId = RequestId
4842
+
4843
+
4844
+ def _deserialize(self, params):
4845
+ self._AppId = params.get("AppId")
4846
+ self._AppOriginalId = params.get("AppOriginalId")
4847
+ self._Url = params.get("Url")
4848
+ self._Path = params.get("Path")
4849
+ self._QrCode = params.get("QrCode")
4850
+ self._RequestId = params.get("RequestId")
4851
+
4852
+
4352
4853
  class ChannelCreateUserRolesRequest(AbstractModel):
4353
4854
  """ChannelCreateUserRoles请求参数结构体
4354
4855
 
@@ -6243,9 +6744,11 @@ class ChannelVerifyPdfRequest(AbstractModel):
6243
6744
 
6244
6745
  def __init__(self):
6245
6746
  r"""
6246
- :param _FlowId: 流程ID
6747
+ :param _FlowId: 合同流程ID,为32位字符串。
6748
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6247
6749
  :type FlowId: str
6248
- :param _Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
6750
+ :param _Agent: 代理企业和员工的信息。
6751
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6249
6752
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
6250
6753
  :param _Operator: 暂未开放
6251
6754
  :type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
@@ -6308,15 +6811,32 @@ class ChannelVerifyPdfResponse(AbstractModel):
6308
6811
 
6309
6812
  def __init__(self):
6310
6813
  r"""
6311
- :param _VerifyResult: 验签结果,1-文件未被篡改,全部签名在腾讯电子签完成; 2-文件未被篡改,部分签名在腾讯电子签完成;3-文件被篡改;4-异常:文件内没有签名域;5-异常:文件签名格式错误
6814
+ :param _VerifyResult: 验签结果代码,代码的含义如下:
6815
+
6816
+ <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
6817
+ <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
6818
+ <li>**3**:文件被篡改。</li>
6819
+ <li>**4**:异常:文件内没有签名域。</li>
6820
+ <li>**5**:异常:文件签名格式错误。</li></ul>
6312
6821
  :type VerifyResult: int
6313
- :param _PdfVerifyResults: 验签结果详情,内部状态1-验签成功,在电子签签署;2-验签成功,在其他平台签署;3-验签失败;4-pdf文件没有签名域;5-文件签名格式错误
6822
+ :param _PdfVerifyResults: 验签结果详情,每个签名域对应的验签结果。状态值如下
6823
+ <ul><li> **1** :验签成功,在电子签签署</li>
6824
+ <li> **2** :验签成功,在其他平台签署</li>
6825
+ <li> **3** :验签失败</li>
6826
+ <li> **4** :pdf文件没有签名域</li>
6827
+ <li> **5** :文件签名格式错误</li></ul>
6314
6828
  :type PdfVerifyResults: list of PdfVerifyResult
6829
+ :param _VerifySerialNo: 验签序列号, 为11为数组组成的字符串
6830
+ :type VerifySerialNo: str
6831
+ :param _PdfResourceMd5: 合同文件MD5哈希值
6832
+ :type PdfResourceMd5: str
6315
6833
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6316
6834
  :type RequestId: str
6317
6835
  """
6318
6836
  self._VerifyResult = None
6319
6837
  self._PdfVerifyResults = None
6838
+ self._VerifySerialNo = None
6839
+ self._PdfResourceMd5 = None
6320
6840
  self._RequestId = None
6321
6841
 
6322
6842
  @property
@@ -6335,6 +6855,22 @@ class ChannelVerifyPdfResponse(AbstractModel):
6335
6855
  def PdfVerifyResults(self, PdfVerifyResults):
6336
6856
  self._PdfVerifyResults = PdfVerifyResults
6337
6857
 
6858
+ @property
6859
+ def VerifySerialNo(self):
6860
+ return self._VerifySerialNo
6861
+
6862
+ @VerifySerialNo.setter
6863
+ def VerifySerialNo(self, VerifySerialNo):
6864
+ self._VerifySerialNo = VerifySerialNo
6865
+
6866
+ @property
6867
+ def PdfResourceMd5(self):
6868
+ return self._PdfResourceMd5
6869
+
6870
+ @PdfResourceMd5.setter
6871
+ def PdfResourceMd5(self, PdfResourceMd5):
6872
+ self._PdfResourceMd5 = PdfResourceMd5
6873
+
6338
6874
  @property
6339
6875
  def RequestId(self):
6340
6876
  return self._RequestId
@@ -6352,6 +6888,8 @@ class ChannelVerifyPdfResponse(AbstractModel):
6352
6888
  obj = PdfVerifyResult()
6353
6889
  obj._deserialize(item)
6354
6890
  self._PdfVerifyResults.append(obj)
6891
+ self._VerifySerialNo = params.get("VerifySerialNo")
6892
+ self._PdfResourceMd5 = params.get("PdfResourceMd5")
6355
6893
  self._RequestId = params.get("RequestId")
6356
6894
 
6357
6895
 
@@ -6699,11 +7237,12 @@ KEYWORD - 关键字
6699
7237
  为JSON格式。
6700
7238
  不同类型的控件会有部分非通用参数
6701
7239
 
6702
- TEXT/MULTI_LINE_TEXT控件可以指定
7240
+ ComponentType为TEXT、MULTI_LINE_TEXT时,支持以下参数:
6703
7241
  1 Font:目前只支持黑体、宋体
6704
7242
  2 FontSize: 范围12-72
6705
7243
  3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
6706
- 例如:{"FontSize":12}
7244
+ 4 FontColor:字符串类型,格式为RGB颜色数字
7245
+ 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
6707
7246
 
6708
7247
  ComponentType为FILL_IMAGE时,支持以下参数:
6709
7248
  NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
@@ -8226,6 +8765,7 @@ class CreateSignUrlsRequest(AbstractModel):
8226
8765
  - NOT_CHANNEL:非第三方平台子客企业企业
8227
8766
  - PERSON:个人
8228
8767
  - FOLLOWER:关注方,目前是合同抄送方
8768
+ - RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
8229
8769
  :type GenerateType: str
8230
8770
  :param _OrganizationName: 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
8231
8771
  :type OrganizationName: str
@@ -8252,7 +8792,7 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
8252
8792
  - 2:合同签署页面更多操作的转他人处理按钮
8253
8793
  - 3:签署成功页的查看详情按钮
8254
8794
  :type Hides: list of int
8255
- :param _RecipientIds: 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致
8795
+ :param _RecipientIds: 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
8256
8796
  :type RecipientIds: list of str
8257
8797
  """
8258
8798
  self._Agent = None
@@ -9493,11 +10033,14 @@ class ExtentServiceAuthInfo(AbstractModel):
9493
10033
  def __init__(self):
9494
10034
  r"""
9495
10035
  :param _Type: 扩展服务类型
9496
- AUTO_SIGN 企业静默签(自动签署)
9497
- OVERSEA_SIGN 企业与港澳台居民*签署合同
9498
- MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
9499
- PAGING_SEAL 骑缝章
9500
- DOWNLOAD_FLOW 授权平台企业下载合同
10036
+ <ul>
10037
+ <li>AUTO_SIGN 企业静默签(自动签署)</li>
10038
+ <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
10039
+ <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
10040
+ <li> PAGING_SEAL 骑缝章</li>
10041
+ <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
10042
+ <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
10043
+ </ul>
9501
10044
  :type Type: str
9502
10045
  :param _Name: 扩展服务名称
9503
10046
  :type Name: str
@@ -9622,6 +10165,160 @@ class FailedCreateRoleData(AbstractModel):
9622
10165
 
9623
10166
 
9624
10167
 
10168
+ class FillApproverInfo(AbstractModel):
10169
+ """指定补充签署人信息
10170
+ - RecipientId 必须指定
10171
+
10172
+ """
10173
+
10174
+ def __init__(self):
10175
+ r"""
10176
+ :param _RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
10177
+
10178
+ :type RecipientId: str
10179
+ :param _OpenId: 指定企业经办签署人OpenId
10180
+ :type OpenId: str
10181
+ :param _ApproverName: 签署人姓名
10182
+ :type ApproverName: str
10183
+ :param _ApproverMobile: 签署人手机号码
10184
+ :type ApproverMobile: str
10185
+ :param _OrganizationName: 企业名称
10186
+ :type OrganizationName: str
10187
+ :param _OrganizationOpenId: 企业OpenId
10188
+ :type OrganizationOpenId: str
10189
+ :param _NotChannelOrganization: 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,organization_open_id+open_id 必传
10190
+ :type NotChannelOrganization: str
10191
+ """
10192
+ self._RecipientId = None
10193
+ self._OpenId = None
10194
+ self._ApproverName = None
10195
+ self._ApproverMobile = None
10196
+ self._OrganizationName = None
10197
+ self._OrganizationOpenId = None
10198
+ self._NotChannelOrganization = None
10199
+
10200
+ @property
10201
+ def RecipientId(self):
10202
+ return self._RecipientId
10203
+
10204
+ @RecipientId.setter
10205
+ def RecipientId(self, RecipientId):
10206
+ self._RecipientId = RecipientId
10207
+
10208
+ @property
10209
+ def OpenId(self):
10210
+ return self._OpenId
10211
+
10212
+ @OpenId.setter
10213
+ def OpenId(self, OpenId):
10214
+ self._OpenId = OpenId
10215
+
10216
+ @property
10217
+ def ApproverName(self):
10218
+ return self._ApproverName
10219
+
10220
+ @ApproverName.setter
10221
+ def ApproverName(self, ApproverName):
10222
+ self._ApproverName = ApproverName
10223
+
10224
+ @property
10225
+ def ApproverMobile(self):
10226
+ return self._ApproverMobile
10227
+
10228
+ @ApproverMobile.setter
10229
+ def ApproverMobile(self, ApproverMobile):
10230
+ self._ApproverMobile = ApproverMobile
10231
+
10232
+ @property
10233
+ def OrganizationName(self):
10234
+ return self._OrganizationName
10235
+
10236
+ @OrganizationName.setter
10237
+ def OrganizationName(self, OrganizationName):
10238
+ self._OrganizationName = OrganizationName
10239
+
10240
+ @property
10241
+ def OrganizationOpenId(self):
10242
+ return self._OrganizationOpenId
10243
+
10244
+ @OrganizationOpenId.setter
10245
+ def OrganizationOpenId(self, OrganizationOpenId):
10246
+ self._OrganizationOpenId = OrganizationOpenId
10247
+
10248
+ @property
10249
+ def NotChannelOrganization(self):
10250
+ return self._NotChannelOrganization
10251
+
10252
+ @NotChannelOrganization.setter
10253
+ def NotChannelOrganization(self, NotChannelOrganization):
10254
+ self._NotChannelOrganization = NotChannelOrganization
10255
+
10256
+
10257
+ def _deserialize(self, params):
10258
+ self._RecipientId = params.get("RecipientId")
10259
+ self._OpenId = params.get("OpenId")
10260
+ self._ApproverName = params.get("ApproverName")
10261
+ self._ApproverMobile = params.get("ApproverMobile")
10262
+ self._OrganizationName = params.get("OrganizationName")
10263
+ self._OrganizationOpenId = params.get("OrganizationOpenId")
10264
+ self._NotChannelOrganization = params.get("NotChannelOrganization")
10265
+ memeber_set = set(params.keys())
10266
+ for name, value in vars(self).items():
10267
+ property_name = name[1:]
10268
+ if property_name in memeber_set:
10269
+ memeber_set.remove(property_name)
10270
+ if len(memeber_set) > 0:
10271
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
10272
+
10273
+
10274
+
10275
+ class FillError(AbstractModel):
10276
+ """批量补充签署人时,补充失败的报错说明
10277
+
10278
+ """
10279
+
10280
+ def __init__(self):
10281
+ r"""
10282
+ :param _RecipientId: 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
10283
+ 注意:此字段可能返回 null,表示取不到有效值。
10284
+ :type RecipientId: str
10285
+ :param _ErrMessage: 补充失败错误说明
10286
+ 注意:此字段可能返回 null,表示取不到有效值。
10287
+ :type ErrMessage: str
10288
+ """
10289
+ self._RecipientId = None
10290
+ self._ErrMessage = None
10291
+
10292
+ @property
10293
+ def RecipientId(self):
10294
+ return self._RecipientId
10295
+
10296
+ @RecipientId.setter
10297
+ def RecipientId(self, RecipientId):
10298
+ self._RecipientId = RecipientId
10299
+
10300
+ @property
10301
+ def ErrMessage(self):
10302
+ return self._ErrMessage
10303
+
10304
+ @ErrMessage.setter
10305
+ def ErrMessage(self, ErrMessage):
10306
+ self._ErrMessage = ErrMessage
10307
+
10308
+
10309
+ def _deserialize(self, params):
10310
+ self._RecipientId = params.get("RecipientId")
10311
+ self._ErrMessage = params.get("ErrMessage")
10312
+ memeber_set = set(params.keys())
10313
+ for name, value in vars(self).items():
10314
+ property_name = name[1:]
10315
+ if property_name in memeber_set:
10316
+ memeber_set.remove(property_name)
10317
+ if len(memeber_set) > 0:
10318
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
10319
+
10320
+
10321
+
9625
10322
  class FilledComponent(AbstractModel):
9626
10323
  """文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
9627
10324
 
@@ -9945,12 +10642,12 @@ class FlowApproverInfo(AbstractModel):
9945
10642
  其中签署方FlowApproverInfo需要传递的参数
9946
10643
  非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。
9947
10644
 
9948
- 其他身份标识
10645
+ 其他身份标识,注:`如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`
9949
10646
 
9950
10647
  <ul><li>1-个人:Name、Mobile必传</li>
9951
10648
  <li>2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;</li>
9952
10649
  <li>3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;</li>
9953
- <li>4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
10650
+ <li>4-非第三方平台子客企业(平台企业):Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
9954
10651
 
9955
10652
  RecipientId参数:
9956
10653
  从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
@@ -9959,43 +10656,59 @@ class FlowApproverInfo(AbstractModel):
9959
10656
 
9960
10657
  def __init__(self):
9961
10658
  r"""
9962
- :param _Name: 签署人姓名,最大长度50个字符
10659
+ :param _Name: 签署方经办人的姓名。
10660
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
9963
10661
  :type Name: str
9964
- :param _IdCardType: 签署人的证件类型
9965
- 1.ID_CARD 居民身份证
9966
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
9967
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
9968
- 4.OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
10662
+ :param _IdCardType: 签署方经办人的证件类型,支持以下类型
10663
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
10664
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
10665
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
10666
+ <li>OTHER_CARD_TYPE : 其他证件</li></ul>
10667
+
10668
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
9969
10669
  :type IdCardType: str
9970
- :param _IdCardNumber: 签署人证件号(长度不超过18位)
10670
+ :param _IdCardNumber: 签署方经办人的证件号码,应符合以下规则
10671
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
10672
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
10673
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
9971
10674
  :type IdCardNumber: str
9972
- :param _Mobile: 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
10675
+ :param _Mobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符), 不支持海外手机号。
10676
+ 请确认手机号所有方为此合同签署方。
9973
10677
  :type Mobile: str
9974
- :param _OrganizationName: 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
10678
+ :param _OrganizationName: 组织机构名称。
10679
+ 请确认该名称与企业营业执照中注册的名称一致。
10680
+ 如果名称中包含英文括号(),请使用中文括号()代替。
9975
10681
  :type OrganizationName: str
9976
- :param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
9977
- 默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
10682
+ :param _NotChannelOrganization: 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
10683
+ <ul>
10684
+ <li>false: 默认值,第三方平台子客企业下员工</li>
10685
+ <li>true: SaaS平台企业下的员工</li>
10686
+ </ul>
10687
+
9978
10688
  :type NotChannelOrganization: bool
9979
- :param _OpenId: 用户侧第三方id,最大长度64个字符
10689
+ :param _OpenId: 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成
10690
+
9980
10691
  当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
9981
10692
  :type OpenId: str
9982
- :param _OrganizationOpenId: 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
10693
+ :param _OrganizationOpenId: 同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符
9983
10694
  :type OrganizationOpenId: str
9984
- :param _ApproverType: 签署人类型
9985
- PERSON-个人/自然人;
9986
- PERSON_AUTO_SIGN-个人自动签署,适用于个人自动签场景
9987
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
9988
- ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
9989
- ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的本方企业自动签)
9990
-
9991
- 若要实现他方企业(同一应用下)自动签,需要满足3个条件:
9992
- 条件1:ApproverType 设置为ENTERPRISESERVER
9993
- 条件2:子客之间完成授权
9994
- 条件3:联系对接的客户经理沟通
10695
+ :param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
10696
+ <ul><li> **PERSON** :个人/自然人</li>
10697
+ <li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li>
10698
+ <li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li>
10699
+ <li> **ENTERPRISESERVER** :企业/企业员自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
10700
+
10701
+ 注:
10702
+ `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
10703
+ `2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:`
10704
+ <ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li>
10705
+ <li>条件2:子客之间完成授权</li>
10706
+ <li>条件3:联系对接的客户经理沟通如何使用</li></ul>
9995
10707
  :type ApproverType: str
9996
10708
  :param _RecipientId: 签署流程签署人在模板中对应的签署人Id;在非单方签署、以及非B2C签署的场景下必传,用于指定当前签署方在签署流程中的位置;
9997
10709
  :type RecipientId: str
9998
- :param _Deadline: 签署截止时间戳,默认一年
10710
+ :param _Deadline: 本签署人在此合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
10711
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
9999
10712
  :type Deadline: int
10000
10713
  :param _CallbackUrl: 签署完回调url,最大长度1000个字符
10001
10714
  :type CallbackUrl: str
@@ -10007,11 +10720,19 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
10007
10720
  ESIGN -- 个人印章类型
10008
10721
  SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
10009
10722
  :type ComponentLimitType: list of str
10010
- :param _PreReadTime: 合同的强制预览时间:3~300s,未指定则按合同页数计算
10723
+ :param _PreReadTime: 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
10724
+
10725
+ 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
10726
+ <ul>
10727
+ <li>合同页数少于等于2页,阅读时间为3秒;</li>
10728
+ <li>合同页数为3到5页,阅读时间为5秒;</li>
10729
+ <li>合同页数大于等于6页,阅读时间为10秒。</li>
10730
+ </ul>
10011
10731
  :type PreReadTime: int
10012
10732
  :param _JumpUrl: 签署完前端跳转的url,此字段的用法场景请联系客户经理确认
10013
10733
  :type JumpUrl: str
10014
- :param _ApproverOption: 签署人个性化能力值
10734
+ :param _ApproverOption: 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
10735
+ 详细操作可以参考开发者中心的ApproverOption结构体。
10015
10736
  :type ApproverOption: :class:`tencentcloud.essbasic.v20210526.models.ApproverOption`
10016
10737
  :param _ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批,true 则为需要
10017
10738
  :type ApproverNeedSignReview: bool
@@ -10026,14 +10747,17 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
10026
10747
  - 发起流程时系统自动补充
10027
10748
  - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
10028
10749
  :type SignId: str
10029
- :param _NotifyType: SMS: 短信(需确保“电子签短信通知签署方”功能是开启状态才能生效); NONE: 不发信息
10030
- 默认为SMS(签署方为子客时该字段不生效)
10750
+ :param _NotifyType: 通知签署方经办人的方式, 有以下途径:
10751
+ <ul><li> **SMS** :(默认)短信</li>
10752
+ <li> **NONE** : 不通知</li></ul>
10753
+
10754
+ 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
10031
10755
  :type NotifyType: str
10032
10756
  :param _AddSignComponentsLimits: [通过文件创建签署流程](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
10033
10757
 
10034
10758
  注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
10035
10759
  :type AddSignComponentsLimits: list of ComponentLimit
10036
- :param _ApproverRoleName: 自定义签署方角色名称
10760
+ :param _ApproverRoleName: 自定义签署人角色名,如收款人、开具人、见证人等
10037
10761
  :type ApproverRoleName: str
10038
10762
  """
10039
10763
  self._Name = None
@@ -11210,7 +11934,181 @@ class FlowResourceUrlInfo(AbstractModel):
11210
11934
 
11211
11935
 
11212
11936
  class FormField(AbstractModel):
11213
- """此结构 (FormField) 用于描述内容控件填充结构。
11937
+ """电子文档的控件填充信息。按照控件类型进行相应的填充。
11938
+
11939
+ 当控件的 ComponentType='TEXT'时,FormField.ComponentValue填入文本内容
11940
+ ```
11941
+ FormField输入示例:
11942
+ {
11943
+ "ComponentId": "componentId1",
11944
+ "ComponentValue": "文本内容"
11945
+ }
11946
+ ```
11947
+ 当控件的 ComponentType='MULTI_LINE_TEXT'时,FormField.ComponentValue填入文本内容,支持自动换行。
11948
+ ```
11949
+ FormField输入示例:
11950
+ {
11951
+ "ComponentId": "componentId1",
11952
+ "ComponentValue": "多行文本内容"
11953
+ }
11954
+ ```
11955
+ 当控件的 ComponentType='CHECK_BOX'时,FormField.ComponentValue填入true或false文本
11956
+ ```
11957
+ FormField输入示例:
11958
+ {
11959
+ "ComponentId": "componentId1",
11960
+ "ComponentValue": "true"
11961
+ }
11962
+ ```
11963
+ 当控件的 ComponentType='FILL_IMAGE'时,FormField.ComponentValue填入图片的资源ID
11964
+ ```
11965
+ FormField输入示例:
11966
+ {
11967
+ "ComponentId": "componentId1",
11968
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxxx"
11969
+ }
11970
+ ```
11971
+ 当控件的 ComponentType='ATTACHMENT'时,FormField.ComponentValue填入附件图片的资源ID列表,以逗号分隔,单个附件控件最多支持6个资源ID;
11972
+ ```
11973
+ FormField输入示例:
11974
+ {
11975
+ "ComponentId": "componentId1",
11976
+ "ComponentValue": "yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx1,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx2,yDwhsxxxxxxxxxxxxxxxxxxxxxxxxxx3"
11977
+ }
11978
+ ```
11979
+ 当控件的 ComponentType='SELECTOR'时,FormField.ComponentValue填入选择的选项内容;
11980
+ ```
11981
+ FormField输入示例:
11982
+ {
11983
+ "ComponentId": "componentId1",
11984
+ "ComponentValue": "选择的内容"
11985
+ }
11986
+ ```
11987
+ 当控件的 ComponentType='DATE'时,FormField.ComponentValue填入日期内容;
11988
+ ```
11989
+ FormField输入示例:
11990
+ {
11991
+ "ComponentId": "componentId1",
11992
+ "ComponentValue": "2023年01月01日"
11993
+ }
11994
+ ```
11995
+ 当控件的 ComponentType='DISTRICT'时,FormField.ComponentValue填入省市区内容;
11996
+ ```
11997
+ FormField输入示例:
11998
+ {
11999
+ "ComponentId": "componentId1",
12000
+ "ComponentValue": "广东省深圳市福田区"
12001
+ }
12002
+ ```
12003
+ 【数据表格传参说明】
12004
+ 当控件的 ComponentType='DYNAMIC_TABLE'时,FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
12005
+ 输入示例1:
12006
+
12007
+ ```
12008
+ {
12009
+ "headers":[
12010
+ {
12011
+ "content":"head1"
12012
+ },
12013
+ {
12014
+ "content":"head2"
12015
+ },
12016
+ {
12017
+ "content":"head3"
12018
+ }
12019
+ ],
12020
+ "rowCount":3,
12021
+ "body":{
12022
+ "cells":[
12023
+ {
12024
+ "rowStart":1,
12025
+ "rowEnd":1,
12026
+ "columnStart":1,
12027
+ "columnEnd":1,
12028
+ "content":"123"
12029
+ },
12030
+ {
12031
+ "rowStart":2,
12032
+ "rowEnd":3,
12033
+ "columnStart":1,
12034
+ "columnEnd":2,
12035
+ "content":"456"
12036
+ },
12037
+ {
12038
+ "rowStart":3,
12039
+ "rowEnd":3,
12040
+ "columnStart":3,
12041
+ "columnEnd":3,
12042
+ "content":"789"
12043
+ }
12044
+ ]
12045
+ }
12046
+ }
12047
+
12048
+ ```
12049
+
12050
+ 输入示例2(表格表头宽度比例配置):
12051
+
12052
+ ```
12053
+ {
12054
+ "headers":[
12055
+ {
12056
+ "content":"head1",
12057
+ "widthPercent": 30
12058
+ },
12059
+ {
12060
+ "content":"head2",
12061
+ "widthPercent": 30
12062
+ },
12063
+ {
12064
+ "content":"head3",
12065
+ "widthPercent": 40
12066
+ }
12067
+ ],
12068
+ "rowCount":3,
12069
+ "body":{
12070
+ "cells":[
12071
+ {
12072
+ "rowStart":1,
12073
+ "rowEnd":1,
12074
+ "columnStart":1,
12075
+ "columnEnd":1,
12076
+ "content":"123"
12077
+ },
12078
+ {
12079
+ "rowStart":2,
12080
+ "rowEnd":3,
12081
+ "columnStart":1,
12082
+ "columnEnd":2,
12083
+ "content":"456"
12084
+ },
12085
+ {
12086
+ "rowStart":3,
12087
+ "rowEnd":3,
12088
+ "columnStart":3,
12089
+ "columnEnd":3,
12090
+ "content":"789"
12091
+ }
12092
+ ]
12093
+ }
12094
+ }
12095
+
12096
+ ```
12097
+ 表格参数说明
12098
+
12099
+ | 名称 | 类型 | 描述 |
12100
+ | ------------------- | ------- | ------------------------------------------------- |
12101
+ | headers | Array | 表头:不超过10列,不支持单元格合并,字数不超过100 |
12102
+ | rowCount | Integer | 表格内容最大行数 |
12103
+ | cells.N.rowStart | Integer | 单元格坐标:行起始index |
12104
+ | cells.N.rowEnd | Integer | 单元格坐标:行结束index |
12105
+ | cells.N.columnStart | Integer | 单元格坐标:列起始index |
12106
+ | cells.N.columnEnd | Integer | 单元格坐标:列结束index |
12107
+ | cells.N.content | String | 单元格内容,字数不超过100 |
12108
+
12109
+ 表格参数headers说明
12110
+ widthPercent Integer 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35
12111
+ content String 表头单元格内容,字数不超过100
11214
12112
 
11215
12113
  """
11216
12114
 
@@ -11412,11 +12310,14 @@ class ModifyExtendedServiceRequest(AbstractModel):
11412
12310
  注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
11413
12311
  :type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
11414
12312
  :param _ServiceType: 扩展服务类型
11415
- AUTO_SIGN 企业静默签(自动签署)
11416
- OVERSEA_SIGN 企业与港澳台居民*签署合同
11417
- MOBILE_CHECK_APPROVER 使用手机号验证签署方身份
11418
- PAGING_SEAL 骑缝章
11419
- DOWNLOAD_FLOW 授权渠道下载合同
12313
+ <ul>
12314
+ <li>AUTO_SIGN 企业自动签(自动签署)</li>
12315
+ <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
12316
+ <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
12317
+ <li> PAGING_SEAL 骑缝章</li>
12318
+ <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
12319
+ <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
12320
+ </ul>
11420
12321
  :type ServiceType: str
11421
12322
  :param _Operate: 操作类型
11422
12323
  OPEN:开通