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
@@ -9098,32 +9098,6 @@ export interface QueryMerchantBalanceRequest {
9098
9098
  Profile?: string
9099
9099
  }
9100
9100
 
9101
- /**
9102
- * ApplyFlexSettlement返回参数结构体
9103
- */
9104
- export interface ApplyFlexSettlementResponse {
9105
- /**
9106
- * 错误码。SUCCESS为成功,其他为失败
9107
- */
9108
- ErrCode: string
9109
-
9110
- /**
9111
- * 错误消息
9112
- */
9113
- ErrMessage: string
9114
-
9115
- /**
9116
- * 返回结果
9117
- 注意:此字段可能返回 null,表示取不到有效值。
9118
- */
9119
- Result: ApplyFlexSettlementResult
9120
-
9121
- /**
9122
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
9123
- */
9124
- RequestId?: string
9125
- }
9126
-
9127
9101
  /**
9128
9102
  * 查询汇出结果
9129
9103
  */
@@ -10073,6 +10047,57 @@ export interface QueryFlexFreezeOrderListResponse {
10073
10047
  RequestId?: string
10074
10048
  }
10075
10049
 
10050
+ /**
10051
+ * 云企付-邮寄信息
10052
+ */
10053
+ export interface OpenBankShippingInfo {
10054
+ /**
10055
+ * 收货人名字
10056
+ */
10057
+ FirstName?: string
10058
+
10059
+ /**
10060
+ * 收货人姓氏
10061
+ */
10062
+ LastName?: string
10063
+
10064
+ /**
10065
+ * 收货地址1
10066
+ */
10067
+ AddressOne?: string
10068
+
10069
+ /**
10070
+ * 收货地址2
10071
+ */
10072
+ AddressTwo?: string
10073
+
10074
+ /**
10075
+ * 收货地址所在城市
10076
+ */
10077
+ City?: string
10078
+
10079
+ /**
10080
+ * 收货地址所在州,当国家是美国或加拿大时,使用ISO-3166-2:US或ISO -3166-2:CA 中该
10081
+ 国家地区编码标准中的两位字母编码
10082
+ */
10083
+ State?: string
10084
+
10085
+ /**
10086
+ * 使用ISO-3166-1标准中的两位字母编码
10087
+ */
10088
+ Country?: string
10089
+
10090
+ /**
10091
+ * 收货地址邮编
10092
+ */
10093
+ ZipCode?: string
10094
+
10095
+ /**
10096
+ * 收货联系电话
10097
+ */
10098
+ Phone?: string
10099
+ }
10100
+
10076
10101
  /**
10077
10102
  * 收款用户计税模板信息
10078
10103
  */
@@ -11812,6 +11837,56 @@ __test__:测试环境
11812
11837
  NotifyUrl?: string
11813
11838
  }
11814
11839
 
11840
+ /**
11841
+ * 云企付-账单信息
11842
+ */
11843
+ export interface OpenBankBillingInfo {
11844
+ /**
11845
+ * 账单人名字
11846
+ */
11847
+ FirstName?: string
11848
+
11849
+ /**
11850
+ * 账单人姓氏
11851
+ */
11852
+ LastName?: string
11853
+
11854
+ /**
11855
+ * 账单地址1
11856
+ */
11857
+ AddressOne?: string
11858
+
11859
+ /**
11860
+ * 账单地址1
11861
+ */
11862
+ AddressTwo?: string
11863
+
11864
+ /**
11865
+ * 账单地址所在城市
11866
+ */
11867
+ City?: string
11868
+
11869
+ /**
11870
+ * 账单地址所在州/省,当国家是美国或加拿大时,使用ISO-3166-2:US或ISO -3166-2:CA 中该国家地区编 码标准中的两位字母编码。
11871
+ */
11872
+ State?: string
11873
+
11874
+ /**
11875
+ * 账单地址所在国家,使用ISO-3166-1标准中的两位字母编码。
11876
+ */
11877
+ Country?: string
11878
+
11879
+ /**
11880
+ * 账单地址邮编
11881
+ */
11882
+ ZipCode?: string
11883
+
11884
+ /**
11885
+ * 账单人手机号
11886
+ */
11887
+ Phone?: string
11888
+ }
11889
+
11815
11890
  /**
11816
11891
  * 第三方渠道数据信息
11817
11892
  */
