tencentcloud-sdk-nodejs 4.0.462 → 4.0.464

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.
Files changed (90) hide show
  1. package/CHANGELOG.md +659 -0
  2. package/SERVICE_CHANGELOG.md +961 -58
  3. package/package.json +1 -1
  4. package/products.md +23 -23
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/bma/v20210624/bma_client.ts +27 -3
  7. package/src/services/bma/v20210624/bma_models.ts +137 -17
  8. package/src/services/captcha/v20190722/captcha_client.ts +8 -4
  9. package/src/services/captcha/v20190722/captcha_models.ts +214 -42
  10. package/src/services/ckafka/v20190819/ckafka_models.ts +5 -0
  11. package/src/services/cpdp/v20190820/cpdp_client.ts +18 -2
  12. package/src/services/cpdp/v20190820/cpdp_models.ts +366 -33
  13. package/src/services/ess/v20201111/ess_models.ts +23 -17
  14. package/src/services/essbasic/v20210526/essbasic_client.ts +35 -15
  15. package/src/services/essbasic/v20210526/essbasic_models.ts +56 -25
  16. package/src/services/lcic/v20220817/lcic_client.ts +74 -25
  17. package/src/services/lcic/v20220817/lcic_models.ts +333 -137
  18. package/src/services/monitor/v20180724/monitor_client.ts +1 -0
  19. package/src/services/monitor/v20180724/monitor_models.ts +29 -0
  20. package/src/services/pts/v20210728/pts_models.ts +36 -0
  21. package/src/services/ses/v20201002/ses_client.ts +2 -2
  22. package/src/services/soe/v20180724/soe_models.ts +2 -2
  23. package/src/services/ssm/v20190923/ssm_models.ts +1 -1
  24. package/src/services/tcb/v20180608/tcb_client.ts +12 -0
  25. package/src/services/tcb/v20180608/tcb_models.ts +25 -0
  26. package/src/services/tcm/v20210413/tcm_client.ts +40 -16
  27. package/src/services/tcm/v20210413/tcm_models.ts +50 -0
  28. package/src/services/tcss/v20201101/tcss_client.ts +2008 -287
  29. package/src/services/tcss/v20201101/tcss_models.ts +12366 -4182
  30. package/src/services/teo/v20220901/teo_client.ts +2 -0
  31. package/src/services/teo/v20220901/teo_models.ts +68 -4
  32. package/src/services/tke/v20180525/tke_client.ts +3 -3
  33. package/src/services/tke/v20180525/tke_models.ts +38 -2
  34. package/src/services/trp/v20210515/trp_models.ts +12 -12
  35. package/src/services/trtc/v20190722/trtc_client.ts +8 -81
  36. package/src/services/trtc/v20190722/trtc_models.ts +107 -692
  37. package/src/services/wedata/v20210820/wedata_client.ts +79 -41
  38. package/src/services/wedata/v20210820/wedata_models.ts +417 -64
  39. package/tencentcloud/common/sdk_version.d.ts +1 -1
  40. package/tencentcloud/common/sdk_version.js +1 -1
  41. package/tencentcloud/services/bma/v20210624/bma_client.d.ts +11 -3
  42. package/tencentcloud/services/bma/v20210624/bma_client.js +14 -2
  43. package/tencentcloud/services/bma/v20210624/bma_models.d.ts +115 -15
  44. package/tencentcloud/services/captcha/v20190722/captcha_client.d.ts +2 -2
  45. package/tencentcloud/services/captcha/v20190722/captcha_models.d.ts +182 -38
  46. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +4 -0
  47. package/tencentcloud/services/cpdp/v20190820/cpdp_client.d.ts +5 -1
  48. package/tencentcloud/services/cpdp/v20190820/cpdp_client.js +6 -0
  49. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +305 -29
  50. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +19 -14
  51. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +33 -13
  52. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +33 -13
  53. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +51 -22
  54. package/tencentcloud/services/lcic/v20220817/lcic_client.d.ts +21 -5
  55. package/tencentcloud/services/lcic/v20220817/lcic_client.js +30 -6
  56. package/tencentcloud/services/lcic/v20220817/lcic_models.d.ts +299 -133
  57. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +25 -0
  58. package/tencentcloud/services/pts/v20210728/pts_models.d.ts +30 -0
  59. package/tencentcloud/services/ses/v20201002/ses_client.d.ts +2 -2
  60. package/tencentcloud/services/ses/v20201002/ses_client.js +2 -2
  61. package/tencentcloud/services/soe/v20180724/soe_models.d.ts +2 -2
  62. package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +1 -1
  63. package/tencentcloud/services/tcb/v20180608/tcb_client.d.ts +5 -1
  64. package/tencentcloud/services/tcb/v20180608/tcb_client.js +6 -0
  65. package/tencentcloud/services/tcb/v20180608/tcb_models.d.ts +22 -0
  66. package/tencentcloud/services/tcm/v20210413/tcm_client.d.ts +15 -7
  67. package/tencentcloud/services/tcm/v20210413/tcm_client.js +21 -9
  68. package/tencentcloud/services/tcm/v20210413/tcm_models.d.ts +44 -0
  69. package/tencentcloud/services/tcss/v20201101/tcss_client.d.ts +621 -65
  70. package/tencentcloud/services/tcss/v20201101/tcss_client.js +948 -114
  71. package/tencentcloud/services/tcss/v20201101/tcss_models.d.ts +9626 -2675
  72. package/tencentcloud/services/teo/v20220901/teo_models.d.ts +58 -4
  73. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +3 -3
  74. package/tencentcloud/services/tke/v20180525/tke_client.js +1 -1
  75. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +34 -2
  76. package/tencentcloud/services/trp/v20210515/trp_models.d.ts +12 -12
  77. package/tencentcloud/services/trtc/v20190722/trtc_client.d.ts +3 -33
  78. package/tencentcloud/services/trtc/v20190722/trtc_client.js +2 -38
  79. package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +60 -556
  80. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +25 -13
  81. package/tencentcloud/services/wedata/v20210820/wedata_client.js +35 -17
  82. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +352 -54
  83. package/test/bma.v20210624.test.js +20 -0
  84. package/test/cpdp.v20190820.test.js +10 -0
  85. package/test/lcic.v20220817.test.js +44 -4
  86. package/test/tcb.v20180608.test.js +10 -0
  87. package/test/tcm.v20210413.test.js +26 -6
  88. package/test/tcss.v20201101.test.js +1713 -323
  89. package/test/trtc.v20190722.test.js +0 -30
  90. package/test/wedata.v20210820.test.js +40 -10
