tencentcloud-sdk-python-essbasic 3.0.1022__py2.py3-none-any.whl → 3.0.1031__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.
- tencentcloud/__init__.py +1 -1
- tencentcloud/essbasic/v20210526/essbasic_client.py +144 -69
- tencentcloud/essbasic/v20210526/models.py +586 -117
- {tencentcloud_sdk_python_essbasic-3.0.1022.dist-info → tencentcloud_sdk_python_essbasic-3.0.1031.dist-info}/METADATA +2 -2
- {tencentcloud_sdk_python_essbasic-3.0.1022.dist-info → tencentcloud_sdk_python_essbasic-3.0.1031.dist-info}/RECORD +7 -7
- {tencentcloud_sdk_python_essbasic-3.0.1022.dist-info → tencentcloud_sdk_python_essbasic-3.0.1031.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python_essbasic-3.0.1022.dist-info → tencentcloud_sdk_python_essbasic-3.0.1031.dist-info}/top_level.txt +0 -0
|
@@ -236,6 +236,8 @@ class ApproverOption(AbstractModel):
|
|
|
236
236
|
r"""
|
|
237
237
|
:param _NoRefuse: 是否可以拒签 默认false-可以拒签 true-不可以拒签
|
|
238
238
|
:type NoRefuse: bool
|
|
239
|
+
:param _NoTransfer: 是否可以转发 默认false-可以转发 true-不可以转发
|
|
240
|
+
:type NoTransfer: bool
|
|
239
241
|
:param _HideOneKeySign: 是否隐藏一键签署 默认false-不隐藏true-隐藏
|
|
240
242
|
:type HideOneKeySign: bool
|
|
241
243
|
:param _FillType: 签署人信息补充类型,默认无需补充。
|
|
@@ -254,6 +256,7 @@ class ApproverOption(AbstractModel):
|
|
|
254
256
|
:type FlowReadLimit: str
|
|
255
257
|
"""
|
|
256
258
|
self._NoRefuse = None
|
|
259
|
+
self._NoTransfer = None
|
|
257
260
|
self._HideOneKeySign = None
|
|
258
261
|
self._FillType = None
|
|
259
262
|
self._FlowReadLimit = None
|
|
@@ -266,6 +269,14 @@ class ApproverOption(AbstractModel):
|
|
|
266
269
|
def NoRefuse(self, NoRefuse):
|
|
267
270
|
self._NoRefuse = NoRefuse
|
|
268
271
|
|
|
272
|
+
@property
|
|
273
|
+
def NoTransfer(self):
|
|
274
|
+
return self._NoTransfer
|
|
275
|
+
|
|
276
|
+
@NoTransfer.setter
|
|
277
|
+
def NoTransfer(self, NoTransfer):
|
|
278
|
+
self._NoTransfer = NoTransfer
|
|
279
|
+
|
|
269
280
|
@property
|
|
270
281
|
def HideOneKeySign(self):
|
|
271
282
|
return self._HideOneKeySign
|
|
@@ -293,6 +304,7 @@ class ApproverOption(AbstractModel):
|
|
|
293
304
|
|
|
294
305
|
def _deserialize(self, params):
|
|
295
306
|
self._NoRefuse = params.get("NoRefuse")
|
|
307
|
+
self._NoTransfer = params.get("NoTransfer")
|
|
296
308
|
self._HideOneKeySign = params.get("HideOneKeySign")
|
|
297
309
|
self._FillType = params.get("FillType")
|
|
298
310
|
self._FlowReadLimit = params.get("FlowReadLimit")
|
|
@@ -1064,7 +1076,7 @@ class ChannelBatchCancelFlowsRequest(AbstractModel):
|
|
|
1064
1076
|
|
|
1065
1077
|
注: `CancelMessage为撤销当前合同的理由`
|
|
1066
1078
|
|
|
1067
|
-