@@ -13953,24 +14028,24 @@ development: 开发环境
13953
14028
  }
13954
14029
 
13955
14030
  /**
13956
- * QueryAssignment返回参数结构体
14031
+ * ApplyFlexSettlement返回参数结构体
13957
14032
  */
13958
- export interface QueryAssignmentResponse {
14033
+ export interface ApplyFlexSettlementResponse {
13959
14034
  /**
13960
- * 错误码。响应成功:"SUCCESS",其他为不成功。
14035
+ * 错误码。SUCCESS为成功,其他为失败
13961
14036
  */
13962
14037
  ErrCode: string
13963
14038
 
13964
14039
  /**
13965
- * 响应消息
14040
+ * 错误消息
13966
14041
  */
13967
- ErrMsg: string
14042
+ ErrMessage: string
13968
14043
 
13969
14044
  /**
13970
- * 返回响应
14045
+ * 返回结果
13971
14046
  注意:此字段可能返回 null,表示取不到有效值。
13972
14047
  */
13973
- Result: AssignmentData
14048
+ Result: ApplyFlexSettlementResult
13974
14049
 
13975
14050
  /**
13976
14051
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -15970,6 +16045,31 @@ export interface OpenBankGoodsInfo {
15970
16045
  * 业务类型。汇付渠道必填,汇付渠道传入固定值100099。
15971
16046
  */
15972
16047
  GoodsBizType?: string
16048
+
16049
+ /**
16050
+ * 商品编号。
16051
+ */
16052
+ Sku?: string
16053
+
16054
+ /**
16055
+ * 商品单价。
16056
+ */
16057
+ Price?: string
16058
+
16059
+ /**
16060
+ * 商品数量
16061
+ */
16062
+ Quantity?: string
16063
+
16064
+ /**
16065
+ * 商品图片url
16066
+ */
16067
+ ProductImage?: string
16068
+
16069
+ /**
16070
+ * 商品链接url
16071
+ */
16072
+ ProductUrl?: string
15973
16073
  }
15974
16074
 
15975
16075
  /**
@@ -17252,6 +17352,94 @@ export interface TranItem {
17252
17352
  Mobile: string
17253
17353
  }
17254
17354
 
17355
+ /**
17356
+ * CreateOpenBankGlobalPaymentOrder请求参数结构体
17357
+ */
17358
+ export interface CreateOpenBankGlobalPaymentOrderRequest {
17359
+ /**
17360
+ * 渠道商户号
17361
+ */
17362
+ ChannelMerchantId: string
17363
+
17364
+ /**
17365
+ * 渠道名称
17366
+ */
17367
+ ChannelName: string
17368
+
17369
+ /**
17370
+ * 付款方式
17371
+ */
17372
+ PayType: string
17373
+
17374
+ /**
17375
+ * 外部商户订单号,只能是数字、大小写字母,且在同一个接入平台下唯一
17376
+ */
17377
+ OutOrderId: string
17378
+
17379
+ /**
17380
+ * 付款金额,单位分
17381
+ */
17382
+ TotalAmount: number
17383
+
17384
+ /**
17385
+ * 支付币种,参考附录:货币代码
17386
+ */
17387
+ Currency: string
17388
+
17389
+ /**
17390
+ * 渠道子商户号
17391
+ */
17392
+ ChannelSubMerchantId?: string
17393
+
17394
+ /**
17395
+ * 支付成功回调地址。
17396
+ */
17397
+ NotifyUrl?: string
17398
+
17399
+ /**
17400
+ * 前端跳转地址。通联支付成功后,支付网关跳回商户的地址
17401
+ */
17402
+ FrontUrl?: string
17403
+
17404
+ /**
17405
+ * 网站语言。收银台显示语言,见附录网站语言
17406
+ */
17407
+ FrontLanguage?: string
17408
+
17409
+ /**
17410
+ * 付款备注
17411
+ */
17412
+ Remark?: string
17413
+
17414
+ /**
17415
+ * 第三方拓展信息信息
17416
+ */
17417
+ ExternalPaymentData?: string
17418
+
17419
+ /**
17420
+ * 商品信息
17421
+ */
17422
+ GoodsInfos?: Array<OpenBankGoodsInfo>
17423
+
17424
+ /**
17425
+ * 邮寄信息
17426
+ */
17427
+ ShippingInfo?: OpenBankShippingInfo
17428
+
17429
+ /**
17430
+ * 账单信息
17431
+ */
17432
+ BillingInfo?: OpenBankBillingInfo
17433
+
17434
+ /**
17435
+ * 环境类型
17436
+ __release__:生产环境
17437
+ __sandbox__:沙箱环境
17438
+ 缺省默认为生产环境
17439
+ */
17440
+ Environment?: string
17441
+ }
17442
+
17255
17443
  /**
17256
17444
  * DistributeQueryReceiver返回参数结构体
17257
17445
  */
@@ -19103,6 +19291,59 @@ _不填默认为生产环境_
19103
19291
  Environment?: string
19104
19292
  }