@@ -7645,28 +7645,6 @@ export interface QueryMerchantBalanceRequest {
7645
7645
  */
7646
7646
  Profile?: string;
7647
7647
  }
7648
- /**
7649
- * ApplyFlexSettlement返回参数结构体
7650
- */
7651
- export interface ApplyFlexSettlementResponse {
7652
- /**
7653
- * 错误码。SUCCESS为成功,其他为失败
7654
- */
7655
- ErrCode: string;
7656
- /**
7657
- * 错误消息
7658
- */
7659
- ErrMessage: string;
7660
- /**
7661
- * 返回结果
7662
- 注意:此字段可能返回 null,表示取不到有效值。
7663
- */
7664
- Result: ApplyFlexSettlementResult;
7665
- /**
7666
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7667
- */
7668
- RequestId?: string;
7669
- }
7670
7648
  /**
7671
7649
  * 查询汇出结果
7672
7650
  */
@@ -8460,6 +8438,48 @@ export interface QueryFlexFreezeOrderListResponse {
8460
8438
  */
8461
8439
  RequestId?: string;
8462
8440
  }
8441
+ /**
8442
+ * 云企付-邮寄信息
8443
+ */
8444
+ export interface OpenBankShippingInfo {
8445
+ /**
8446
+ * 收货人名字
8447
+ */
8448
+ FirstName?: string;
8449
+ /**
8450
+ * 收货人姓氏
8451
+ */
8452
+ LastName?: string;
8453
+ /**
8454
+ * 收货地址1
8455
+ */
8456
+ AddressOne?: string;
8457
+ /**
8458
+ * 收货地址2
8459
+ */
8460
+ AddressTwo?: string;
8461
+ /**
8462
+ * 收货地址所在城市
8463
+ */
8464
+ City?: string;
8465
+ /**
8466
+ * 收货地址所在州,当国家是美国或加拿大时,使用ISO-3166-2:US或ISO -3166-2:CA 中该
8467
+ 国家地区编码标准中的两位字母编码
8468
+ */
8469
+ State?: string;
8470
+ /**
8471
+ * 使用ISO-3166-1标准中的两位字母编码
8472
+ */
8473
+ Country?: string;
8474
+ /**
8475
+ * 收货地址邮编
8476
+ */
8477
+ ZipCode?: string;
8478
+ /**
8479
+ * 收货联系电话
8480
+ */
8481
+ Phone?: string;
8482
+ }
8463
8483
  /**
8464
8484
  * 收款用户计税模板信息
8465
8485
  */