|
|
1068
1080
|
|
|
1069
1081
|
|
|
1070
1082
|
:type CancelMessageFormat: int
|
|
@@ -1181,6 +1193,191 @@ class ChannelBatchCancelFlowsResponse(AbstractModel):
|
|
|
1181
1193
|
self._RequestId = params.get("RequestId")
|
|
1182
1194
|
|
|
1183
1195
|
|
|
1196
|
+
class ChannelBillUsageDetail(AbstractModel):
|
|
1197
|
+
"""用户计费使用情况详情
|
|
1198
|
+
|
|
1199
|
+
"""
|
|
1200
|
+
|
|
1201
|
+
def __init__(self):
|
|
1202
|
+
r"""
|
|
1203
|
+
:param _FlowId: 合同流程ID,为32位字符串。
|
|
1204
|
+
:type FlowId: str
|
|
1205
|
+
:param _OperatorName: 合同经办人名称
|
|
1206
|
+
如果有多个经办人用分号隔开。
|
|
1207
|
+
:type OperatorName: str
|
|
1208
|
+
:param _CreateOrganizationName: 发起方组织机构名称
|
|
1209
|
+
:type CreateOrganizationName: str
|
|
1210
|
+
:param _FlowName: 合同流程的名称。
|
|
1211
|
+
:type FlowName: str
|
|
1212
|
+
:param _FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
|
|
1213
|
+
<ul>
|
|
1214
|
+
<li>**INIT**: 合同创建</li>
|
|
1215
|
+
<li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
|
|
1216
|
+
<li>**REJECT**: 合同拒签</li>
|
|
1217
|
+
<li>**ALL**: 合同签署完成</li>
|
|
1218
|
+
<li>**DEADLINE**: 合同流签(合同过期)</li>
|
|
1219
|
+
<li>**CANCEL**: 合同撤回</li>
|
|
1220
|
+
<li>**RELIEVED**: 解除协议(已解除)</li>
|
|
1221
|
+
<li>**WILLEXPIRE**: 合同即将过期</li>
|
|
1222
|
+
<li>**EXCEPTION**: 合同异常</li>
|
|
1223
|
+
</ul>
|
|
1224
|
+
:type FlowStatus: str
|
|
1225
|
+
:param _QuotaType: 查询的套餐类型
|
|
1226
|
+
对应关系如下:
|
|
1227
|
+
<ul>
|
|
1228
|
+
<li>**CloudEnterprise**: 企业版合同</li>
|
|
1229
|
+
<li>**SingleSignature**: 单方签章</li>
|
|
1230
|
+
<li>**CloudProve**: 签署报告</li>
|
|
1231
|
+
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
|
|
1232
|
+
<li>**ChannelWeCard**: 微工卡</li>
|
|
1233
|
+
<li>**SignFlow**: 合同套餐</li>
|
|
1234
|
+
<li>**SignFace**: 签署意愿(人脸识别)</li>
|
|
1235
|
+
<li>**SignPassword**: 签署意愿(密码)</li>
|
|
1236
|
+
<li>**SignSMS**: 签署意愿(短信)</li>
|
|
1237
|
+
<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
|
|
1238
|
+
<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
|
|
1239
|
+
<li>**OrgEssAuth**: 签署企业实名</li>
|
|
1240
|
+
<li>**FlowNotify**: 短信通知</li>
|
|
1241
|
+
<li>**AuthService**: 企业工商信息查询</li>
|
|
1242
|
+
</ul>
|
|
1243
|
+
:type QuotaType: str
|
|
1244
|
+
:param _UseCount: 合同使用量
|
|
1245
|
+
注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
|
|
1246
|
+
:type UseCount: int
|
|
1247
|
+
:param _CostTime: 消耗的时间戳,格式为Unix标准时间戳(秒)。
|
|
1248
|
+
:type CostTime: int
|
|
1249
|
+
:param _QuotaName: 消耗的套餐名称
|
|
1250
|
+
:type QuotaName: str
|
|
1251
|
+
:param _CostType: 消耗类型
|
|
1252
|
+
**1**.扣费
|
|
1253
|
+
**2**.撤销返还
|
|
1254
|
+
:type CostType: int
|
|
1255
|
+
:param _Remark: 备注
|
|
1256
|
+
:type Remark: str
|
|
1257
|
+
"""
|
|
1258
|
+
self._FlowId = None
|
|
1259
|
+
self._OperatorName = None
|
|
1260
|
+
self._CreateOrganizationName = None
|
|
1261
|
+
self._FlowName = None
|
|
1262
|
+
self._FlowStatus = None
|
|
1263
|
+
self._QuotaType = None
|
|
1264
|
+
self._UseCount = None
|
|
1265
|
+
self._CostTime = None
|
|
1266
|
+
self._QuotaName = None
|
|
1267
|
+
self._CostType = None
|
|
1268
|
+
self._Remark = None
|
|
1269
|
+
|
|
1270
|
+
@property
|
|
1271
|
+
def FlowId(self):
|
|
1272
|
+
return self._FlowId
|
|
1273
|
+
|
|
1274
|
+
@FlowId.setter
|
|
1275
|
+
def FlowId(self, FlowId):
|
|
1276
|
+
self._FlowId = FlowId
|
|
1277
|
+
|
|
1278
|
+
@property
|
|
1279
|
+
def OperatorName(self):
|
|
1280
|
+
return self._OperatorName
|
|
1281
|
+
|
|
1282
|
+
@OperatorName.setter
|
|
1283
|
+
def OperatorName(self, OperatorName):
|
|
1284
|
+
self._OperatorName = OperatorName
|
|
1285
|
+
|
|
1286
|
+
@property
|
|
1287
|
+
def CreateOrganizationName(self):
|
|
1288
|
+
return self._CreateOrganizationName
|
|
1289
|
+
|
|
1290
|
+
@CreateOrganizationName.setter
|
|
1291
|
+
def CreateOrganizationName(self, CreateOrganizationName):
|
|
1292
|
+
self._CreateOrganizationName = CreateOrganizationName
|
|
1293
|
+
|
|
1294
|
+
@property
|
|
1295
|
+
def FlowName(self):
|
|
1296
|
+
return self._FlowName
|
|
1297
|
+
|
|
1298
|
+
@FlowName.setter
|
|
1299
|
+
def FlowName(self, FlowName):
|
|
1300
|
+
self._FlowName = FlowName
|
|
1301
|
+
|
|
1302
|
+
@property
|
|
1303
|
+
def FlowStatus(self):
|
|
1304
|
+
return self._FlowStatus
|
|
1305
|
+
|
|
1306
|
+
@FlowStatus.setter
|
|
1307
|
+
def FlowStatus(self, FlowStatus):
|
|
1308
|
+
self._FlowStatus = FlowStatus
|
|
1309
|
+
|
|
1310
|
+
@property
|
|
1311
|
+
def QuotaType(self):
|
|
1312
|
+
return self._QuotaType
|
|
1313
|
+
|
|
1314
|
+
@QuotaType.setter
|
|
1315
|
+
def QuotaType(self, QuotaType):
|
|
1316
|
+
self._QuotaType = QuotaType
|
|
1317
|
+
|
|
1318
|
+
@property
|
|
1319
|
+
def UseCount(self):
|
|
1320
|
+
return self._UseCount
|
|
1321
|
+
|
|
1322
|
+
@UseCount.setter
|
|
1323
|
+
def UseCount(self, UseCount):
|
|
1324
|
+
self._UseCount = UseCount
|
|
1325
|
+
|
|
1326
|
+
@property
|
|
1327
|
+
def CostTime(self):
|
|
1328
|
+
return self._CostTime
|
|
1329
|
+
|
|
1330
|
+
@CostTime.setter
|
|
1331
|
+
def CostTime(self, CostTime):
|
|
1332
|
+
self._CostTime = CostTime
|
|
1333
|
+
|
|
1334
|
+
@property
|
|
1335
|
+
def QuotaName(self):
|
|
1336
|
+
return self._QuotaName
|
|
1337
|
+
|
|
1338
|
+
@QuotaName.setter
|
|
1339
|
+
def QuotaName(self, QuotaName):
|
|
1340
|
+
self._QuotaName = QuotaName
|
|
1341
|
+
|
|
1342
|
+
@property
|
|
1343
|
+
def CostType(self):
|
|
1344
|
+
return self._CostType
|
|
1345
|
+
|
|
1346
|
+
@CostType.setter
|
|
1347
|
+
def CostType(self, CostType):
|
|
1348
|
+
self._CostType = CostType
|
|
1349
|
+
|
|
1350
|
+
@property
|
|
1351
|
+
def Remark(self):
|
|
1352
|
+
return self._Remark
|
|
1353
|
+
|
|
1354
|
+
@Remark.setter
|
|
1355
|
+
def Remark(self, Remark):
|
|
1356
|
+
self._Remark = Remark
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
def _deserialize(self, params):
|
|
1360
|
+
self._FlowId = params.get("FlowId")
|
|
1361
|
+
self._OperatorName = params.get("OperatorName")
|
|
1362
|
+
self._CreateOrganizationName = params.get("CreateOrganizationName")
|
|
1363
|
+
self._FlowName = params.get("FlowName")
|
|
1364
|
+
self._FlowStatus = params.get("FlowStatus")
|
|
1365
|
+
self._QuotaType = params.get("QuotaType")
|
|
1366
|
+
self._UseCount = params.get("UseCount")
|
|
1367
|
+
self._CostTime = params.get("CostTime")
|
|
1368
|
+
self._QuotaName = params.get("QuotaName")
|
|
1369
|
+
self._CostType = params.get("CostType")
|
|
1370
|
+
self._Remark = params.get("Remark")
|
|
1371
|
+
memeber_set = set(params.keys())
|
|
1372
|
+
for name, value in vars(self).items():
|
|
1373
|
+
property_name = name[1:]
|
|
1374
|
+
if property_name in memeber_set:
|
|
1375
|
+
memeber_set.remove(property_name)
|
|
1376
|
+
if len(memeber_set) > 0:
|
|
1377
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
|
|
1184
1381
|
class ChannelCancelFlowRequest(AbstractModel):
|
|
1185
1382
|
"""ChannelCancelFlow请求参数结构体
|
|
1186
1383
|
|
|
@@ -1323,12 +1520,13 @@ class ChannelCancelMultiFlowSignQRCodeRequest(AbstractModel):
|
|
|
1323
1520
|
|
|
1324
1521
|
此接口下面信息必填。
|
|
1325
1522
|
<ul>
|
|
1326
|
-
<li>渠道应用标识: Agent.
|
|
1327
|
-
<li>第三方平台子客企业标识: Agent.
|
|
1328
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
1523
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
1524
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1525
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
1329
1526
|
</ul>
|
|
1527
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
1330
1528
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
1331
|
-
:param _QrCodeId:
|
|
1529
|
+
:param _QrCodeId: 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
|
|
1332
1530
|
:type QrCodeId: str
|
|
1333
1531
|
:param _Operator: 暂未开放
|
|
1334
1532
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
@@ -1674,9 +1872,10 @@ class ChannelCreateBatchQuickSignUrlRequest(AbstractModel):
|
|
|
1674
1872
|
:type SignatureTypes: list of int
|
|
1675
1873
|
:param _ApproverSignTypes: 指定批量签署合同的认证校验方式,可传递以下值:
|
|
1676
1874
|
<ul><li>**1**:人脸认证(默认),需进行人脸识别成功后才能签署合同</li>
|
|
1875
|
+
<li>**2**:密码认证(默认),需校验成功后才能签署合同</li>
|
|
1677
1876
|
<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
|
1678
1877
|
注:
|
|
1679
|
-
<ul><li
|
|
1878
|
+
<ul><li>默认情况下,认证校验方式为人脸和密码认证</li>
|
|
1680
1879
|
<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
|
1681
1880
|
:type ApproverSignTypes: list of int
|
|
1682
1881
|
"""
|
|
@@ -2047,10 +2246,17 @@ class ChannelCreateBoundFlowsRequest(AbstractModel):
|
|
|
2047
2246
|
|
|
2048
2247
|
def __init__(self):
|
|
2049
2248
|
r"""
|
|
2050
|
-
:param _Agent:
|
|
2051
|
-
|
|
2249
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2250
|
+
|
|
2251
|
+
此接口下面信息必填。
|
|
2252
|
+
<ul>
|
|
2253
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2254
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2255
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2256
|
+
</ul>
|
|
2257
|
+
第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
|
|
2052
2258
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
2053
|
-
:param _FlowIds:
|
|
2259
|
+
:param _FlowIds: 需要领取的合同流程的ID列表
|
|
2054
2260
|
:type FlowIds: list of str
|
|
2055
2261
|
:param _Operator: 暂未开放
|
|
2056
2262
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
@@ -2158,6 +2364,7 @@ class ChannelCreateConvertTaskApiRequest(AbstractModel):
|
|
|
2158
2364
|
<li>jpeg</li>
|
|
2159
2365
|
<li>png</li>
|
|
2160
2366
|
<li>bmp</li>
|
|
2367
|
+
<li>html</li>
|
|
2161
2368
|
<li>txt</li></ul>
|
|
2162
2369
|
:type ResourceType: str
|
|
2163
2370
|
:param _ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
|
|
@@ -2444,9 +2651,17 @@ class ChannelCreateFlowApproversRequest(AbstractModel):
|
|
|
2444
2651
|
|
|
2445
2652
|
def __init__(self):
|
|
2446
2653
|
r"""
|
|
2447
|
-
:param _Agent:
|
|
2654
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2655
|
+
|
|
2656
|
+
此接口下面信息必填。
|
|
2657
|
+
<ul>
|
|
2658
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2659
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2660
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2661
|
+
</ul>
|
|
2662
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
2448
2663
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
2449
|
-
:param _FlowId:
|
|
2664
|
+
:param _FlowId: 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
|
2450
2665
|
:type FlowId: str
|
|
2451
2666
|
:param _Approvers: 补充企业签署人信息。
|
|
2452
2667
|
|
|
@@ -3686,13 +3901,13 @@ class ChannelCreateMultiFlowSignQRCodeRequest(AbstractModel):
|
|
|
3686
3901
|
|
|
3687
3902
|
此接口下面信息必填。
|
|
3688
3903
|
<ul>
|
|
3689
|
-
<li>渠道应用标识: Agent.
|
|
3690
|
-
<li>第三方平台子客企业标识: Agent.
|
|
3691
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
3904
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3905
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3906
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
3692
3907
|
</ul>
|
|
3908
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
3693
3909
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
3694
3910
|
:param _TemplateId: 合同模板ID,为32位字符串。
|
|
3695
|
-
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
3696
3911
|
:type TemplateId: str
|
|
3697
3912
|
:param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
|
|
3698
3913
|
:type FlowName: str
|
|
@@ -4061,7 +4276,14 @@ class ChannelCreateOrganizationModifyQrCodeRequest(AbstractModel):
|
|
|
4061
4276
|
|
|
4062
4277
|
def __init__(self):
|
|
4063
4278
|
r"""
|
|
4064
|
-
:param _Agent:
|
|
4279
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4280
|
+
|
|
4281
|
+
此接口下面信息必填。
|
|
4282
|
+
|
|
4283
|
+
渠道应用标识: Agent.AppId
|
|
4284
|
+
第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
|
|
4285
|
+
第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
|
|
4286
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
4065
4287
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
4066
4288
|
"""
|
|
4067
4289
|
self._Agent = None
|
|
@@ -4784,7 +5006,15 @@ class ChannelCreateRoleRequest(AbstractModel):
|
|
|
4784
5006
|
r"""
|
|
4785
5007
|
:param _Name: 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
|
|
4786
5008
|
:type Name: str
|
|
4787
|
-
:param _Agent:
|
|
5009
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5010
|
+
|
|
5011
|
+
此接口下面信息必填。
|
|
5012
|
+
<ul>
|
|
5013
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
5014
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5015
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5016
|
+
</ul>
|
|
5017
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
4788
5018
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
4789
5019
|
:param _Description: 角色描述,最大长度为50个字符
|
|
4790
5020
|
:type Description: str
|
|
@@ -5675,7 +5905,15 @@ class ChannelDeleteRoleRequest(AbstractModel):
|
|
|
5675
5905
|
|
|
5676
5906
|
def __init__(self):
|
|
5677
5907
|
r"""
|
|
5678
|
-
:param _Agent:
|
|
5908
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5909
|
+
|
|
5910
|
+
此接口下面信息必填。
|
|
5911
|
+
<ul>
|
|
5912
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
5913
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5914
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5915
|
+
</ul>
|
|
5916
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
5679
5917
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
5680
5918
|
:param _RoleIds: 角色id,最多20个
|
|
5681
5919
|
:type RoleIds: list of str
|
|
@@ -5873,12 +6111,13 @@ class ChannelDeleteSealPoliciesRequest(AbstractModel):
|
|
|
5873
6111
|
|
|
5874
6112
|
def __init__(self):
|
|
5875
6113
|
r"""
|
|
5876
|
-
:param _Agent:
|
|
6114
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5877
6115
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
5878
|
-
:param _SealId:
|
|
6116
|
+
:param _SealId: 操作的印章ID
|
|
5879
6117
|
:type SealId: str
|
|
5880
|
-
:param _UserIds:
|
|
5881
|
-
|
|
6118
|
+
:param _UserIds: 需要删除授权的用户ID数组,可以传入电子签系统用户ID或OpenId。
|
|
6119
|
+
注:
|
|
6120
|
+
1. `填写OpenId时,系统会通过组织+渠道+OpenId查询得到对应的UserId进行授权取消操作`
|
|
5882
6121
|
:type UserIds: list of str
|
|
5883
6122
|
:param _Organization: 组织机构信息,不用传
|
|
5884
6123
|
:type Organization: :class:`tencentcloud.essbasic.v20210526.models.OrganizationInfo`
|
|
@@ -5987,6 +6226,180 @@ class ChannelDeleteSealPoliciesResponse(AbstractModel):
|
|
|
5987
6226
|
self._RequestId = params.get("RequestId")
|
|
5988
6227
|
|
|
5989
6228
|
|
|
6229
|
+
class ChannelDescribeBillUsageDetailRequest(AbstractModel):
|
|
6230
|
+
"""ChannelDescribeBillUsageDetail请求参数结构体
|
|
6231
|
+
|
|
6232
|
+
"""
|
|
6233
|
+
|
|
6234
|
+
def __init__(self):
|
|
6235
|
+
r"""
|
|
6236
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6237
|
+
|
|
6238
|
+
此接口下面信息必填。
|
|
6239
|
+
<ul>
|
|
6240
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6241
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6242
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6243
|
+
</ul>
|
|
6244
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6245
|
+
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
6246
|
+
:param _StartTime: 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
6247
|
+
:type StartTime: str
|
|
6248
|
+
:param _EndTime: 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
|
|
6249
|
+
:type EndTime: str
|
|
6250
|
+
:param _QuotaType: 查询的套餐类型 (选填 )不传则查询所有套餐;
|
|
6251
|
+
目前支持:
|
|
6252
|
+
<ul>
|
|
6253
|
+
<li>**CloudEnterprise**: 企业版合同</li>
|
|
6254
|
+
<li>**SingleSignature**: 单方签章</li>
|
|
6255
|
+
<li>**CloudProve**: 签署报告</li>
|
|
6256
|
+
<li>**CloudOnlineSign**: 腾讯会议在线签约</li>
|
|
6257
|
+
<li>**ChannelWeCard**: 微工卡</li>
|
|
6258
|
+
<li>**SignFlow**: 合同套餐</li>
|
|
6259
|
+
<li>**SignFace**: 签署意愿(人脸识别)</li>
|
|
6260
|
+
<li>**SignPassword**: 签署意愿(密码)</li>
|
|
6261
|
+
<li>**SignSMS**: 签署意愿(短信)</li>
|
|
6262
|
+
<li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
|
|
6263
|
+
<li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
|
|
6264
|
+
<li>**OrgEssAuth**: 签署企业实名</li>
|
|
6265
|
+
<li>**FlowNotify**: 短信通知</li>
|
|
6266
|
+
<li>**AuthService**: 企业工商信息查询</li>
|
|
6267
|
+
</ul>
|
|
6268
|
+
:type QuotaType: str
|
|
6269
|
+
:param _Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
|
|
6270
|
+
:type Offset: int
|
|
6271
|
+
:param _Limit: 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
|
|
6272
|
+
:type Limit: int
|
|
6273
|
+
"""
|
|
6274
|
+
self._Agent = None
|
|
6275
|
+
self._StartTime = None
|
|
6276
|
+
self._EndTime = None
|
|
6277
|
+
self._QuotaType = None
|
|
6278
|
+
self._Offset = None
|
|
6279
|
+
self._Limit = None
|
|
6280
|
+
|
|
6281
|
+
@property
|
|
6282
|
+
def Agent(self):
|
|
6283
|
+
return self._Agent
|
|
6284
|
+
|
|
6285
|
+
@Agent.setter
|
|
6286
|
+
def Agent(self, Agent):
|
|
6287
|
+
self._Agent = Agent
|
|
6288
|
+
|
|
6289
|
+
@property
|
|
6290
|
+
def StartTime(self):
|
|
6291
|
+
return self._StartTime
|
|
6292
|
+
|
|
6293
|
+
@StartTime.setter
|
|
6294
|
+
def StartTime(self, StartTime):
|
|
6295
|
+
self._StartTime = StartTime
|
|
6296
|
+
|
|
6297
|
+
@property
|
|
6298
|
+
def EndTime(self):
|
|
6299
|
+
return self._EndTime
|
|
6300
|
+
|
|
6301
|
+
@EndTime.setter
|
|
6302
|
+
def EndTime(self, EndTime):
|
|
6303
|
+
self._EndTime = EndTime
|
|
6304
|
+
|
|
6305
|
+
@property
|
|
6306
|
+
def QuotaType(self):
|
|
6307
|
+
return self._QuotaType
|
|
6308
|
+
|
|
6309
|
+
@QuotaType.setter
|
|
6310
|
+
def QuotaType(self, QuotaType):
|
|
6311
|
+
self._QuotaType = QuotaType
|
|
6312
|
+
|
|
6313
|
+
@property
|
|
6314
|
+
def Offset(self):
|
|
6315
|
+
return self._Offset
|
|
6316
|
+
|
|
6317
|
+
@Offset.setter
|
|
6318
|
+
def Offset(self, Offset):
|
|
6319
|
+
self._Offset = Offset
|
|
6320
|
+
|
|
6321
|
+
@property
|
|
6322
|
+
def Limit(self):
|
|
6323
|
+
return self._Limit
|
|
6324
|
+
|
|
6325
|
+
@Limit.setter
|
|
6326
|
+
def Limit(self, Limit):
|
|
6327
|
+
self._Limit = Limit
|
|
6328
|
+
|
|
6329
|
+
|
|
6330
|
+
def _deserialize(self, params):
|
|
6331
|
+
if params.get("Agent") is not None:
|
|
6332
|
+
self._Agent = Agent()
|
|
6333
|
+
self._Agent._deserialize(params.get("Agent"))
|
|
6334
|
+
self._StartTime = params.get("StartTime")
|
|
6335
|
+
self._EndTime = params.get("EndTime")
|
|
6336
|
+
self._QuotaType = params.get("QuotaType")
|
|
6337
|
+
self._Offset = params.get("Offset")
|
|
6338
|
+
self._Limit = params.get("Limit")
|
|
6339
|
+
memeber_set = set(params.keys())
|
|
6340
|
+
for name, value in vars(self).items():
|
|
6341
|
+
property_name = name[1:]
|
|
6342
|
+
if property_name in memeber_set:
|
|
6343
|
+
memeber_set.remove(property_name)
|
|
6344
|
+
if len(memeber_set) > 0:
|
|
6345
|
+
warnings.warn("%s fileds are useless." % ",".join(memeber_set))
|
|
6346
|
+
|
|
6347
|
+
|
|
6348
|
+
|
|
6349
|
+
class ChannelDescribeBillUsageDetailResponse(AbstractModel):
|
|
6350
|
+
"""ChannelDescribeBillUsageDetail返回参数结构体
|
|
6351
|
+
|
|
6352
|
+
"""
|
|
6353
|
+
|
|
6354
|
+
def __init__(self):
|
|
6355
|
+
r"""
|
|
6356
|
+
:param _Total: 返回查询记录总数
|
|
6357
|
+
:type Total: int
|
|
6358
|
+
:param _Details: 消耗记录详情
|
|
6359
|
+
:type Details: list of ChannelBillUsageDetail
|
|
6360
|
+
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6361
|
+
:type RequestId: str
|
|
6362
|
+
"""
|
|
6363
|
+
self._Total = None
|
|
6364
|
+
self._Details = None
|
|
6365
|
+
self._RequestId = None
|
|
6366
|
+
|
|
6367
|
+
@property
|
|
6368
|
+
def Total(self):
|
|
6369
|
+
return self._Total
|
|
6370
|
+
|
|
6371
|
+
@Total.setter
|
|
6372
|
+
def Total(self, Total):
|
|
6373
|
+
self._Total = Total
|
|
6374
|
+
|
|
6375
|
+
@property
|
|
6376
|
+
def Details(self):
|
|
6377
|
+
return self._Details
|
|
6378
|
+
|
|
6379
|
+
@Details.setter
|
|
6380
|
+
def Details(self, Details):
|
|
6381
|
+
self._Details = Details
|
|
6382
|
+
|
|
6383
|
+
@property
|
|
6384
|
+
def RequestId(self):
|
|
6385
|
+
return self._RequestId
|
|
6386
|
+
|
|
6387
|
+
@RequestId.setter
|
|
6388
|
+
def RequestId(self, RequestId):
|
|
6389
|
+
self._RequestId = RequestId
|
|
6390
|
+
|
|
6391
|
+
|
|
6392
|
+
def _deserialize(self, params):
|
|
6393
|
+
self._Total = params.get("Total")
|
|
6394
|
+
if params.get("Details") is not None:
|
|
6395
|
+
self._Details = []
|
|
6396
|
+
for item in params.get("Details"):
|
|
6397
|
+
obj = ChannelBillUsageDetail()
|
|
6398
|
+
obj._deserialize(item)
|
|
6399
|
+
self._Details.append(obj)
|
|
6400
|
+
self._RequestId = params.get("RequestId")
|
|
6401
|
+
|
|
6402
|
+
|
|
5990
6403
|
class ChannelDescribeEmployeesRequest(AbstractModel):
|
|
5991
6404
|
"""ChannelDescribeEmployees请求参数结构体
|
|
5992
6405
|
|
|
@@ -6183,9 +6596,17 @@ class ChannelDescribeFlowComponentsRequest(AbstractModel):
|
|
|
6183
6596
|
|
|
6184
6597
|
def __init__(self):
|
|
6185
6598
|
r"""
|
|
6186
|
-
:param _Agent:
|
|
6599
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6600
|
+
|
|
6601
|
+
此接口下面信息必填。
|
|
6602
|
+
<ul>
|
|
6603
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6604
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6605
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6606
|
+
</ul>
|
|
6607
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6187
6608
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
6188
|
-
:param _FlowId:
|
|
6609
|
+
:param _FlowId: 需要获取填写控件填写内容的合同流程ID
|
|
6189
6610
|
:type FlowId: str
|
|
6190
6611
|
"""
|
|
6191
6612
|
self._Agent = None
|
|
@@ -6230,8 +6651,7 @@ class ChannelDescribeFlowComponentsResponse(AbstractModel):
|
|
|
6230
6651
|
|
|
6231
6652
|
def __init__(self):
|
|
6232
6653
|
r"""
|
|
6233
|
-
:param _RecipientComponentInfos:
|
|
6234
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
6654
|
+
:param _RecipientComponentInfos: 合同填写控件信息列表,填写控件会按照参与方角色进行分类。
|
|
6235
6655
|
:type RecipientComponentInfos: list of RecipientComponentInfo
|
|
6236
6656
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
6237
6657
|
:type RequestId: str
|
|
@@ -6273,23 +6693,30 @@ class ChannelDescribeOrganizationSealsRequest(AbstractModel):
|
|
|
6273
6693
|
|
|
6274
6694
|
def __init__(self):
|
|
6275
6695
|
r"""
|
|
6276
|
-
:param _Agent:
|
|
6696
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6277
6697
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
6278
6698
|
:param _Limit: 返回最大数量,最大为100
|
|
6279
6699
|
:type Limit: int
|
|
6280
|
-
:param _Offset:
|
|
6700
|
+
:param _Offset: 分页查询偏移量,默认为0,最大为20000
|
|
6281
6701
|
:type Offset: int
|
|
6282
|
-
:param _InfoType:
|
|
6702
|
+
:param _InfoType: 查询信息类型
|
|
6703
|
+
支持的值如下:
|
|
6704
|
+
<ul><li>0-默认,不返回授权用户信息</li>
|
|
6705
|
+
<li>1-返回授权用户信息</li>
|
|
6706
|
+
</ul>
|
|
6283
6707
|
:type InfoType: int
|
|
6284
6708
|
:param _SealId: 印章id(没有输入返回所有)
|
|
6709
|
+
|
|
6710
|
+
注: `没有输入返回所有记录,最大返回100条。`
|
|
6285
6711
|
:type SealId: str
|
|
6286
|
-
:param _SealTypes:
|
|
6287
|
-
|
|
6288
|
-
|
|
6289
|
-
|
|
6290
|
-
|
|
6291
|
-
|
|
6292
|
-
|
|
6712
|
+
:param _SealTypes: 印章类型列表,目前支持传入以下类型:
|
|
6713
|
+
<ul><li>OFFICIAL-企业公章</li>
|
|
6714
|
+
<li>CONTRACT-合同专用章</li>
|
|
6715
|
+
<li>ORGANIZATION_SEAL-企业印章(图片上传创建)</li>
|
|
6716
|
+
<li>LEGAL_PERSON_SEAL-法定代表人章</li>
|
|
6717
|
+
</ul>
|
|
6718
|
+
|
|
6719
|
+
注: `为空时查询所有类型的印章。`
|
|
6293
6720
|
:type SealTypes: list of str
|
|
6294
6721
|
"""
|
|
6295
6722
|
self._Agent = None
|
|
@@ -6428,16 +6855,36 @@ class ChannelDescribeRolesRequest(AbstractModel):
|
|
|
6428
6855
|
|
|
6429
6856
|
def __init__(self):
|
|
6430
6857
|
r"""
|
|
6431
|
-
:param _Agent:
|
|
6858
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
6859
|
+
|
|
6860
|
+
此接口下面信息必填。
|
|
6861
|
+
<ul>
|
|
6862
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
6863
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
6864
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
6865
|
+
</ul>
|
|
6866
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
6432
6867
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
6433
|
-
:param _Limit:
|
|
6868
|
+
:param _Limit: 指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
|
|
6869
|
+
|
|
6870
|
+
注: `因为历史原因, 此字段为字符串类型`
|
|
6434
6871
|
:type Limit: str
|
|
6435
6872
|
:param _Filters: 查询的关键字段:
|
|
6436
|
-
Key:"RoleType",Values:["1"]查询系统角色,
|
|
6437
|
-
Key:"
|
|
6438
|
-
Key:"
|
|
6873
|
+
Key:"**RoleType**",Values:["**1**"]查询系统角色,
|
|
6874
|
+
Key:"**RoleType**",Values:["**2**"]查询自定义角色
|
|
6875
|
+
Key:"**RoleStatus**",Values:["**1**"]查询启用角色
|
|
6876
|
+
Key:"**RoleStatus**",Values:["**2**"]查询禁用角色
|
|
6877
|
+
Key:"**IsReturnPermissionGroup**",Values:["**0**"]表示接口不返回角色对应的权限树字段
|
|
6878
|
+
Key:"**IsReturnPermissionGroup**",Values:["**1**"]表示接口返回角色对应的权限树字段
|
|
6879
|
+
|
|
6880
|
+
注: `同名字的Key的过滤条件会冲突, 只能填写一个`
|
|
6881
|
+
|
|
6439
6882
|
:type Filters: list of Filter
|
|
6440
|
-
:param _Offset:
|
|
6883
|
+
:param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
|
|
6884
|
+
|
|
6885
|
+
注:
|
|
6886
|
+
1.`offset从0开始,即第一页为0。`
|
|
6887
|
+
2.`默认从第一页返回。`
|
|
6441
6888
|
:type Offset: int
|
|
6442
6889
|
:param _Operator: 操作人信息
|
|
6443
6890
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
@@ -6525,13 +6972,13 @@ class ChannelDescribeRolesResponse(AbstractModel):
|
|
|
6525
6972
|
|
|
6526
6973
|
def __init__(self):
|
|
6527
6974
|
r"""
|
|
6528
|
-
:param _Offset:
|
|
6975
|
+
:param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用,最大2000条。
|
|
6529
6976
|
:type Offset: int
|
|
6530
|
-
:param _Limit:
|
|
6977
|
+
:param _Limit: 指定每页返回的数据条数,和Offset参数配合使用,单页最大200。
|
|
6531
6978
|
:type Limit: int
|
|
6532
6979
|
:param _TotalCount: 查询角色的总数量
|
|
6533
6980
|
:type TotalCount: int
|
|
6534
|
-
:param _ChannelRoles:
|
|
6981
|
+
:param _ChannelRoles: 查询的角色信息列表
|
|
6535
6982
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
6536
6983
|
:type ChannelRoles: list of ChannelRole
|
|
6537
6984
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -7177,22 +7624,23 @@ class ChannelModifyRoleResponse(AbstractModel):
|
|
|
7177
7624
|
|
|
7178
7625
|
|
|
7179
7626
|
class ChannelRole(AbstractModel):
|
|
7180
|
-
"""
|
|
7627
|
+
"""角色信息
|
|
7181
7628
|
|
|
7182
7629
|
"""
|
|
7183
7630
|
|
|
7184
7631
|
def __init__(self):
|
|
7185
7632
|
r"""
|
|
7186
|
-
:param _RoleId: 角色
|
|
7633
|
+
:param _RoleId: 角色ID,为32位字符串
|
|
7187
7634
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
7188
7635
|
:type RoleId: str
|
|
7189
|
-
:param _RoleName:
|
|
7636
|
+
:param _RoleName: 角色的名称
|
|
7190
7637
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
7191
7638
|
:type RoleName: str
|
|
7192
|
-
:param _RoleStatus:
|
|
7193
|
-
|
|
7639
|
+
:param _RoleStatus: 此角色状态
|
|
7640
|
+
1: 已经启用
|
|
7641
|
+
2: 已经禁用
|
|
7194
7642
|
:type RoleStatus: int
|
|
7195
|
-
:param _PermissionGroups:
|
|
7643
|
+
:param _PermissionGroups: 此角色对应的权限列表
|
|
7196
7644
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
7197
7645
|
:type PermissionGroups: list of PermissionGroup
|
|
7198
7646
|
"""
|
|
@@ -7261,9 +7709,10 @@ class ChannelUpdateSealStatusRequest(AbstractModel):
|
|
|
7261
7709
|
|
|
7262
7710
|
def __init__(self):
|
|
7263
7711
|
r"""
|
|
7264
|
-
:param _Agent:
|
|
7712
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
7265
7713
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
7266
|
-
:param _Status:
|
|
7714
|
+
:param _Status: 印章状态,目前支持传入以下类型:
|
|
7715
|
+
<ul><li>DISABLE-停用印章</li></ul>
|
|
7267
7716
|
:type Status: str
|
|
7268
7717
|
:param _SealId: 印章ID
|
|
7269
7718
|
:type SealId: str
|
|
@@ -8998,9 +9447,9 @@ class CreateFlowsByTemplatesRequest(AbstractModel):
|
|
|
8998
9447
|
|
|
8999
9448
|
此接口下面信息必填。
|
|
9000
9449
|
<ul>
|
|
9001
|
-
<li>渠道应用标识: Agent.
|
|
9002
|
-
<li>第三方平台子客企业标识: Agent.
|
|
9003
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
9450
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
9451
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
9452
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
9004
9453
|
</ul>
|
|
9005
9454
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
9006
9455
|
:param _FlowInfos: 要创建的合同信息列表,最多支持一次创建20个合同
|
|
@@ -10488,7 +10937,7 @@ class DescribeTemplatesRequest(AbstractModel):
|
|
|
10488
10937
|
|
|
10489
10938
|
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
|
10490
10939
|
:type TemplateId: str
|
|
10491
|
-
:param _ContentType:
|
|
10940
|
+
:param _ContentType: 查询模板的内容
|
|
10492
10941
|
|
|
10493
10942
|
<ul><li>**0**:(默认)模板列表及详情</li>
|
|
10494
10943
|
<li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
|
@@ -10766,20 +11215,33 @@ class DescribeUsageRequest(AbstractModel):
|
|
|
10766
11215
|
|
|
10767
11216
|
def __init__(self):
|
|
10768
11217
|
r"""
|
|
10769
|
-
:param _Agent:
|
|
11218
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
11219
|
+
|
|
11220
|
+
此接口下面信息必填。
|
|
11221
|
+
<ul>
|
|
11222
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
11223
|
+
</ul>
|
|
10770
11224
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
10771
|
-
:param _StartDate:
|
|
11225
|
+
:param _StartDate: 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-03-21)
|
|
11226
|
+
|
|
11227
|
+
注: `查询日期范围区间长度大于90天`。
|
|
10772
11228
|
:type StartDate: str
|
|
10773
|
-
:param _EndDate:
|
|
10774
|
-
|
|
11229
|
+
:param _EndDate: 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-04-21)
|
|
11230
|
+
|
|
11231
|
+
注: `查询日期范围区间长度大于90天`。
|
|
10775
11232
|
:type EndDate: str
|
|
10776
11233
|
:param _NeedAggregate: 是否汇总数据,默认不汇总。
|
|
10777
|
-
|
|
10778
|
-
|
|
11234
|
+
<ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
|
|
11235
|
+
<li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
|
|
11236
|
+
|
|
10779
11237
|
:type NeedAggregate: bool
|
|
10780
|
-
:param _Limit:
|
|
11238
|
+
:param _Limit: 指定每页返回的数据条数,和Offset参数配合使用。
|
|
11239
|
+
|
|
11240
|
+
注: `默认值为1000,单页做大值为1000`
|
|
10781
11241
|
:type Limit: int
|
|
10782
|
-
:param _Offset:
|
|
11242
|
+
:param _Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
|
|
11243
|
+
|
|
11244
|
+
注:`offset从0开始,即第一页为0。`
|
|
10783
11245
|
:type Offset: int
|
|
10784
11246
|
:param _Operator: 暂未开放
|
|
10785
11247
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
@@ -10984,17 +11446,19 @@ class ExtentServiceAuthInfo(AbstractModel):
|
|
|
10984
11446
|
r"""
|
|
10985
11447
|
:param _Type: 扩展服务类型
|
|
10986
11448
|
<ul>
|
|
10987
|
-
|
|
11449
|
+
<li>AUTO_SIGN 企业自动签(自动签署)</li>
|
|
10988
11450
|
<li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
|
|
10989
11451
|
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
|
|
10990
|
-
|
|
10991
|
-
|
|
11452
|
+
<li> PAGING_SEAL 骑缝章</li>
|
|
11453
|
+
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
|
|
10992
11454
|
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
|
|
10993
11455
|
</ul>
|
|
10994
11456
|
:type Type: str
|
|
10995
11457
|
:param _Name: 扩展服务名称
|
|
10996
11458
|
:type Name: str
|
|
10997
|
-
:param _Status:
|
|
11459
|
+
:param _Status: 扩展服务的开通状态
|
|
11460
|
+
**ENABLE**:开通
|
|
11461
|
+
**DISABLE**:未开通
|
|
10998
11462
|
:type Status: str
|
|
10999
11463
|
:param _OperatorOpenId: 操作扩展服务的操作人第三方应用平台的用户openid
|
|
11000
11464
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
@@ -11274,20 +11738,19 @@ class FilledComponent(AbstractModel):
|
|
|
11274
11738
|
|
|
11275
11739
|
def __init__(self):
|
|
11276
11740
|
r"""
|
|
11277
|
-
:param _ComponentId:
|
|
11278
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
11741
|
+
:param _ComponentId: 填写控件ID
|
|
11279
11742
|
:type ComponentId: str
|
|
11280
11743
|
:param _ComponentName: 控件名称
|
|
11281
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
11282
11744
|
:type ComponentName: str
|
|
11283
|
-
:param _ComponentFillStatus:
|
|
11284
|
-
|
|
11745
|
+
:param _ComponentFillStatus: 此填写控件的填写状态
|
|
11746
|
+
**0** : 此填写控件**未填写**
|
|
11747
|
+
**1** : 此填写控件**已填写**
|
|
11285
11748
|
:type ComponentFillStatus: str
|
|
11286
11749
|
:param _ComponentValue: 控件填写内容
|
|
11287
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
11288
11750
|
:type ComponentValue: str
|
|
11289
11751
|
:param _ImageUrl: 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
|
|
11290
|
-
|
|
11752
|
+
|
|
11753
|
+
注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
|
|
11291
11754
|
:type ImageUrl: str
|
|
11292
11755
|
"""
|
|
11293
11756
|
self._ComponentId = None
|
|
@@ -11688,7 +12151,7 @@ class FlowApproverInfo(AbstractModel):
|
|
|
11688
12151
|
<ul><li> **PERSON** :个人/自然人</li>
|
|
11689
12152
|
<li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li>
|
|
11690
12153
|
<li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li>
|
|
11691
|
-
<li> **ENTERPRISESERVER**
|
|
12154
|
+
<li> **ENTERPRISESERVER** :企业/企业员工自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
|
|
11692
12155
|
|
|
11693
12156
|
注:
|
|
11694
12157
|
`1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
|
|
@@ -13663,32 +14126,35 @@ class OperateChannelTemplateRequest(AbstractModel):
|
|
|
13663
14126
|
<li>第三方平台子客企业中的员工标识: Agent.AppId</li>
|
|
13664
14127
|
</ul>
|
|
13665
14128
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
13666
|
-
:param _OperateType:
|
|
14129
|
+
:param _OperateType: 操作类型,可取值如下:
|
|
13667
14130
|
<ul>
|
|
13668
|
-
<li
|
|
13669
|
-
<li
|
|
13670
|
-
<li
|
|
14131
|
+
<li>SELECT: 查询</li>
|
|
14132
|
+
<li>DELETE: 删除</li>
|
|
14133
|
+
<li>UPDATE: 更新</li>
|
|
13671
14134
|
</ul>
|
|
13672
14135
|
:type OperateType: str
|
|
13673
|
-
:param _TemplateId: 合同模板ID,为32
|
|
14136
|
+
:param _TemplateId: 合同模板ID,为32位字符串。
|
|
14137
|
+
注: ` 此处为第三方应用平台模板库模板ID,非子客模板ID`
|
|
13674
14138
|
:type TemplateId: str
|
|
13675
|
-
:param _ProxyOrganizationOpenIds:
|
|
13676
|
-
|
|
13677
|
-
一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
|
|
14139
|
+
:param _ProxyOrganizationOpenIds: 第三方平台子客企业的唯一标识,支持批量(用,分割),
|
|
13678
14140
|
:type ProxyOrganizationOpenIds: str
|
|
13679
|
-
:param _AuthTag:
|
|
13680
|
-
|
|
13681
|
-
|
|
13682
|
-
|
|
13683
|
-
|
|
14141
|
+
:param _AuthTag: 模板可见范围, 可以设置的值如下:
|
|
14142
|
+
|
|
14143
|
+
**all**: 所有本第三方应用合作企业可见
|
|
14144
|
+
**part**: 指定的本第三方应用合作企业
|
|
14145
|
+
|
|
14146
|
+
对应控制台的位置
|
|
14147
|
+

|
|
14148
|
+
|
|
13684
14149
|
:type AuthTag: str
|
|
13685
14150
|
:param _Available: 当OperateType=UPDATE时,可以通过设置此字段对模板启停用状态进行操作。
|
|
13686
14151
|
<ul>
|
|
13687
|
-
<li
|
|
13688
|
-
<li>1
|
|
13689
|
-
<li>2
|
|
14152
|
+
<li>0: 不修改模板可用状态</li>
|
|
14153
|
+
<li>1: 启用模板</li>
|
|
14154
|
+
<li>2: 停用模板</li>
|
|
13690
14155
|
</ul>
|
|
13691
14156
|
启用后模板可以正常领取。
|
|
14157
|
+
|
|
13692
14158
|
停用后,推送方式为【自动推送】的模板则无法被子客使用,推送方式为【手动领取】的模板则无法出现被模板库被子客领用。
|
|
13693
14159
|
如果Available更新失败,会直接返回错误。
|
|
13694
14160
|
:type Available: int
|
|
@@ -13793,30 +14259,26 @@ class OperateChannelTemplateResponse(AbstractModel):
|
|
|
13793
14259
|
|
|
13794
14260
|
def __init__(self):
|
|
13795
14261
|
r"""
|
|
13796
|
-
:param _AppId:
|
|
14262
|
+
:param _AppId: 第三方应用平台的应用ID
|
|
13797
14263
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
13798
14264
|
:type AppId: str
|
|
13799
|
-
:param _TemplateId: 合同模板ID
|
|
14265
|
+
:param _TemplateId: 合同模板ID
|
|
13800
14266
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
13801
14267
|
:type TemplateId: str
|
|
13802
|
-
:param _OperateResult:
|
|
14268
|
+
:param _OperateResult: 描述模板可见性更改的结果。
|
|
13803
14269
|
<ul>
|
|
13804
|
-
<li
|
|
13805
|
-
<li
|
|
13806
|
-
<li
|
|
14270
|
+
<li>all-success: 全部成功</li>
|
|
14271
|
+
<li>part-success: 部分成功,失败的会在FailMessageList中展示</li>
|
|
14272
|
+
<li>fail:全部失败, 失败的会在FailMessageList中展示</li>
|
|
13807
14273
|
</ul>
|
|
13808
14274
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
13809
14275
|
:type OperateResult: str
|
|
13810
|
-
:param _AuthTag:
|
|
13811
|
-
|
|
13812
|
-
|
|
13813
|
-
<li>部分可见-"part"</li>
|
|
13814
|
-
</ul>
|
|
14276
|
+
:param _AuthTag: 模板可见范围:
|
|
14277
|
+
**all**: 所有本第三方应用合作企业可见
|
|
14278
|
+
**part**: 指定的本第三方应用合作企业
|
|
13815
14279
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
13816
14280
|
:type AuthTag: str
|
|
13817
|
-
:param _ProxyOrganizationOpenIds:
|
|
13818
|
-
|
|
13819
|
-
一个第三方平台子客企业主体与子客企业 ProxyOrganizationOpenId 是一一对应的,不可更改,不可重复使用。例如,可以使用企业名称的哈希值,或者社会统一信用代码的哈希值,或者随机哈希值。
|
|
14281
|
+
:param _ProxyOrganizationOpenIds: 第三方平台子客企业标识列表
|
|
13820
14282
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
13821
14283
|
:type ProxyOrganizationOpenIds: list of str
|
|
13822
14284
|
:param _FailMessageList: 操作失败信息数组
|
|
@@ -14810,16 +15272,20 @@ class RecipientComponentInfo(AbstractModel):
|
|
|
14810
15272
|
|
|
14811
15273
|
def __init__(self):
|
|
14812
15274
|
r"""
|
|
14813
|
-
:param _RecipientId:
|
|
14814
|
-
注意:此字段可能返回 null,表示取不到有效值。
|
|
15275
|
+
:param _RecipientId: 参与方的角色ID
|
|
14815
15276
|
:type RecipientId: str
|
|
14816
15277
|
:param _RecipientFillStatus: 参与方填写状态
|
|
14817
|
-
|
|
15278
|
+
|
|
15279
|
+
<ul><li> **0** : 还没有填写</li>
|
|
15280
|
+
<li> **1** : 已经填写</li></ul>
|
|
14818
15281
|
:type RecipientFillStatus: str
|
|
14819
|
-
:param _IsPromoter:
|
|
15282
|
+
:param _IsPromoter: 此角色是否是发起方角色
|
|
15283
|
+
|
|
15284
|
+
<ul><li> **true** : 是发起方角色</li>
|
|
15285
|
+
<li> **false** : 不是发起方角色</li></ul>
|
|
14820
15286
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
14821
15287
|
:type IsPromoter: bool
|
|
14822
|
-
:param _Components:
|
|
15288
|
+
:param _Components: 此角色的填写控件列表
|
|
14823
15289
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
14824
15290
|
:type Components: list of FilledComponent
|
|
14825
15291
|
"""
|
|
@@ -15267,10 +15733,13 @@ class SignQrCode(AbstractModel):
|
|
|
15267
15733
|
def __init__(self):
|
|
15268
15734
|
r"""
|
|
15269
15735
|
:param _QrCodeId: 二维码ID,为32位字符串。
|
|
15736
|
+
|
|
15737
|
+
注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
|
|
15270
15738
|
:type QrCodeId: str
|
|
15271
15739
|
:param _QrCodeUrl: 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
|
|
15272
15740
|
:type QrCodeUrl: str
|
|
15273
|
-
:param _ExpiredTime: 二维码的有截止时间,格式为Unix
|
|
15741
|
+
:param _ExpiredTime: 二维码的有截止时间,格式为Unix标准时间戳(秒),可以通过入参的QrEffectiveDay来设置有效期,默认为7天有效期。
|
|
15742
|
+
一旦超过二维码的有效期限,该二维码将自动失效。
|
|
15274
15743
|
:type ExpiredTime: int
|
|
15275
15744
|
"""
|
|
15276
15745
|
self._QrCodeId = None
|
|
@@ -16687,17 +17156,17 @@ class UsageDetail(AbstractModel):
|
|
|
16687
17156
|
|
|
16688
17157
|
def __init__(self):
|
|
16689
17158
|
r"""
|
|
16690
|
-
:param _ProxyOrganizationOpenId:
|
|
17159
|
+
:param _ProxyOrganizationOpenId: 子客企业标识
|
|
16691
17160
|
:type ProxyOrganizationOpenId: str
|
|
16692
17161
|
:param _ProxyOrganizationName: 子客企业名
|
|
16693
17162
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
16694
17163
|
:type ProxyOrganizationName: str
|
|
16695
|
-
:param _Date:
|
|
17164
|
+
:param _Date: 对应的消耗日期, **如果是汇总数据则为1970-01-01**
|
|
16696
17165
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
16697
17166
|
:type Date: str
|
|
16698
|
-
:param _Usage:
|
|
17167
|
+
:param _Usage: 消耗合同数量
|
|
16699
17168
|
:type Usage: int
|
|
16700
|
-
:param _Cancel:
|
|
17169
|
+
:param _Cancel: 撤回合同数量
|
|
16701
17170
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
16702
17171
|
:type Cancel: int
|
|
16703
17172
|
:param _FlowChannel: 消耗渠道
|