19105
19293
 
19294
+ /**
19295
+ * 云企付-下单跳转参数,用于小程序前端跳转
19296
+ */
19297
+ export interface OpenBankOrderRedirectInfo {
19298
+ /**
19299
+ * 生成二维码,引导用户扫码
19300
+ 注意:此字段可能返回 null,表示取不到有效值。
19301
+ */
19302
+ QRCodeUrl: string
19303
+
19304
+ /**
19305
+ * 二维码凭证
19306
+ 注意:此字段可能返回 null,表示取不到有效值。
19307
+ */
19308
+ QRCodeKey: string
19309
+
19310
+ /**
19311
+ * 跳转 URL,用于客户端跳转,订单未支付时返回该参数
19312
+ 注意:此字段可能返回 null,表示取不到有效值。
19313
+ */
19314
+ Url: string
19315
+
19316
+ /**
19317
+ * 跳转凭证过期时间,yyyy-MM-dd HH:mm:ss
19318
+ 注意:此字段可能返回 null,表示取不到有效值。
19319
+ */
19320
+ ExpireTime: string
19321
+
19322
+ /**
19323
+ * 小程序 appid
19324
+ 注意:此字段可能返回 null,表示取不到有效值。
19325
+ */
19326
+ MpAppId: string
19327
+
19328
+ /**
19329
+ * 小程序路径
19330
+ 注意:此字段可能返回 null,表示取不到有效值。
19331
+ */
19332
+ MpPath: string
19333
+
19334
+ /**
19335
+ * 小程序原始 id
19336
+ 注意:此字段可能返回 null,表示取不到有效值。
19337
+ */
19338
+ MpUserName: string
19339
+
19340
+ /**
19341
+ * 网银支付提交页面信息
19342
+ 注意:此字段可能返回 null,表示取不到有效值。
19343
+ */
19344
+ FormInfo: OpenBankFormInfo
19345
+ }
19346
+
19106
19347
  /**
19107
19348
  * QueryFlexAmountBeforeTax请求参数结构体
19108
19349
  */
@@ -19956,6 +20197,33 @@ export interface DownloadOrgFileRequest {
19956
20197
  Profile?: string
19957
20198
  }
19958
20199
 