@@ -9928,6 +9948,47 @@ __test__:测试环境
9928
9948
  */
9929
9949
  NotifyUrl?: string;
9930
9950
  }
9951
+ /**
9952
+ * 云企付-账单信息
9953
+ */
9954
+ export interface OpenBankBillingInfo {
9955
+ /**
9956
+ * 账单人名字
9957
+ */
9958
+ FirstName?: string;
9959
+ /**
9960
+ * 账单人姓氏
9961
+ */
9962
+ LastName?: string;
9963
+ /**
9964
+ * 账单地址1
9965
+ */
9966
+ AddressOne?: string;
9967
+ /**
9968
+ * 账单地址1
9969
+ */
9970
+ AddressTwo?: string;
9971
+ /**
9972
+ * 账单地址所在城市
9973
+ */
9974
+ City?: string;
9975
+ /**
9976
+ * 账单地址所在州/省,当国家是美国或加拿大时,使用ISO-3166-2:US或ISO -3166-2:CA 中该国家地区编 码标准中的两位字母编码。
9977
+ */
9978
+ State?: string;
9979
+ /**
9980
+ * 账单地址所在国家,使用ISO-3166-1标准中的两位字母编码。
9981
+ */
9982
+ Country?: string;
9983
+ /**
9984
+ * 账单地址邮编
9985
+ */
9986
+ ZipCode?: string;
9987
+ /**
9988
+ * 账单人手机号
9989
+ */
9990
+ Phone?: string;
9991
+ }
9931
9992
  /**
9932
9993
  * 第三方渠道数据信息
9933
9994
  */
@@ -11727,22 +11788,22 @@ development: 开发环境
11727
11788
  WithdrawOrderId?: string;
11728
11789
  }
11729
11790
  /**
11730
- * QueryAssignment返回参数结构体
11791
+ * ApplyFlexSettlement返回参数结构体
11731
11792
  */
