tencentcloud-sdk-nodejs-essbasic 4.0.550 → 4.0.553
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.
- package/CHANGELOG.md +516 -0
- package/SERVICE_CHANGELOG.md +641 -348
- package/package.json +1 -1
- package/products.md +39 -38
- package/src/services/essbasic/v20210526/essbasic_client.ts +11 -11
- package/src/services/essbasic/v20210526/essbasic_models.ts +70 -62
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +11 -11
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +11 -11
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +69 -62
|
@@ -101,7 +101,7 @@ export interface ChannelBatchCancelFlowsResponse {
|
|
|
101
101
|
}
|
|
102
102
|
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* 第三方应用集成员工部门信息
|
|
105
105
|
*/
|
|
106
106
|
export interface Department {
|
|
107
107
|
/**
|
|
@@ -297,13 +297,13 @@ export interface CreateSealByImageResponse {
|
|
|
297
297
|
*/
|
|
298
298
|
export interface OperateChannelTemplateResponse {
|
|
299
299
|
/**
|
|
300
|
-
*
|
|
300
|
+
* 腾讯电子签颁发给第三方应用平台的应用ID
|
|
301
301
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
302
302
|
*/
|
|
303
303
|
AppId?: string
|
|
304
304
|
|
|
305
305
|
/**
|
|
306
|
-
*
|
|
306
|
+
* 第三方应用平台模板库模板唯一标识
|
|
307
307
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
308
308
|
*/
|
|
309
309
|
TemplateId?: string
|
|
@@ -378,7 +378,7 @@ export interface FlowFileInfo {
|
|
|
378
378
|
CallbackUrl?: string
|
|
379
379
|
|
|
380
380
|
/**
|
|
381
|
-
*
|
|
381
|
+
* 第三方应用的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
382
382
|
*/
|
|
383
383
|
CustomerData?: string
|
|
384
384
|
|
|
@@ -403,7 +403,7 @@ export interface FlowFileInfo {
|
|
|
403
403
|
*/
|
|
404
404
|
export interface CreateConsoleLoginUrlResponse {
|
|
405
405
|
/**
|
|
406
|
-
*
|
|
406
|
+
* 子客企业Web控制台url注意事项:
|
|
407
407
|
1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
|
|
408
408
|
2. 若企业认证完成且员工认证完成后,重新获取pc端的链接5分钟之内有效,且只能访问一次
|
|
409
409
|
3. 若企业认证完成且员工认证完成后,重新获取H5/APP的链接只要在有效期内(一年)都可以访问
|
|
@@ -413,7 +413,7 @@ export interface CreateConsoleLoginUrlResponse {
|
|
|
413
413
|
ConsoleUrl?: string
|
|
414
414
|
|
|
415
415
|
/**
|
|
416
|
-
*
|
|
416
|
+
* 子客企业是否已开通腾讯电子签
|
|
417
417
|
*/
|
|
418
418
|
IsActivated?: boolean
|
|
419
419
|
|
|
@@ -439,7 +439,7 @@ export interface SyncProxyOrganizationRequest {
|
|
|
439
439
|
Agent: Agent
|
|
440
440
|
|
|
441
441
|
/**
|
|
442
|
-
*
|
|
442
|
+
* 第三方平台子客企业名称,最大长度64个字符
|
|
443
443
|
*/
|
|
444
444
|
ProxyOrganizationName: string
|
|
445
445
|
|
|
@@ -449,12 +449,12 @@ export interface SyncProxyOrganizationRequest {
|
|
|
449
449
|
BusinessLicense?: string
|
|
450
450
|
|
|
451
451
|
/**
|
|
452
|
-
*
|
|
452
|
+
* 第三方平台子客企业统一社会信用代码,最大长度200个字符
|
|
453
453
|
*/
|
|
454
454
|
UniformSocialCreditCode?: string
|
|
455
455
|
|
|
456
456
|
/**
|
|
457
|
-
*
|
|
457
|
+
* 第三方平台子客企业法人/负责人姓名
|
|
458
458
|
*/
|
|
459
459
|
ProxyLegalName?: string
|
|
460
460
|
|
|
@@ -664,7 +664,7 @@ export interface ChannelCreateFlowByFilesRequest {
|
|
|
664
664
|
CustomShowMap?: string
|
|
665
665
|
|
|
666
666
|
/**
|
|
667
|
-
*
|
|
667
|
+
* 业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
668
668
|
*/
|
|
669
669
|
CustomerData?: string
|
|
670
670
|
|
|
@@ -702,17 +702,17 @@ export interface Agent {
|
|
|
702
702
|
AppId: string
|
|
703
703
|
|
|
704
704
|
/**
|
|
705
|
-
*
|
|
705
|
+
* 第三方应用平台自定义,对应第三方平台子客企业的唯一标识。一个第三方平台子客企业主体与子客企业ProxyOrganizationOpenId是一一对应的,不可更改,不可重复使用。(例如,可以使用企业名称的hash值,或者社会统一信用代码的hash值,或者随机hash值,需要第三方应用平台保存),最大64位字符串
|
|
706
706
|
*/
|
|
707
707
|
ProxyOrganizationOpenId?: string
|
|
708
708
|
|
|
709
709
|
/**
|
|
710
|
-
*
|
|
710
|
+
* 第三方平台子客企业中的员工/经办人,通过第三方应用平台进入电子签完成实名、且被赋予相关权限后,可以参与到企业资源的管理或签署流程中。
|
|
711
711
|
*/
|
|
712
712
|
ProxyOperator?: UserInfo
|
|
713
713
|
|
|
714
714
|
/**
|
|
715
|
-
*
|
|
715
|
+
* 在第三方平台子客企业开通电子签后,会生成唯一的子客应用Id(ProxyAppId)用于代理调用时的鉴权,在子客开通的回调中获取。
|
|
716
716
|
*/
|
|
717
717
|
ProxyAppId?: string
|
|
718
718
|
|
|
@@ -732,18 +732,18 @@ export interface FlowApproverDetail {
|
|
|
732
732
|
ReceiptId: string
|
|
733
733
|
|
|
734
734
|
/**
|
|
735
|
-
*
|
|
735
|
+
* 平台企业的第三方id
|
|
736
736
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
737
737
|
*/
|
|
738
738
|
ProxyOrganizationOpenId: string
|
|
739
739
|
|
|
740
740
|
/**
|
|
741
|
-
*
|
|
741
|
+
* 平台企业操作人的第三方id
|
|
742
742
|
*/
|
|
743
743
|
ProxyOperatorOpenId: string
|
|
744
744
|
|
|
745
745
|
/**
|
|
746
|
-
*
|
|
746
|
+
* 平台企业名称
|
|
747
747
|
*/
|
|
748
748
|
ProxyOrganizationName: string
|
|
749
749
|
|
|
@@ -855,12 +855,12 @@ MobileCheck:手机号验证
|
|
|
855
855
|
*/
|
|
856
856
|
export interface DescribeFlowDetailInfoResponse {
|
|
857
857
|
/**
|
|
858
|
-
*
|
|
858
|
+
* 第三方平台应用号Id
|
|
859
859
|
*/
|
|
860
860
|
ApplicationId?: string
|
|
861
861
|
|
|
862
862
|
/**
|
|
863
|
-
*
|
|
863
|
+
* 第三方平台子客企业OpenId
|
|
864
864
|
*/
|
|
865
865
|
ProxyOrganizationOpenId?: string
|
|
866
866
|
|
|
@@ -917,9 +917,9 @@ export interface ResourceUrlInfo {
|
|
|
917
917
|
其中签署方FlowApproverInfo需要传递的参数
|
|
918
918
|
非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。其他身份标识
|
|
919
919
|
1-个人:Name、Mobile必传
|
|
920
|
-
2
|
|
921
|
-
3
|
|
922
|
-
4
|
|
920
|
+
2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;
|
|
921
|
+
3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;
|
|
922
|
+
4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。
|
|
923
923
|
|
|
924
924
|
RecipientId参数:
|
|
925
925
|
从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId
|
|
@@ -954,19 +954,19 @@ export interface FlowApproverInfo {
|
|
|
954
954
|
OrganizationName?: string
|
|
955
955
|
|
|
956
956
|
/**
|
|
957
|
-
*
|
|
958
|
-
默认为false
|
|
957
|
+
* 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
|
|
958
|
+
默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
|
|
959
959
|
*/
|
|
960
960
|
NotChannelOrganization?: boolean
|
|
961
961
|
|
|
962
962
|
/**
|
|
963
963
|
* 用户侧第三方id,最大长度64个字符
|
|
964
|
-
|
|
964
|
+
当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
|
|
965
965
|
*/
|
|
966
966
|
OpenId?: string
|
|
967
967
|
|
|
968
968
|
/**
|
|
969
|
-
*
|
|
969
|
+
* 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
|
|
970
970
|
*/
|
|
971
971
|
OrganizationOpenId?: string
|
|
972
972
|
|
|
@@ -1102,24 +1102,24 @@ export interface TemplateInfo {
|
|
|
1102
1102
|
PreviewUrl: string
|
|
1103
1103
|
|
|
1104
1104
|
/**
|
|
1105
|
-
*
|
|
1105
|
+
* 第三方应用集成-模板PDF文件链接
|
|
1106
1106
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1107
1107
|
*/
|
|
1108
1108
|
PdfUrl: string
|
|
1109
1109
|
|
|
1110
1110
|
/**
|
|
1111
|
-
*
|
|
1111
|
+
* 关联的平台企业模板ID
|
|
1112
1112
|
*/
|
|
1113
1113
|
ChannelTemplateId: string
|
|
1114
1114
|
|
|
1115
1115
|
/**
|
|
1116
|
-
*
|
|
1116
|
+
* 关联的平台企业模板名称
|
|
1117
1117
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1118
1118
|
*/
|
|
1119
1119
|
ChannelTemplateName: string
|
|
1120
1120
|
|
|
1121
1121
|
/**
|
|
1122
|
-
* 0
|
|
1122
|
+
* 0-需要子客企业手动领取平台企业的模板(默认); 1-平台自动设置子客模板
|
|
1123
1123
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
1124
1124
|
*/
|
|
1125
1125
|
ChannelAutoSave: number
|
|
@@ -1227,7 +1227,7 @@ export interface DescribeTemplatesResponse {
|
|
|
1227
1227
|
}
|
|
1228
1228
|
|
|
1229
1229
|
/**
|
|
1230
|
-
*
|
|
1230
|
+
* 第三方应用集成员工角色信息
|
|
1231
1231
|
*/
|
|
1232
1232
|
export interface StaffRole {
|
|
1233
1233
|
/**
|
|
@@ -1315,12 +1315,12 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
1315
1315
|
Agent: Agent
|
|
1316
1316
|
|
|
1317
1317
|
/**
|
|
1318
|
-
*
|
|
1318
|
+
* 子客企业名称,最大长度64个字符
|
|
1319
1319
|
*/
|
|
1320
1320
|
ProxyOrganizationName: string
|
|
1321
1321
|
|
|
1322
1322
|
/**
|
|
1323
|
-
*
|
|
1323
|
+
* 子客企业经办人的姓名,最大长度50个字符
|
|
1324
1324
|
*/
|
|
1325
1325
|
ProxyOperatorName?: string
|
|
1326
1326
|
|
|
@@ -1335,7 +1335,7 @@ export interface CreateConsoleLoginUrlRequest {
|
|
|
1335
1335
|
ModuleId?: string
|
|
1336
1336
|
|
|
1337
1337
|
/**
|
|
1338
|
-
*
|
|
1338
|
+
* 子客企业统一社会信用代码,最大长度200个字符
|
|
1339
1339
|
*/
|
|
1340
1340
|
UniformSocialCreditCode?: string
|
|
1341
1341
|
|
|
@@ -1495,7 +1495,7 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
|
|
|
1495
1495
|
*/
|
|
1496
1496
|
export interface UploadFilesRequest {
|
|
1497
1497
|
/**
|
|
1498
|
-
*
|
|
1498
|
+
* 应用相关信息,若是第三方应用集成调用 appid 和proxyappid 必填
|
|
1499
1499
|
*/
|
|
1500
1500
|
Agent: Agent
|
|
1501
1501
|
|
|
@@ -1580,8 +1580,8 @@ export interface DescribeUsageRequest {
|
|
|
1580
1580
|
|
|
1581
1581
|
/**
|
|
1582
1582
|
* 是否汇总数据,默认不汇总。
|
|
1583
|
-
|
|
1584
|
-
|
|
1583
|
+
不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
|
|
1584
|
+
汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
|
|
1585
1585
|
*/
|
|
1586
1586
|
NeedAggregate?: boolean
|
|
1587
1587
|
|
|
@@ -1648,7 +1648,7 @@ CreateFlowsByTemplates 接口不使用此字段。
|
|
|
1648
1648
|
* 此结构体 (FlowInfo) 用于描述签署流程信息。
|
|
1649
1649
|
|
|
1650
1650
|
【数据表格传参说明】
|
|
1651
|
-
当模板的 ComponentType='DYNAMIC_TABLE'
|
|
1651
|
+
当模板的 ComponentType='DYNAMIC_TABLE'时( 第三方应用集成或集成版),FormField.ComponentValue需要传递json格式的字符串参数,用于确定表头&填充数据表格(支持内容的单元格合并)
|
|
1652
1652
|
输入示例1:
|
|
1653
1653
|
|
|
1654
1654
|
```
|
|
@@ -1759,7 +1759,6 @@ CreateFlowsByTemplates 接口不使用此字段。
|
|
|
1759
1759
|
| ------------------- | ------- | ------------------------------------------------- |
|
|
1760
1760
|
| widthPercent | Integer | 表头单元格列占总表头的比例,例如1:30表示 此列占表头的30%,不填写时列宽度平均拆分;例如2:总2列,某一列填写40,剩余列可以为空,按照60计算。;例如3:总3列,某一列填写30,剩余2列可以为空,分别为(100-30)/2=35 |
|
|
1761
1761
|
| content | String | 表头单元格内容,字数不超过100 |
|
|
1762
|
-
|
|
1763
1762
|
*/
|
|
1764
1763
|
export interface FlowInfo {
|
|
1765
1764
|
/**
|
|
@@ -1803,7 +1802,7 @@ export interface FlowInfo {
|
|
|
1803
1802
|
FlowDescription?: string
|
|
1804
1803
|
|
|
1805
1804
|
/**
|
|
1806
|
-
*
|
|
1805
|
+
* 第三方应用平台的业务信息,最大长度1000个字符。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
|
|
1807
1806
|
*/
|
|
1808
1807
|
CustomerData?: string
|
|
1809
1808
|
|
|
@@ -1831,7 +1830,7 @@ export interface FlowInfo {
|
|
|
1831
1830
|
*/
|
|
1832
1831
|
export interface UserInfo {
|
|
1833
1832
|
/**
|
|
1834
|
-
*
|
|
1833
|
+
* 第三方应用平台自定义,对应第三方平台子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
|
|
1835
1834
|
*/
|
|
1836
1835
|
OpenId?: string
|
|
1837
1836
|
|
|
@@ -2094,15 +2093,15 @@ export interface CreateSignUrlsRequest {
|
|
|
2094
2093
|
/**
|
|
2095
2094
|
* 签署链接生成类型,默认是 "ALL";
|
|
2096
2095
|
"ALL":全部签署方签署链接,此时不会给自动签署的签署方创建签署链接;
|
|
2097
|
-
"CHANNEL"
|
|
2098
|
-
"NOT_CHANNEL"
|
|
2096
|
+
"CHANNEL":第三方平台子客企业企业;
|
|
2097
|
+
"NOT_CHANNEL":非第三方平台子客企业企业;
|
|
2099
2098
|
"PERSON":个人;
|
|
2100
2099
|
"FOLLOWER":关注方,目前是合同抄送方;
|
|
2101
2100
|
*/
|
|
2102
2101
|
GenerateType?: string
|
|
2103
2102
|
|
|
2104
2103
|
/**
|
|
2105
|
-
*
|
|
2104
|
+
* 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
|
|
2106
2105
|
*/
|
|
2107
2106
|
OrganizationName?: string
|
|
2108
2107
|
|
|
@@ -2118,12 +2117,12 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
|
|
|
2118
2117
|
Mobile?: string
|
|
2119
2118
|
|
|
2120
2119
|
/**
|
|
2121
|
-
*
|
|
2120
|
+
* 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
|
|
2122
2121
|
*/
|
|
2123
2122
|
OrganizationOpenId?: string
|
|
2124
2123
|
|
|
2125
2124
|
/**
|
|
2126
|
-
*
|
|
2125
|
+
* 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
|
|
2127
2126
|
*/
|
|
2128
2127
|
OpenId?: string
|
|
2129
2128
|
|
|
@@ -2185,7 +2184,7 @@ export interface ChannelCreateMultiFlowSignQRCodeRequest {
|
|
|
2185
2184
|
|
|
2186
2185
|
/**
|
|
2187
2186
|
* 回调地址,最大长度1000个字符
|
|
2188
|
-
|
|
2187
|
+
不传默认使用第三方应用号配置的回调地址
|
|
2189
2188
|
回调时机:用户通过签署二维码发起合同时,企业额度不足导致失败
|
|
2190
2189
|
*/
|
|
2191
2190
|
CallbackUrl?: string
|
|
@@ -2306,7 +2305,7 @@ export interface CreateFlowsByTemplatesResponse {
|
|
|
2306
2305
|
FlowIds?: Array<string>
|
|
2307
2306
|
|
|
2308
2307
|
/**
|
|
2309
|
-
*
|
|
2308
|
+
* 业务信息,限制1024字符
|
|
2310
2309
|
*/
|
|
2311
2310
|
CustomerData?: Array<string>
|
|
2312
2311
|
|
|
@@ -2555,8 +2554,8 @@ export interface Filter {
|
|
|
2555
2554
|
如果需要指定B端(机构身份类型)签署人,其中ReleasedApprover需要传递的参数如下:
|
|
2556
2555
|
ApproverNumber, OrganizationName, ApproverType必传。
|
|
2557
2556
|
对于其他身份标识
|
|
2558
|
-
-
|
|
2559
|
-
-
|
|
2557
|
+
- 子客企业指定经办人:OpenId必传,OrganizationOpenId必传;
|
|
2558
|
+
- 非子客企业:Name、Mobile必传。
|
|
2560
2559
|
*/
|
|
2561
2560
|
export interface ReleasedApprover {
|
|
2562
2561
|
/**
|
|
@@ -2599,13 +2598,13 @@ ORGANIZATION-企业
|
|
|
2599
2598
|
Mobile?: string
|
|
2600
2599
|
|
|
2601
2600
|
/**
|
|
2602
|
-
*
|
|
2601
|
+
* 企业签署方在同一第三方应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符
|
|
2603
2602
|
*/
|
|
2604
2603
|
OrganizationOpenId?: string
|
|
2605
2604
|
|
|
2606
2605
|
/**
|
|
2607
2606
|
* 用户侧第三方id,最大长度64个字符
|
|
2608
|
-
|
|
2607
|
+
当签署方为同一第三方应用下的员工时,该字必传
|
|
2609
2608
|
*/
|
|
2610
2609
|
OpenId?: string
|
|
2611
2610
|
}
|
|
@@ -2637,17 +2636,17 @@ export interface UploadFilesResponse {
|
|
|
2637
2636
|
/**
|
|
2638
2637
|
* 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
|
|
2639
2638
|
*/
|
|
2640
|
-
FileIds
|
|
2639
|
+
FileIds?: Array<string>
|
|
2641
2640
|
|
|
2642
2641
|
/**
|
|
2643
2642
|
* 上传成功文件数量
|
|
2644
2643
|
*/
|
|
2645
|
-
TotalCount
|
|
2644
|
+
TotalCount?: number
|
|
2646
2645
|
|
|
2647
2646
|
/**
|
|
2648
2647
|
* 文件Url
|
|
2649
2648
|
*/
|
|
2650
|
-
FileUrls
|
|
2649
|
+
FileUrls?: Array<string>
|
|
2651
2650
|
|
|
2652
2651
|
/**
|
|
2653
2652
|
* 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -2888,7 +2887,7 @@ export interface ChannelCreateBoundFlowsResponse {
|
|
|
2888
2887
|
*/
|
|
2889
2888
|
export interface ProxyOrganizationOperator {
|
|
2890
2889
|
/**
|
|
2891
|
-
* 对应Agent-ProxyOperator-OpenId
|
|
2890
|
+
* 对应Agent-ProxyOperator-OpenId。第三方应用平台自定义,对子客企业员的唯一标识。一个OpenId在一个子客企业内唯一对应一个真实员工,不可在其他子客企业内重复使用。(例如,可以使用经办人企业名+员工身份证的hash值,需要第三方应用平台保存),最大64位字符串
|
|
2892
2891
|
*/
|
|
2893
2892
|
Id: string
|
|
2894
2893
|
|
|
@@ -2914,6 +2913,15 @@ export interface ProxyOrganizationOperator {
|
|
|
2914
2913
|
* 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
|
|
2915
2914
|
*/
|
|
2916
2915
|
Mobile?: string
|
|
2916
|
+
|
|
2917
|
+
/**
|
|
2918
|
+
* 默认角色,值为以下三个对应的英文:
|
|
2919
|
+
业务管理员:admin
|
|
2920
|
+
经办人:channel-normal-operator
|
|
2921
|
+
业务员:channel-sales-man
|
|
2922
|
+
注意:此字段可能返回 null,表示取不到有效值。
|
|
2923
|
+
*/
|
|
2924
|
+
DefaultRole?: string
|
|
2917
2925
|
}
|
|
2918
2926
|
|
|
2919
2927
|
/**
|
|
@@ -3234,8 +3242,8 @@ SIGN_PAGING_SEAL - 可以指定印章ID
|
|
|
3234
3242
|
OffsetY?: number
|
|
3235
3243
|
|
|
3236
3244
|
/**
|
|
3237
|
-
*
|
|
3238
|
-
|
|
3245
|
+
* 平台企业控件ID。
|
|
3246
|
+
如果不为空,属于平台企业预设控件;
|
|
3239
3247
|
*/
|
|
3240
3248
|
ChannelComponentId?: string
|
|
3241
3249
|
|
|
@@ -3449,12 +3457,12 @@ export interface DescribeTemplatesRequest {
|
|
|
3449
3457
|
WithPreviewUrl?: boolean
|
|
3450
3458
|
|
|
3451
3459
|
/**
|
|
3452
|
-
* 是否获取模板的PDF
|
|
3460
|
+
* 是否获取模板的PDF文件链接- 第三方应用集成需要开启白名单时才能使用。
|
|
3453
3461
|
*/
|
|
3454
3462
|
WithPdfUrl?: boolean
|
|
3455
3463
|
|
|
3456
3464
|
/**
|
|
3457
|
-
*
|
|
3465
|
+
* 模板ID
|
|
3458
3466
|
*/
|
|
3459
3467
|
ChannelTemplateId?: string
|
|
3460
3468
|
}
|
|
@@ -3587,12 +3595,12 @@ export interface CreateFlowsByTemplatesRequest {
|
|
|
3587
3595
|
*/
|
|
3588
3596
|
export interface UsageDetail {
|
|
3589
3597
|
/**
|
|
3590
|
-
*
|
|
3598
|
+
* 子客企业唯一标识
|
|
3591
3599
|
*/
|
|
3592
3600
|
ProxyOrganizationOpenId: string
|
|
3593
3601
|
|
|
3594
3602
|
/**
|
|
3595
|
-
*
|
|
3603
|
+
* 子客企业名
|
|
3596
3604
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
3597
3605
|
*/
|
|
3598
3606
|
ProxyOrganizationName: string
|
|
@@ -3661,7 +3669,7 @@ export interface OperateChannelTemplateRequest {
|
|
|
3661
3669
|
OperateType: string
|
|
3662
3670
|
|
|
3663
3671
|
/**
|
|
3664
|
-
*
|
|
3672
|
+
* 第三方应用平台模板库模板唯一标识
|
|
3665
3673
|
*/
|
|
3666
3674
|
TemplateId: string
|
|
3667
3675
|
|
|
@@ -27,7 +27,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
27
27
|
*/
|
|
28
28
|
ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
|
|
29
29
|
/**
|
|
30
|
-
*
|
|
30
|
+
* 通过图片为子客企业代创建印章,图片最大5MB
|
|
31
31
|
*/
|
|
32
32
|
CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
|
|
33
33
|
/**
|
|
@@ -47,7 +47,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
47
47
|
*/
|
|
48
48
|
ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
|
|
49
49
|
/**
|
|
50
|
-
* 此接口(DescribeUsage
|
|
50
|
+
* 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
|
|
51
51
|
注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
52
52
|
*/
|
|
53
53
|
DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
|
|
@@ -58,7 +58,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
58
58
|
*/
|
|
59
59
|
ChannelCancelFlow(req: ChannelCancelFlowRequest, cb?: (error: string, rep: ChannelCancelFlowResponse) => void): Promise<ChannelCancelFlowResponse>;
|
|
60
60
|
/**
|
|
61
|
-
*
|
|
61
|
+
* 将指定印章授权给第三方平台子客企业下的某些员工
|
|
62
62
|
*/
|
|
63
63
|
ChannelCreateSealPolicy(req: ChannelCreateSealPolicyRequest, cb?: (error: string, rep: ChannelCreateSealPolicyResponse) => void): Promise<ChannelCreateSealPolicyResponse>;
|
|
64
64
|
/**
|
|
@@ -87,14 +87,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
87
87
|
*/
|
|
88
88
|
CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
|
|
89
89
|
/**
|
|
90
|
-
* 此接口(CreateConsoleLoginUrl
|
|
90
|
+
* 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。
|
|
91
91
|
若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
|
92
92
|
若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
|
93
93
|
若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
|
94
94
|
*/
|
|
95
95
|
CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
|
|
96
96
|
/**
|
|
97
|
-
* 此接口(ChannelCreateBoundFlows
|
|
97
|
+
* 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
|
|
98
98
|
*/
|
|
99
99
|
ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
|
|
100
100
|
/**
|
|
@@ -116,7 +116,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
116
116
|
*/
|
|
117
117
|
CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
|
|
118
118
|
/**
|
|
119
|
-
* 本接口(ChannelUpdateSealStatus
|
|
119
|
+
* 本接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态
|
|
120
120
|
*/
|
|
121
121
|
ChannelUpdateSealStatus(req: ChannelUpdateSealStatusRequest, cb?: (error: string, rep: ChannelUpdateSealStatusResponse) => void): Promise<ChannelUpdateSealStatusResponse>;
|
|
122
122
|
/**
|
|
@@ -166,7 +166,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
166
166
|
*/
|
|
167
167
|
DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
|
|
168
168
|
/**
|
|
169
|
-
* 通过此接口(DescribeTemplates
|
|
169
|
+
* 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
|
|
170
170
|
*/
|
|
171
171
|
DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
|
|
172
172
|
/**
|
|
@@ -184,11 +184,11 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
184
184
|
*/
|
|
185
185
|
ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
|
|
186
186
|
/**
|
|
187
|
-
* 此接口(SyncProxyOrganization
|
|
187
|
+
* 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
|
|
188
188
|
*/
|
|
189
189
|
SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
|
|
190
190
|
/**
|
|
191
|
-
* 此接口(SyncProxyOrganizationOperators
|
|
191
|
+
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
192
192
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
193
193
|
*/
|
|
194
194
|
SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
|
|
@@ -197,9 +197,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
197
197
|
*/
|
|
198
198
|
DescribeChannelFlowEvidenceReport(req: DescribeChannelFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeChannelFlowEvidenceReportResponse) => void): Promise<DescribeChannelFlowEvidenceReportResponse>;
|
|
199
199
|
/**
|
|
200
|
-
* 此接口(OperateChannelTemplate
|
|
200
|
+
* 此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置,不会直接分配第三方应用平台模板给子客企业。
|
|
201
201
|
1、OperateType=select时:
|
|
202
|
-
|
|
202
|
+
查询第三方应用平台模板库
|
|
203
203
|
2、OperateType=update或者delete时:
|
|
204
204
|
对子客企业进行模板库中模板可见性的修改、删除操作。
|
|
205
205
|
*/
|
|
@@ -56,7 +56,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
56
56
|
return this.request("ChannelCreateFlowByFiles", req, cb);
|
|
57
57
|
}
|
|
58
58
|
/**
|
|
59
|
-
*
|
|
59
|
+
* 通过图片为子客企业代创建印章,图片最大5MB
|
|
60
60
|
*/
|
|
61
61
|
async CreateSealByImage(req, cb) {
|
|
62
62
|
return this.request("CreateSealByImage", req, cb);
|
|
@@ -86,7 +86,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
86
86
|
return this.request("ChannelCreateConvertTaskApi", req, cb);
|
|
87
87
|
}
|
|
88
88
|
/**
|
|
89
|
-
* 此接口(DescribeUsage
|
|
89
|
+
* 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
|
|
90
90
|
注: 此接口每日限频2次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
91
91
|
*/
|
|
92
92
|
async DescribeUsage(req, cb) {
|
|
@@ -101,7 +101,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
101
101
|
return this.request("ChannelCancelFlow", req, cb);
|
|
102
102
|
}
|
|
103
103
|
/**
|
|
104
|
-
*
|
|
104
|
+
* 将指定印章授权给第三方平台子客企业下的某些员工
|
|
105
105
|
*/
|
|
106
106
|
async ChannelCreateSealPolicy(req, cb) {
|
|
107
107
|
return this.request("ChannelCreateSealPolicy", req, cb);
|
|
@@ -136,7 +136,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
136
136
|
return this.request("CreateSignUrls", req, cb);
|
|
137
137
|
}
|
|
138
138
|
/**
|
|
139
|
-
* 此接口(CreateConsoleLoginUrl
|
|
139
|
+
* 此接口(CreateConsoleLoginUrl)用于创建第三方平台子客企业控制台Web/移动登录链接。登录链接是子客控制台的唯一入口。
|
|
140
140
|
若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
|
|
141
141
|
若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
|
|
142
142
|
若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
|
|
@@ -145,7 +145,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
145
145
|
return this.request("CreateConsoleLoginUrl", req, cb);
|
|
146
146
|
}
|
|
147
147
|
/**
|
|
148
|
-
* 此接口(ChannelCreateBoundFlows
|
|
148
|
+
* 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
|
|
149
149
|
*/
|
|
150
150
|
async ChannelCreateBoundFlows(req, cb) {
|
|
151
151
|
return this.request("ChannelCreateBoundFlows", req, cb);
|
|
@@ -175,7 +175,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
175
175
|
return this.request("CreateChannelFlowEvidenceReport", req, cb);
|
|
176
176
|
}
|
|
177
177
|
/**
|
|
178
|
-
* 本接口(ChannelUpdateSealStatus
|
|
178
|
+
* 本接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态
|
|
179
179
|
*/
|
|
180
180
|
async ChannelUpdateSealStatus(req, cb) {
|
|
181
181
|
return this.request("ChannelUpdateSealStatus", req, cb);
|
|
@@ -245,7 +245,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
245
245
|
return this.request("DescribeResourceUrlsByFlows", req, cb);
|
|
246
246
|
}
|
|
247
247
|
/**
|
|
248
|
-
* 通过此接口(DescribeTemplates
|
|
248
|
+
* 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板
|
|
249
249
|
*/
|
|
250
250
|
async DescribeTemplates(req, cb) {
|
|
251
251
|
return this.request("DescribeTemplates", req, cb);
|
|
@@ -269,13 +269,13 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
269
269
|
return this.request("ChannelCreateFlowReminds", req, cb);
|
|
270
270
|
}
|
|
271
271
|
/**
|
|
272
|
-
* 此接口(SyncProxyOrganization
|
|
272
|
+
* 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,主要是子客企业的营业执照,便于子客企业开通过程中不用手动上传。若有需要调用此接口,需要在创建控制链接CreateConsoleLoginUrl之后即刻进行调用。
|
|
273
273
|
*/
|
|
274
274
|
async SyncProxyOrganization(req, cb) {
|
|
275
275
|
return this.request("SyncProxyOrganization", req, cb);
|
|
276
276
|
}
|
|
277
277
|
/**
|
|
278
|
-
* 此接口(SyncProxyOrganizationOperators
|
|
278
|
+
* 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
279
279
|
若经办人信息有误,或者需要修改,也可以先将之前的经办人做离职操作,然后重新使用控制台链接CreateConsoleLoginUrl让经办人重新实名。
|
|
280
280
|
*/
|
|
281
281
|
async SyncProxyOrganizationOperators(req, cb) {
|
|
@@ -288,9 +288,9 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
288
288
|
return this.request("DescribeChannelFlowEvidenceReport", req, cb);
|
|
289
289
|
}
|
|
290
290
|
/**
|
|
291
|
-
* 此接口(OperateChannelTemplate
|
|
291
|
+
* 此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置,不会直接分配第三方应用平台模板给子客企业。
|
|
292
292
|
1、OperateType=select时:
|
|
293
|
-
|
|
293
|
+
查询第三方应用平台模板库
|
|
294
294
|
2、OperateType=update或者delete时:
|
|
295
295
|
对子客企业进行模板库中模板可见性的修改、删除操作。
|
|
296
296
|
*/
|