20200
+ /**
20201
+ * CreateOpenBankGlobalPaymentOrder返回参数结构体
20202
+ */
20203
+ export interface CreateOpenBankGlobalPaymentOrderResponse {
20204
+ /**
20205
+ * 业务系统返回码,SUCCESS表示成功,其他表示失败。
20206
+ */
20207
+ ErrCode: string
20208
+
20209
+ /**
20210
+ * 业务系统返回消息。
20211
+ 注意:此字段可能返回 null,表示取不到有效值。
20212
+ */
20213
+ ErrMessage: string
20214
+
20215
+ /**
20216
+ * 统一下单响应对象。
20217
+ 注意:此字段可能返回 null,表示取不到有效值。
20218
+ */
20219
+ Result: CreateOpenBankUnifiedOrderPaymentResult
20220
+
20221
+ /**
20222
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
20223
+ */
20224
+ RequestId?: string
20225
+ }
20226
+
19959
20227
  /**
19960
20228
  * 签约同步信息
19961
20229
  */
@@ -20859,6 +21127,45 @@ export interface QueryMemberTransactionRequest {
20859
21127
  Profile?: string
20860
21128
  }
20861
21129
 
21130
+ /**
21131
+ * 云企付-支付下单返回响应
21132
+ */
21133
+ export interface CreateOpenBankUnifiedOrderPaymentResult {
21134
+ /**
21135
+ * 云企付平台订单号。
21136
+ */
21137
+ ChannelOrderId: string
21138
+
21139
+ /**
21140
+ * 第三方支付平台返回支付订单号。
21141
+ 注意:此字段可能返回 null,表示取不到有效值。
21142
+ */
21143
+ ThirdPayOrderId: string
21144
+
21145
+ /**
21146
+ * 跳转参数 渠道为TENPAY,付款方式为EBANK_PAYMENT时必选。
21147
+ 注意:此字段可能返回 null,表示取不到有效值。
21148
+ */
21149
+ RedirectInfo: OpenBankOrderRedirectInfo
21150
+
21151
+ /**
21152
+ * 外部商户订单号,只能是数字、大小写字母,且在同一个接入平台下唯一。
21153
+ */
21154
+ OutOrderId: string
21155
+
21156
+ /**
21157
+ * 渠道扩展支付信息
21158
+ 注意:此字段可能返回 null,表示取不到有效值。
21159
+ */
21160
+ PayInfo: string
21161
+
21162
+ /**
21163
+ * 渠道扩展支付信息类型
21164
+ 注意:此字段可能返回 null,表示取不到有效值。
21165
+ */
21166
+ PayInfoType: string
21167
+ }
21168
+
20862
21169
  /**
20863
21170
  * QueryCityCode请求参数结构体
20864
21171
  */
@@ -23281,6 +23588,32 @@ export interface UploadFileResult {
23281
23588
  FilePath: string
23282
23589
  }
23283
23590
 
23591
+ /**
23592
+ * QueryAssignment返回参数结构体
23593
+ */
23594
+ export interface QueryAssignmentResponse {
23595
+ /**
23596
+ * 错误码。响应成功:"SUCCESS",其他为不成功。
23597
+ */
23598
+ ErrCode: string
23599
+
23600
+ /**
23601
+ * 响应消息
23602
+ */
23603
+ ErrMsg: string
23604
+
23605
+ /**
23606
+ * 返回响应
23607
+ 注意:此字段可能返回 null,表示取不到有效值。
23608
+ */
23609
+ Result: AssignmentData
23610
+
23611
+ /**
23612
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
23613
+ */
23614
+ RequestId?: string
23615
+ }
23616
+
23284
23617
  /**
23285
23618
  * DescribeChargeDetail请求参数结构体
23286
23619
  */
@@ -787,6 +787,7 @@ CHECK_BOX - true/false
787
787
  FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
788
788
  SELECTOR - 选项值
789
789
  DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
790
+ SIGN_SEAL - 印章Id,于控制台查询获取
790
791
  */
791
792
  ComponentValue?: string
792
793
 