11732
- export interface QueryAssignmentResponse {
11793
+ export interface ApplyFlexSettlementResponse {
11733
11794
  /**
11734
- * 错误码。响应成功:"SUCCESS",其他为不成功。
11795
+ * 错误码。SUCCESS为成功,其他为失败
11735
11796
  */
11736
11797
  ErrCode: string;
11737
11798
  /**
11738
- * 响应消息
11799
+ * 错误消息
11739
11800
  */
11740
- ErrMsg: string;
11801
+ ErrMessage: string;
11741
11802
  /**
11742
- * 返回响应
11803
+ * 返回结果
11743
11804
  注意:此字段可能返回 null,表示取不到有效值。
11744
11805
  */
11745
- Result: AssignmentData;
11806
+ Result: ApplyFlexSettlementResult;
11746
11807
  /**
11747
11808
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
11748
11809
  */
@@ -13418,6 +13479,26 @@ export interface OpenBankGoodsInfo {
13418
13479
  * 业务类型。汇付渠道必填,汇付渠道传入固定值100099。
13419
13480
  */
13420
13481
  GoodsBizType?: string;
13482
+ /**
13483
+ * 商品编号。
13484
+ */
13485
+ Sku?: string;
13486
+ /**
13487
+ * 商品单价。
13488
+ */
13489
+ Price?: string;
13490
+ /**
13491
+ * 商品数量
13492
+ */
13493
+ Quantity?: string;
13494
+ /**
13495
+ * 商品图片url
13496
+ */
13497
+ ProductImage?: string;
13498
+ /**
13499
+ * 商品链接url
13500
+ */
13501
+ ProductUrl?: string;
13421
13502
  }
13422
13503
  /**
13423
13504
  * 子订单列表
@@ -14500,6 +14581,78 @@ export interface TranItem {
14500
14581
  */
14501
14582
  Mobile: string;
14502
14583
  }
14584
+ /**
14585
+ * CreateOpenBankGlobalPaymentOrder请求参数结构体
14586
+ */
14587
+ export interface CreateOpenBankGlobalPaymentOrderRequest {
14588
+ /**
14589
+ * 渠道商户号
14590
+ */
14591
+ ChannelMerchantId: string;
14592
+ /**
14593
+ * 渠道名称
14594
+ */
14595
+ ChannelName: string;
14596
+ /**
14597
+ * 付款方式
14598
+ */
14599
+ PayType: string;
14600
+ /**
14601
+ * 外部商户订单号,只能是数字、大小写字母,且在同一个接入平台下唯一
14602
+ */
14603
+ OutOrderId: string;
14604
+ /**
14605
+ * 付款金额,单位分
14606
+ */
14607
+ TotalAmount: number;
14608
+ /**
14609
+ * 支付币种,参考附录:货币代码
14610
+ */
14611
+ Currency: string;
14612
+ /**
14613
+ * 渠道子商户号
14614
+ */
14615
+ ChannelSubMerchantId?: string;
14616
+ /**
14617
+ * 支付成功回调地址。
14618
+ */
14619
+ NotifyUrl?: string;
14620
+ /**
14621
+ * 前端跳转地址。通联支付成功后,支付网关跳回商户的地址
14622
+ */
14623
+ FrontUrl?: string;
14624
+ /**
14625
+ * 网站语言。收银台显示语言,见附录网站语言
14626
+ */
14627
+ FrontLanguage?: string;
14628
+ /**
14629
+ * 付款备注
14630
+ */
14631
+ Remark?: string;
14632
+ /**
14633
+ * 第三方拓展信息信息
14634
+ */
14635
+ ExternalPaymentData?: string;
14636
+ /**
14637
+ * 商品信息
14638
+ */
14639
+ GoodsInfos?: Array<OpenBankGoodsInfo>;
14640
+ /**
14641
+ * 邮寄信息
14642
+ */
14643
+ ShippingInfo?: OpenBankShippingInfo;
14644
+ /**
14645
+ * 账单信息
14646
+ */
14647
+ BillingInfo?: OpenBankBillingInfo;
14648
+ /**
14649
+ * 环境类型
14650
+ __release__:生产环境
14651
+ __sandbox__:沙箱环境
14652
+ 缺省默认为生产环境
14653
+ */
14654
+ Environment?: string;
14655
+ }
14503
14656
  /**
14504
14657
  * DistributeQueryReceiver返回参数结构体
14505
14658
  */
@@ -16067,6 +16220,51 @@ _不填默认为生产环境_
16067
16220
  */
16068
16221
  Environment?: string;
16069
16222
  }
16223
+ /**
16224
+ * 云企付-下单跳转参数,用于小程序前端跳转
16225
+ */
16226
+ export interface OpenBankOrderRedirectInfo {
16227
+ /**
16228
+ * 生成二维码,引导用户扫码
16229
+ 注意:此字段可能返回 null,表示取不到有效值。
16230
+ */
16231
+ QRCodeUrl: string;
16232
+ /**
16233
+ * 二维码凭证
16234
+ 注意:此字段可能返回 null,表示取不到有效值。
16235
+ */
16236
+ QRCodeKey: string;
16237
+ /**
16238
+ * 跳转 URL,用于客户端跳转,订单未支付时返回该参数
16239
+ 注意:此字段可能返回 null,表示取不到有效值。
16240
+ */
16241
+ Url: string;
16242
+ /**
16243
+ * 跳转凭证过期时间,yyyy-MM-dd HH:mm:ss
16244
+ 注意:此字段可能返回 null,表示取不到有效值。
16245
+ */
16246
+ ExpireTime: string;
16247
+ /**
16248
+ * 小程序 appid
16249
+ 注意:此字段可能返回 null,表示取不到有效值。
16250
+ */
16251
+ MpAppId: string;
16252
+ /**
16253
+ * 小程序路径
16254
+ 注意:此字段可能返回 null,表示取不到有效值。
16255
+ */
16256
+ MpPath: string;
16257
+ /**
16258
+ * 小程序原始 id
16259
+ 注意:此字段可能返回 null,表示取不到有效值。
16260
+ */
16261
+ MpUserName: string;
16262
+ /**
16263
+ * 网银支付提交页面信息
16264
+ 注意:此字段可能返回 null,表示取不到有效值。
16265
+ */
16266
+ FormInfo: OpenBankFormInfo;
16267
+ }
16070
16268
  /**
16071
16269
  * QueryFlexAmountBeforeTax请求参数结构体
16072
16270
  */
@@ -16790,6 +16988,29 @@ export interface DownloadOrgFileRequest {
16790
16988
  */
16791
16989
  Profile?: string;
16792
16990
  }
16991
+ /**
16992
+ * CreateOpenBankGlobalPaymentOrder返回参数结构体
16993
+ */
16994
+ export interface CreateOpenBankGlobalPaymentOrderResponse {
16995
+ /**
16996
+ * 业务系统返回码,SUCCESS表示成功,其他表示失败。
16997
+ */
16998
+ ErrCode: string;
16999
+ /**
17000
+ * 业务系统返回消息。
17001
+ 注意:此字段可能返回 null,表示取不到有效值。
17002
+ */
17003
+ ErrMessage: string;
17004
+ /**
17005
+ * 统一下单响应对象。
17006
+ 注意:此字段可能返回 null,表示取不到有效值。
17007
+ */
17008
+ Result: CreateOpenBankUnifiedOrderPaymentResult;
17009
+ /**
17010
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
17011
+ */
17012
+ RequestId?: string;
17013
+ }
16793
17014
  /**
16794
17015
  * 签约同步信息
16795
17016
  */
@@ -17555,6 +17776,39 @@ export interface QueryMemberTransactionRequest {
17555
17776
  */
17556
17777
  Profile?: string;
17557
17778
  }
17779
+ /**
17780
+ * 云企付-支付下单返回响应
17781
+ */
17782
+ export interface CreateOpenBankUnifiedOrderPaymentResult {
17783
+ /**
17784
+ * 云企付平台订单号。
17785
+ */
17786
+ ChannelOrderId: string;
17787
+ /**
17788
+ * 第三方支付平台返回支付订单号。
17789
+ 注意:此字段可能返回 null,表示取不到有效值。
17790
+ */
17791
+ ThirdPayOrderId: string;
17792
+ /**
17793
+ * 跳转参数 渠道为TENPAY,付款方式为EBANK_PAYMENT时必选。
17794
+ 注意:此字段可能返回 null,表示取不到有效值。
17795
+ */
17796
+ RedirectInfo: OpenBankOrderRedirectInfo;
17797
+ /**
17798
+ * 外部商户订单号,只能是数字、大小写字母,且在同一个接入平台下唯一。
17799
+ */
17800
+ OutOrderId: string;
17801
+ /**
17802
+ * 渠道扩展支付信息
17803
+ 注意:此字段可能返回 null,表示取不到有效值。
17804
+ */
17805
+ PayInfo: string;
17806
+ /**
17807
+ * 渠道扩展支付信息类型
17808
+ 注意:此字段可能返回 null,表示取不到有效值。
17809
+ */
17810
+ PayInfoType: string;
17811
+ }
17558
17812
  /**
17559
17813
  * QueryCityCode请求参数结构体
17560
17814
  */
@@ -19605,6 +19859,28 @@ export interface UploadFileResult {
19605
19859
  */
19606
19860
  FilePath: string;
19607
19861
  }