@@ -1824,32 +1825,20 @@ export interface SuccessDeleteStaffData {
1824
1825
  * CreateMultiFlowSignQRCode请求参数结构体
1825
1826
  */
1826
1827
  export interface CreateMultiFlowSignQRCodeRequest {
1827
- /**
1828
- * 模板ID
1829
- */
1830
- TemplateId: string
1831
-
1832
- /**
1833
- * 签署流程名称,最大长度不超过200字符
1834
- */
1835
- FlowName: string
1836
-
1837
1828
  /**
1838
1829
  * 用户信息
1839
1830
  */
1840
1831
  Operator: UserInfo
1841
1832
 
1842
1833
  /**
1843
- * 应用信息
1834
+ * 模板ID
1844
1835
  */
1845
- Agent?: Agent
1836
+ TemplateId: string
1846
1837
 
1847
1838
  /**
1848
- * 回调地址,最大长度1000字符串
1849
- 回调时机:
1850
- 用户通过签署二维码发起签署流程时,企业额度不足导致失败
1851
- */
1852
- CallbackUrl?: string
1839
+ * 签署流程名称,最大长度不超过200字符
1840
+ */
1841
+ FlowName: string
1853
1842
 
1854
1843
  /**
1855
1844
  * 最大可发起签署流程份数,默认5份
@@ -1870,6 +1859,23 @@ export interface CreateMultiFlowSignQRCodeRequest {
1870
1859
  /**
1871
1860
  * 限制二维码用户条件
1872
1861
  */
1862
+ Restrictions?: Array<ApproverRestriction>
1863
+
1864
+ /**
1865
+ * 回调地址,最大长度1000字符串
1866
+ 回调时机:
1867
+ 用户通过签署二维码发起签署流程时,企业额度不足导致失败
1868
+ */
1869
+ CallbackUrl?: string
1870
+
1871
+ /**
1872
+ * 应用信息
1873
+ */
1874
+ Agent?: Agent
1875
+
1876
+ /**
1877
+ * 限制二维码用户条件(已弃用)
1878
+ */
1873
1879
  ApproverRestrictions?: ApproverRestriction
1874
1880
  }
1875
1881
 
@@ -145,7 +145,7 @@ export class Client extends AbstractClient {
145
145
  }
146
146
 
147
147
  /**
148
- * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,需要运营申请
148
+ * 渠道通过图片为子客代创建印章,图片最大5m;此接口不可直接使用,请联系运营/客服咨询相关流程
149
149
  */
150
150
  async CreateSealByImage(
151
151
  req: CreateSealByImageRequest,
@@ -187,7 +187,7 @@ export class Client extends AbstractClient {
187
187
 
188
188
  /**
189
189
  * 接口(CreateFlowsByTemplates)用于使用多个模板批量创建签署流程。当前可批量发起合同(签署流程)数量最大为20个。
190
-
190
+ 合同发起人必须在电子签已经进行实名。
191
191
  */
192
192
  async CreateFlowsByTemplates(
193
193
  req: CreateFlowsByTemplatesRequest,
@@ -197,8 +197,24 @@ export class Client extends AbstractClient {
197
197
  }
198
198
 
199
199
  /**
200
- * 创建跳转小程序查看或签署的链接;自动签署的签署方不创建签署链接;
201
- */
200
+ * 创建跳转小程序查看或签署的链接。
201
+
202
+ 跳转小程序的几种方式:主要是设置不同的EndPoint
203
+ 1. 通过链接Url直接跳转到小程序,不需要返回
204
+ 设置EndPoint为WEIXINAPP,得到链接打开即可。(与短信提醒用户签署形式一样)。
205
+ 2. 通过链接Url打开H5引导页-->点击跳转到小程序-->签署完退出小程序-->回到H5引导页-->跳转到指定JumpUrl
206
+ 设置EndPoint为CHANNEL,指定JumpUrl,得到链接打开即可。
207
+ 3. 客户App直接跳转到小程序-->小程序签署完成-->返回App
208
+ 跳转到小程序的实现,参考官方文档(分为全屏、半屏两种方式)
209
+ 全屏方式:
210
+ (https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
211
+ 半屏方式:
212
+ (https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
213
+ 其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
214
+ 使用CreateSignUrls,设置EndPoint为APP,得到path。
215
+ 4. 客户小程序直接跳到电子签小程序-->签署完成退出电子签小程序-->回到客户小程序
216
+ 实现方式同App跳小程序。
217
+ */
202
218
  async CreateSignUrls(
203
219
  req: CreateSignUrlsRequest,
204
220
  cb?: (error: string, rep: CreateSignUrlsResponse) => void
@@ -211,7 +227,7 @@ export class Client extends AbstractClient {
211
227
  若子客企业未激活,会进入企业激活流程,首次参与激活流程的经办人会成为超管。(若企业激活过程中填写信息有误,需要重置激活流程,可以换一个经办人OpenId获取新的链接进入。)
212
228
  若子客企业已激活,使用了新的经办人OpenId进入,则会进入经办人的实名流程。
213
229
  若子客企业、经办人均已完成认证,则会直接进入子客Web控制台。
214
-
230
+ 返回的Url仅支持PC端操作。
215
231
  */
216
232
  async CreateConsoleLoginUrl(
217
233
  req: CreateConsoleLoginUrlRequest,
@@ -288,7 +304,7 @@ export class Client extends AbstractClient {
288
304
  }
289
305
 
290
306
  /**
291
- * 查询企业员工
307
+ * 查询企业员工列表
292
308
  */
293
309
  async ChannelDescribeEmployees(
294
310
  req: ChannelDescribeEmployeesRequest,
@@ -323,8 +339,9 @@ export class Client extends AbstractClient {
323
339
  }
324
340
 
325
341
  /**
326
- * 根据签署流程信息批量获取资源下载链接,需合作企业先进行授权
327
- */
342
+ * 根据签署流程信息批量获取资源下载链接,可以下载签署中、签署完的合同,需合作企业先进行授权。
343
+ 此接口直接返回下载的资源的url,与接口GetDownloadFlowUrl跳转到控制台的下载方式不同。
344
+ */
328
345
  async DescribeResourceUrlsByFlows(
329
346
  req: DescribeResourceUrlsByFlowsRequest,
330
347
  cb?: (error: string, rep: DescribeResourceUrlsByFlowsResponse) => void
@@ -333,7 +350,7 @@ export class Client extends AbstractClient {
333
350
  }
334
351
 
335
352
  /**
336
- * 通过此接口(DescribeTemplates)查询该企业在电子签渠道版中配置的有效模板列表
353
+ * 通过此接口(DescribeTemplates)查询该子客企业在电子签拥有的的有效模板,不包括渠道模版
337
354
  */
338
355
  async DescribeTemplates(
339
356
  req: DescribeTemplatesRequest,
@@ -344,7 +361,10 @@ export class Client extends AbstractClient {
344
361
 
345
362
  /**
346
363
  * 此接口(UploadFiles)用于文件上传。
347
- 调用时需要设置Domain file.ess.tencent.cn
364
+ 调用时需要设置Domain, 正式环境为 file.ess.tencent.cn
365
+ 代码示例:
366
+ HttpProfile httpProfile = new HttpProfile();
367
+ httpProfile.setEndpoint("file.test.ess.tencent.cn");
348
368
  */
349
369
  async UploadFiles(
350
370
  req: UploadFilesRequest,
@@ -354,11 +374,11 @@ export class Client extends AbstractClient {
354
374
  }
355
375
 
356
376
  /**
357
- * 此接口(OperateChannelTemplate)用于渠道侧将模板库中的模板对合作企业进行查询和设置, 其中包括可见性的修改以及对合作企业的设置.
358
- 1、同步标识=select时:
359
- 返回渠道侧模板库当前模板的属性.
360
- 2、同步标识=update或者delete时:
361
- 对渠道子客进行模板库中模板授权,修改操作
377
+ * 此接口(OperateChannelTemplate)用于针对渠道模板库中的模板对子客企业可见性的查询和设置,不会直接分配渠道模板给子客企业。
378
+ 1、OperateType=select时:
379
+ 查询渠道模板库
380
+ 2、OperateType=update或者delete时:
381
+ 对子客企业进行模板库中模板可见性的修改、删除操作。
362
382
  */
363
383
  async OperateChannelTemplate(
364
384
  req: OperateChannelTemplateRequest,