19862
+ /**
19863
+ * QueryAssignment返回参数结构体
19864
+ */
19865
+ export interface QueryAssignmentResponse {
19866
+ /**
19867
+ * 错误码。响应成功:"SUCCESS",其他为不成功。
19868
+ */
19869
+ ErrCode: string;
19870
+ /**
19871
+ * 响应消息
19872
+ */
19873
+ ErrMsg: string;
19874
+ /**
19875
+ * 返回响应
19876
+ 注意:此字段可能返回 null,表示取不到有效值。
19877
+ */
19878
+ Result: AssignmentData;
19879
+ /**
19880
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
19881
+ */
19882
+ RequestId?: string;
19883
+ }
19608
19884
  /**
19609
19885
  * DescribeChargeDetail请求参数结构体
19610
19886
  */
@@ -651,6 +651,7 @@ CHECK_BOX - true/false
651
651
  FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
652
652
  SELECTOR - 选项值
653
653
  DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
654
+ SIGN_SEAL - 印章Id,于控制台查询获取
654
655
  */
655
656
  ComponentValue?: string;
656
657
  /**
@@ -1527,28 +1528,18 @@ export interface SuccessDeleteStaffData {
1527
1528
  * CreateMultiFlowSignQRCode请求参数结构体
1528
1529
  */
1529
1530
  export interface CreateMultiFlowSignQRCodeRequest {
1530
- /**
1531
- * 模板ID
1532
- */
1533
- TemplateId: string;
1534
- /**
1535
- * 签署流程名称,最大长度不超过200字符
1536
- */
1537
- FlowName: string;
1538
1531
  /**
1539
1532
  * 用户信息
1540
1533
  */
1541
1534
  Operator: UserInfo;
1542
1535
  /**
1543
- * 应用信息
1536
+ * 模板ID
1544
1537
  */
1545
- Agent?: Agent;
1538
+ TemplateId: string;
1546
1539
  /**
1547
- * 回调地址,最大长度1000字符串
1548
- 回调时机:
1549
- 用户通过签署二维码发起签署流程时,企业额度不足导致失败
1540
+ * 签署流程名称,最大长度不超过200字符
1550
1541
  */
1551
- CallbackUrl?: string;
1542
+ FlowName: string;
1552
1543
  /**
1553
1544
  * 最大可发起签署流程份数,默认5份
1554
1545
  发起流程数量超过此上限后二维码自动失效
@@ -1565,6 +1556,20 @@ export interface CreateMultiFlowSignQRCodeRequest {
1565
1556
  /**
1566
1557
  * 限制二维码用户条件
1567
1558
  */
1559
+ Restrictions?: Array<ApproverRestriction>;
1560
+ /**
1561
+ * 回调地址,最大长度1000字符串
1562
+ 回调时机:
1563
+ 用户通过签署二维码发起签署流程时,企业额度不足导致失败
1564
+ */
1565
+ CallbackUrl?: string;
1566
+ /**
1567
+ * 应用信息
1568
+ */
1569
+ Agent?: Agent;
1570
+ /**
1571
+ * 限制二维码用户条件(已弃用)
1572
+ */
1568
1573
  ApproverRestrictions?: ApproverRestriction;
1569
1574
  }
1570
1575
  /**
@@ -24,7 +24,7 @@ export declare class Client extends AbstractClient {
24
24
  */
25
25
  ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
26
26
  /**
27
- * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,需要运营申请
27
+ * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,请联系运营/客服咨询相关流程
28
28
  */
29
29
  CreateSealByImage(req: CreateSealByImageRequest, cb?: (error: string, rep: CreateSealByImageResponse) => void): Promise<CreateSealByImageResponse>;
30
30
  /**
@@ -42,11 +42,27 @@ export declare class Client extends AbstractClient {
42
42
  DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
43
43
  /**
44
44
  * 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
45
-
45
+ 合同发起人必须在电子签已经进行实名。
46
46
  */
47
47
  CreateFlowsByTemplates(req: CreateFlowsByTemplatesRequest, cb?: (error: string, rep: CreateFlowsByTemplatesResponse) => void): Promise<CreateFlowsByTemplatesResponse>;
48
48
  /**
49
- * 创建跳转小程序查看或签署的链接;自动签署的签署方不创建签署链接;
49
+ * 创建跳转小程序查看或签署的链接。
50
+
51
+ 跳转小程序的几种方式:主要是设置不同的EndPoint
52
+ 1. 通过链接Url直接跳转到小程序,不需要返回
53
+ 设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
54
+ 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
55
+ 设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
56
+ 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
57
+ 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
58
+ 全屏方式:
59
+ (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
60
+ 半屏方式:
61
+ (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
62
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
63
+ 使用CreateSignUrls,设置EndPoint为APP,得到path。
64
+ 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
65
+ 实现方式同App跳小程序。
50
66
  */
51
67
  CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
52
68
  /**
@@ -54,7 +70,7 @@ export declare class Client extends AbstractClient {
54
70
  若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
55
71
  若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
56
72
  若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
57
-
73
+ 返回的Url仅支持PC端操作。
58
74
  */
59
75
  CreateConsoleLoginUrl(req: CreateConsoleLoginUrlRequest, cb?: (error: string, rep: CreateConsoleLoginUrlResponse) => void): Promise<CreateConsoleLoginUrlResponse>;
60
76
  /**
@@ -89,7 +105,7 @@ export declare class Client extends AbstractClient {
89
105
  */
90
106
  SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
91
107
  /**
92
- * 查询企业员工
108
+ * 查询企业员工列表
93
109
  */
94
110
  ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
95
111
  /**
@@ -106,24 +122,28 @@ export declare class Client extends AbstractClient {
106
122
  */
107
123
  PrepareFlows(req: PrepareFlowsRequest, cb?: (error: string, rep: PrepareFlowsResponse) => void): Promise<PrepareFlowsResponse>;
108
124
  /**
109
- * 根据签署流程信息批量获取资源下载链接,需合作企业先进行授权
125
+ * 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
126
+ 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
110
127
  */
111
128
  DescribeResourceUrlsByFlows(req: DescribeResourceUrlsByFlowsRequest, cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void): Promise<DescribeResourceUrlsByFlowsResponse>;
112
129
  /**
113
- * 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
130
+ * 通过此接口(DescribeTemplates)查询该子客企业在电子签拥有的的有效模板,不包括渠道模版
114
131
  */
115
132
  DescribeTemplates(req: DescribeTemplatesRequest, cb?: (error: string, rep: DescribeTemplatesResponse) => void): Promise<DescribeTemplatesResponse>;
116
133
  /**
117
134
  * 此接口(UploadFiles)用于文件上传。
118
- 调用时需要设置Domain file.ess.tencent.cn
135
+ 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn
136
+ 代码示例:
137
+ HttpProfile httpProfile = new HttpProfile();
138
+ httpProfile.setEndpoint("file.test.ess.tencent.cn");
119
139
  */
120
140
  UploadFiles(req: UploadFilesRequest, cb?: (error: string, rep: UploadFilesResponse) => void): Promise<UploadFilesResponse>;
121
141
  /**
122
- * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
123
- 1、同步标识=select时:
124
- 返回渠道侧模板库当前模板的属性.
125
- 2、同步标识=update或者delete时:
126
- 对渠道子客进行模板库中模板授权,修改操作
142
+ * 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。
143
+ 1、OperateType=select时:
144
+ 查询渠道模板库
145
+ 2、OperateType=update或者delete时:
146
+ 对子客企业进行模板库中模板可见性的修改、删除操作。
127
147
  */
128
148
  OperateChannelTemplate(req: OperateChannelTemplateRequest, cb?: (error: string, rep: OperateChannelTemplateResponse) => void): Promise<OperateChannelTemplateResponse>;
129
149
  /**
@@ -50,7 +50,7 @@ class Client extends abstract_client_1.AbstractClient {
50
50
  return this.request("ChannelCreateFlowByFiles", req, cb);
51
51
  }
52
52
  /**
53
- * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,需要运营申请
53
+ * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,请联系运营/客服咨询相关流程
54
54
  */
55
55
  async CreateSealByImage(req, cb) {
56
56
  return this.request("CreateSealByImage", req, cb);
@@ -76,13 +76,29 @@ class Client extends abstract_client_1.AbstractClient {
76
76
  }
77
77
  /**
78
78
  * 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
79
-
79
+ 合同发起人必须在电子签已经进行实名。
80
80
  */
81
81
  async CreateFlowsByTemplates(req, cb) {
82
82
  return this.request("CreateFlowsByTemplates", req, cb);
83
83
  }
84
84
  /**
85
- * 创建跳转小程序查看或签署的链接;自动签署的签署方不创建签署链接;
85
+ * 创建跳转小程序查看或签署的链接。
86
+
87
+ 跳转小程序的几种方式:主要是设置不同的EndPoint
88
+ 1. 通过链接Url直接跳转到小程序,不需要返回
89
+ 设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
90
+ 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
91
+ 设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
92
+ 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
93
+ 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
94
+ 全屏方式:
95
+ (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
96
+ 半屏方式:
97
+ (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
98
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
99
+ 使用CreateSignUrls,设置EndPoint为APP,得到path。
100
+ 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
101
+ 实现方式同App跳小程序。
86
102
  */
87
103
  async CreateSignUrls(req, cb) {
88
104
  return this.request("CreateSignUrls", req, cb);
@@ -92,7 +108,7 @@ class Client extends abstract_client_1.AbstractClient {
92
108
  若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
93
109
  若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
94
110
  若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
95
-
111
+ 返回的Url仅支持PC端操作。
96
112
  */
97
113
  async CreateConsoleLoginUrl(req, cb) {
98
114
  return this.request("CreateConsoleLoginUrl", req, cb);
@@ -141,7 +157,7 @@ class Client extends abstract_client_1.AbstractClient {
141
157
  return this.request("SyncProxyOrganizationOperators", req, cb);
142
158
  }
143
159
  /**
144
- * 查询企业员工
160
+ * 查询企业员工列表
145
161
  */
146
162
  async ChannelDescribeEmployees(req, cb) {
147
163
  return this.request("ChannelDescribeEmployees", req, cb);
@@ -164,30 +180,34 @@ class Client extends abstract_client_1.AbstractClient {
164
180
  return this.request("PrepareFlows", req, cb);
165
181
  }
166
182
  /**
167
- * 根据签署流程信息批量获取资源下载链接,需合作企业先进行授权
183
+ * 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
184
+ 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
168
185
  */
169
186
  async DescribeResourceUrlsByFlows(req, cb) {
170
187
  return this.request("DescribeResourceUrlsByFlows", req, cb);
171
188
  }
172
189
  /**
173
- * 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
190
+ * 通过此接口(DescribeTemplates)查询该子客企业在电子签拥有的的有效模板,不包括渠道模版
174
191
  */
175
192
  async DescribeTemplates(req, cb) {
176
193
  return this.request("DescribeTemplates", req, cb);
177
194
  }
178
195
  /**
179
196
  * 此接口(UploadFiles)用于文件上传。
180
- 调用时需要设置Domain file.ess.tencent.cn
197
+ 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn
198
+ 代码示例:
199
+ HttpProfile httpProfile = new HttpProfile();
200
+ httpProfile.setEndpoint("file.test.ess.tencent.cn");
181
201
  */
182
202
  async UploadFiles(req, cb) {
183
203
  return this.request("UploadFiles", req, cb);
184
204
  }
185
205
  /**
186
- * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
187
- 1、同步标识=select时:
188
- 返回渠道侧模板库当前模板的属性.
189
- 2、同步标识=update或者delete时:
190
- 对渠道子客进行模板库中模板授权,修改操作
206
+ * 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。
207
+ 1、OperateType=select时:
208
+ 查询渠道模板库
209
+ 2、OperateType=update或者delete时:
210
+ 对子客企业进行模板库中模板可见性的修改、删除操作。
191
211
  */
192
212
  async OperateChannelTemplate(req, cb) {
193
213
  return this.request("OperateChannelTemplate", req, cb);