tencentcloud-sdk-nodejs 4.0.705 → 4.0.707

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 (132) hide show
  1. package/CHANGELOG.md +297 -0
  2. package/SERVICE_CHANGELOG.md +407 -95
  3. package/package.json +1 -1
  4. package/products.md +28 -28
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/ams/index.ts +2 -2
  7. package/src/services/batch/v20170312/batch_models.ts +7 -6
  8. package/src/services/bsca/v20210811/bsca_client.ts +43 -18
  9. package/src/services/bsca/v20210811/bsca_models.ts +107 -27
  10. package/src/services/car/v20220110/car_client.ts +1 -1
  11. package/src/services/ccc/v20200210/ccc_models.ts +2 -2
  12. package/src/services/csip/v20221121/csip_models.ts +4 -0
  13. package/src/services/cvm/v20170312/cvm_models.ts +7 -6
  14. package/src/services/dbbrain/index.ts +2 -2
  15. package/src/services/ecm/v20190719/ecm_models.ts +1 -0
  16. package/src/services/emr/v20190103/emr_client.ts +18 -4
  17. package/src/services/emr/v20190103/emr_models.ts +163 -55
  18. package/src/services/ess/v20201111/ess_models.ts +10 -3
  19. package/src/services/essbasic/index.ts +2 -2
  20. package/src/services/essbasic/v20210526/essbasic_client.ts +4 -2
  21. package/src/services/essbasic/v20210526/essbasic_models.ts +139 -62
  22. package/src/services/iai/index.ts +2 -2
  23. package/src/services/ims/index.ts +2 -2
  24. package/src/services/iotcloud/index.ts +2 -2
  25. package/src/services/iotexplorer/v20190423/iotexplorer_client.ts +14 -2
  26. package/src/services/iotexplorer/v20190423/iotexplorer_models.ts +107 -51
  27. package/src/services/iotvideo/index.ts +2 -2
  28. package/src/services/mgobe/index.ts +2 -2
  29. package/src/services/mongodb/index.ts +2 -2
  30. package/src/services/monitor/v20180724/monitor_models.ts +40 -35
  31. package/src/services/ms/v20180408/ms_client.ts +4 -3
  32. package/src/services/ms/v20180408/ms_models.ts +87 -0
  33. package/src/services/oceanus/v20190422/oceanus_client.ts +26 -2
  34. package/src/services/oceanus/v20190422/oceanus_models.ts +54 -24
  35. package/src/services/organization/index.ts +2 -2
  36. package/src/services/scf/v20180416/scf_models.ts +1 -1
  37. package/src/services/ses/v20201002/ses_models.ts +1 -1
  38. package/src/services/sms/index.ts +2 -2
  39. package/src/services/soe/v20180724/soe_models.ts +18 -12
  40. package/src/services/tbp/index.ts +2 -2
  41. package/src/services/tem/index.ts +2 -2
  42. package/src/services/thpc/index.ts +2 -2
  43. package/src/services/tione/index.ts +2 -2
  44. package/src/services/tke/v20180525/tke_models.ts +3 -2
  45. package/src/services/tms/index.ts +2 -2
  46. package/src/services/tse/v20201207/tse_client.ts +3 -0
  47. package/src/services/tse/v20201207/tse_models.ts +141 -20
  48. package/src/services/vm/index.ts +2 -2
  49. package/src/services/waf/v20180125/waf_client.ts +45 -7
  50. package/src/services/waf/v20180125/waf_models.ts +559 -391
  51. package/src/services/wedata/v20210820/wedata_client.ts +128 -28
  52. package/src/services/wedata/v20210820/wedata_models.ts +651 -92
  53. package/tencentcloud/common/sdk_version.d.ts +1 -1
  54. package/tencentcloud/common/sdk_version.js +1 -1
  55. package/tencentcloud/services/ams/index.d.ts +4 -4
  56. package/tencentcloud/services/ams/index.js +2 -2
  57. package/tencentcloud/services/batch/v20170312/batch_models.d.ts +7 -6
  58. package/tencentcloud/services/bsca/v20210811/bsca_client.d.ts +15 -7
  59. package/tencentcloud/services/bsca/v20210811/bsca_client.js +21 -9
  60. package/tencentcloud/services/bsca/v20210811/bsca_models.d.ts +102 -27
  61. package/tencentcloud/services/car/v20220110/car_client.d.ts +1 -1
  62. package/tencentcloud/services/car/v20220110/car_client.js +1 -1
  63. package/tencentcloud/services/ccc/v20200210/ccc_models.d.ts +2 -2
  64. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +4 -0
  65. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +7 -6
  66. package/tencentcloud/services/dbbrain/index.d.ts +4 -4
  67. package/tencentcloud/services/dbbrain/index.js +2 -2
  68. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +1 -0
  69. package/tencentcloud/services/emr/v20190103/emr_client.d.ts +5 -1
  70. package/tencentcloud/services/emr/v20190103/emr_client.js +6 -0
  71. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +159 -55
  72. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +10 -3
  73. package/tencentcloud/services/essbasic/index.d.ts +4 -4
  74. package/tencentcloud/services/essbasic/index.js +2 -2
  75. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +3 -1
  76. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +3 -1
  77. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +139 -62
  78. package/tencentcloud/services/iai/index.d.ts +4 -4
  79. package/tencentcloud/services/iai/index.js +2 -2
  80. package/tencentcloud/services/ims/index.d.ts +4 -4
  81. package/tencentcloud/services/ims/index.js +2 -2
  82. package/tencentcloud/services/iotcloud/index.d.ts +4 -4
  83. package/tencentcloud/services/iotcloud/index.js +2 -2
  84. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.d.ts +5 -1
  85. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_client.js +6 -0
  86. package/tencentcloud/services/iotexplorer/v20190423/iotexplorer_models.d.ts +105 -51
  87. package/tencentcloud/services/iotvideo/index.d.ts +4 -4
  88. package/tencentcloud/services/iotvideo/index.js +2 -2
  89. package/tencentcloud/services/mgobe/index.d.ts +4 -4
  90. package/tencentcloud/services/mgobe/index.js +2 -2
  91. package/tencentcloud/services/mongodb/index.d.ts +4 -4
  92. package/tencentcloud/services/mongodb/index.js +2 -2
  93. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +40 -35
  94. package/tencentcloud/services/ms/v20180408/ms_client.d.ts +3 -3
  95. package/tencentcloud/services/ms/v20180408/ms_client.js +3 -3
  96. package/tencentcloud/services/ms/v20180408/ms_models.d.ts +86 -0
  97. package/tencentcloud/services/oceanus/v20190422/oceanus_client.d.ts +9 -1
  98. package/tencentcloud/services/oceanus/v20190422/oceanus_client.js +12 -0
  99. package/tencentcloud/services/oceanus/v20190422/oceanus_models.d.ts +50 -24
  100. package/tencentcloud/services/organization/index.d.ts +4 -4
  101. package/tencentcloud/services/organization/index.js +2 -2
  102. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +1 -1
  103. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +1 -1
  104. package/tencentcloud/services/sms/index.d.ts +4 -4
  105. package/tencentcloud/services/sms/index.js +2 -2
  106. package/tencentcloud/services/soe/v20180724/soe_models.d.ts +18 -12
  107. package/tencentcloud/services/tbp/index.d.ts +4 -4
  108. package/tencentcloud/services/tbp/index.js +2 -2
  109. package/tencentcloud/services/tem/index.d.ts +4 -4
  110. package/tencentcloud/services/tem/index.js +2 -2
  111. package/tencentcloud/services/thpc/index.d.ts +4 -4
  112. package/tencentcloud/services/thpc/index.js +2 -2
  113. package/tencentcloud/services/tione/index.d.ts +4 -4
  114. package/tencentcloud/services/tione/index.js +2 -2
  115. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +3 -2
  116. package/tencentcloud/services/tms/index.d.ts +4 -4
  117. package/tencentcloud/services/tms/index.js +2 -2
  118. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +138 -20
  119. package/tencentcloud/services/vm/index.d.ts +4 -4
  120. package/tencentcloud/services/vm/index.js +2 -2
  121. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +13 -1
  122. package/tencentcloud/services/waf/v20180125/waf_client.js +18 -0
  123. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +552 -392
  124. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +44 -10
  125. package/tencentcloud/services/wedata/v20210820/wedata_client.js +62 -12
  126. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +635 -94
  127. package/test/bsca.v20210811.test.js +26 -6
  128. package/test/emr.v20190103.test.js +10 -0
  129. package/test/iotexplorer.v20190423.test.js +10 -0
  130. package/test/oceanus.v20190422.test.js +20 -0
  131. package/test/waf.v20180125.test.js +30 -0
  132. package/test/wedata.v20210820.test.js +86 -6
@@ -153,11 +153,12 @@ KEYWORD - 关键字
153
153
  为JSON格式。
154
154
  不同类型的控件会有部分非通用参数
155
155
 
156
- TEXT/MULTI_LINE_TEXT控件可以指定
156
+ ComponentType为TEXTMULTI_LINE_TEXT时,支持以下参数:
157
157
  1 Font:目前只支持黑体、宋体
158
158
  2 FontSize: 范围12-72
159
159
  3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
160
- 例如:{"FontSize":12}
160
+ 4 FontColor:字符串类型,格式为RGB颜色数字
161
+ 参数样例:{\"FontColor\":\"255,0,0\",\"FontSize\":12}
161
162
 
162
163
  ComponentType为FILL_IMAGE时,支持以下参数:
163
164
  NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
@@ -1272,62 +1273,105 @@ export interface ChannelCreateConvertTaskApiRequest {
1272
1273
  */
1273
1274
  export interface ChannelCreateFlowByFilesRequest {
1274
1275
  /**
1275
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
1276
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1277
+
1278
+ 此接口下面信息必填。
1279
+ <ul>
1280
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1281
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1282
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1283
+ </ul>
1276
1284
  */
1277
1285
  Agent?: Agent
1278
1286
  /**
1279
- * 签署流程名称,长度不超过200个字符
1287
+ * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
1280
1288
  */
1281
1289
  FlowName?: string
1282
1290
  /**
1283
- * 签署流程的描述,长度不超过1000个字符
1291
+ * 合同流程描述信息(可自定义此描述),最大长度1000个字符。
1284
1292
  */
1285
1293
  FlowDescription?: string
1286
1294
  /**
1287
- * 签署流程签约方列表,最多不超过50个参与方
1295
+ * 合同流程的参与方列表, 最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#flowapproverinfo" target="_blank">FlowApproverInfo结构体</a>。
1296
+
1297
+ 如果合同流程是有序签署,Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
1288
1298
  */
1289
1299
  FlowApprovers?: Array<FlowApproverInfo>
1290
1300
  /**
1291
- * 签署文件资源Id列表,目前仅支持单个文件
1301
+ * 本合同流程需包含的PDF文件资源编号列表,通过<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">UploadFiles</a>接口获取PDF文件资源编号。
1302
+
1303
+ 注: `目前,此接口仅支持单个文件发起。`
1292
1304
  */
1293
1305
  FileIds?: Array<string>
1294
1306
  /**
1295
- * 签署文件中的发起方的填写控件,需要在发起的时候进行填充
1307
+ * 模板或者合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
1308
+ <ul><li>单行文本控件</li>
1309
+ <li>多行文本控件</li>
1310
+ <li>勾选框控件</li>
1311
+ <li>数字控件</li>
1312
+ <li>图片控件</li>
1313
+ <li>数据表格等填写控件</li></ul>
1296
1314
  */
1297
1315
  Components?: Array<Component>
1298
1316
  /**
1299
- * 签署流程的签署截止时间。
1300
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
1301
- 不能早于当前时间
1317
+ * 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
1318
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
1302
1319
  */
1303
1320
  Deadline?: number
1304
1321
  /**
1305
- * 签署流程回调地址,长度不超过255个字符
1306
- 如果不传递回调地址, 则默认是配置应用号时候使用的回调地址
1322
+ * 执行结果的回调URL,长度不超过255个字符,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
1323
+ 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
1324
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_data_types" target="_blank">回调通知</a>模块。
1325
+
1326
+ 注:
1327
+ `如果不传递回调地址, 则默认是配置应用号时候使用的回调地址`
1307
1328
  */
1308
1329
  CallbackUrl?: string
1309
1330
  /**
1310
- * 合同签署顺序类型
1311
- true - 无序签,
1312
- false - 顺序签,
1313
- 默认为false,即有序签署。
1314
- 有序签署时以传入FlowApprovers数组的顺序作为签署顺序
1331
+ * 合同流程的签署顺序类型:
1332
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
1333
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
1334
+
1335
+
1336
+ `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
1315
1337
  */
1316
1338
  Unordered?: boolean
1317
1339
  /**
1318
- * 签署流程的类型,长度不超过255个字符
1340
+ * 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为255个字符,仅限中文、字母、数字和下划线组成。
1319
1341
  */
1320
1342
  FlowType?: string
1321
1343
  /**
1322
- * 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
1344
+ * 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
1345
+ <ul><li>{合同名称} </li>
1346
+ <li>{发起方企业} </li>
1347
+ <li>{发起方姓名} </li>
1348
+ <li>{签署方N企业}</li>
1349
+ <li>{签署方N姓名}</li></ul>
1350
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
1351
+
1352
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
1353
+
1354
+ 合同名称:租房合同
1355
+ 发起方:腾讯公司(张三)
1356
+ 签署方:李四
1357
+
1358
+
1323
1359
  */
1324
1360
  CustomShowMap?: string
1325
1361
  /**
1326
- * 业务信息,最大长度1000个字符。
1362
+ * 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 1000长度。
1363
+
1364
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">回调通知</a>模块。
1327
1365
  */
1328
1366
  CustomerData?: string
1329
1367
  /**
1330
- * 发起方企业的签署人进行签署操作是否需要企业内部审批。 若设置为true,审核结果需通过接口 ChannelCreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
1368
+ * 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
1369
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
1370
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
1371
+ 企业可以通过ChannelCreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
1372
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
1373
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
1374
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
1331
1375
  */
1332
1376
  NeedSignReview?: boolean
1333
1377
  /**
@@ -1338,24 +1382,28 @@ MobileCheck:手机号验证,用户手机号和参与方手机号(ApproverM
1338
1382
  */
1339
1383
  ApproverVerifyType?: string
1340
1384
  /**
1341
- * 标识是否允许发起后添加控件。
1342
- 0为不允许
1343
- 1为允许。
1344
- 如果为1,创建的时候不能有签署控件,只能创建后添加。注意发起后添加控件功能不支持添加骑缝章和签批控件
1385
+ * 签署方签署控件(印章/签名等)的生成方式:
1386
+ <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
1387
+ <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
1388
+
1389
+ 注:
1390
+ `发起后添加控件功能不支持添加签批控件`
1345
1391
  */
1346
1392
  SignBeanTag?: number
1347
1393
  /**
1348
- * 被抄送人信息列表
1394
+ * 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
1349
1395
  */
1350
1396
  CcInfos?: Array<CcInfo>
1351
1397
  /**
1352
- * 给关注人发送短信通知的类型,
1353
- 0-合同发起时通知
1354
- 1-签署完成后通知
1398
+ * 可以设置以下时间节点来给抄送人发送短信通知来查看合同内容:
1399
+ <ul><li> **0**:合同发起时通知(默认值)</li>
1400
+ <li> **1**:签署完成后通知</li></ul>
1355
1401
  */
1356
1402
  CcNotifyType?: number
1357
1403
  /**
1358
- * 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
1404
+ * 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
1405
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
1406
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
1359
1407
  */
1360
1408
  AutoSignScene?: string
1361
1409
  /**
@@ -3567,67 +3615,82 @@ export interface SignQrCode {
3567
3615
  其中签署方FlowApproverInfo需要传递的参数
3568
3616
  非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。
3569
3617
 
3570
- 其他身份标识
3618
+ 其他身份标识,注:`如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`
3571
3619
 
3572
3620
  <ul><li>1-个人:Name、Mobile必传</li>
3573
3621
  <li>2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;</li>
3574
3622
  <li>3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;</li>
3575
- <li>4-非第三方平台子客企业:Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
3623
+ <li>4-非第三方平台子客企业(平台企业):Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
3576
3624
 
3577
3625
  RecipientId参数:
3578
3626
  从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
3579
3627
  */
3580
3628
  export interface FlowApproverInfo {
3581
3629
  /**
3582
- * 签署人姓名,最大长度50个字符
3630
+ * 签署方经办人的姓名。
3631
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
3583
3632
  */
3584
3633
  Name?: string
3585
3634
  /**
3586
- * 签署人的证件类型
3587
- 1.ID_CARD 居民身份证
3588
- 2.HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证
3589
- 3.HONGKONG_AND_MACAO 港澳居民来往内地通行证
3590
- 4.OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
3635
+ * 签署方经办人的证件类型,支持以下类型
3636
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
3637
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
3638
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
3639
+ <li>OTHER_CARD_TYPE : 其他证件</li></ul>
3640
+
3641
+ 注: `其他证件类型为白名单功能,使用前请联系对接的客户经理沟通。`
3591
3642
  */
3592
3643
  IdCardType?: string
3593
3644
  /**
3594
- * 签署人证件号(长度不超过18位)
3645
+ * 签署方经办人的证件号码,应符合以下规则
3646
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
3647
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
3648
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
3595
3649
  */
3596
3650
  IdCardNumber?: string
3597
3651
  /**
3598
- * 签署人手机号,脱敏显示。大陆手机号为11位,暂不支持海外手机号。
3652
+ * 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符), 不支持海外手机号。
3653
+ 请确认手机号所有方为此合同签署方。
3599
3654
  */
3600
3655
  Mobile?: string
3601
3656
  /**
3602
- * 企业签署方工商营业执照上的企业名称,签署方为非发起方企业场景下必传,最大长度64个字符;
3657
+ * 组织机构名称。
3658
+ 请确认该名称与企业营业执照中注册的名称一致。
3659
+ 如果名称中包含英文括号(),请使用中文括号()代替。
3603
3660
  */
3604
3661
  OrganizationName?: string
3605
3662
  /**
3606
- * 指定签署人非第三方平台子客企业下员工,在ApproverType为ORGANIZATION时指定。
3607
- 默认为false,即签署人位于同一个第三方平台应用号下;默认为false,即签署人位于同一个第三方应用号下;
3663
+ * 指定签署人非第三方平台子客企业下员工还是SaaS平台企业,在ApproverType为ORGANIZATION时指定。
3664
+ <ul>
3665
+ <li>false: 默认值,第三方平台子客企业下员工</li>
3666
+ <li>true: SaaS平台企业下的员工</li>
3667
+ </ul>
3668
+
3608
3669
  */
3609
3670
  NotChannelOrganization?: boolean
3610
3671
  /**
3611
- * 用户侧第三方id,最大长度64个字符
3672
+ * 第三方平台子客企业员工的唯一标识,长度不能超过64,只能由字母和数字组成
3673
+
3612
3674
  当签署方为同一第三方平台下的员工时,该字段若不指定,则发起【待领取】的流程
3613
3675
  */
3614
3676
  OpenId?: string
3615
3677
  /**
3616
- * 企业签署方在同一第三方平台应用下的其他合作企业OpenId,签署方为非发起方企业场景下必传,最大长度64个字符;
3678
+ * 同应用下第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样,签署方为非发起方企业场景下必传,最大长度64个字符
3617
3679
  */
3618
3680
  OrganizationOpenId?: string
3619
3681
  /**
3620
- * 签署人类型
3621
- PERSON-个人/自然人;
3622
- PERSON_AUTO_SIGN-个人自动签署,适用于个人自动签场景
3623
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
3624
- ORGANIZATION-企业(企业签署方或模板发起时的企业静默签);
3625
- ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的本方企业自动签)
3682
+ * 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
3683
+ <ul><li> **PERSON** :个人/自然人</li>
3684
+ <li> **PERSON_AUTO_SIGN** :个人/自然人自动签署,适用于个人自动签场景</li>
3685
+ <li> **ORGANIZATION** :企业/企业员工(企业签署方或模板发起时的企业静默签)</li>
3686
+ <li> **ENTERPRISESERVER** :企业/企业员自动签(他方企业自动签署或文件发起时的本方企业自动签)</li></ul>
3626
3687
 
3627
- 若要实现他方企业(同一应用下)自动签,需要满足3个条件:
3628
- 条件1:ApproverType 设置为ENTERPRISESERVER
3629
- 条件2:子客之间完成授权
3630
- 条件3:联系对接的客户经理沟通
3688
+ 注:
3689
+ `1. 个人自动签场景(PERSON_AUTO_SIGN)为白名单功能, 使用前请联系对接的客户经理沟通。`
3690
+ `2. 若要实现他方企业(同一应用下)自动签,需要满足3个条件:`
3691
+ <ul><li>条件1:ApproverType 设置为ENTERPRISESERVER</li>
3692
+ <li>条件2:子客之间完成授权</li>
3693
+ <li>条件3:联系对接的客户经理沟通如何使用</li></ul>
3631
3694
  */
3632
3695
  ApproverType?: string
3633
3696
  /**
@@ -3635,7 +3698,8 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3635
3698
  */
3636
3699
  RecipientId?: string
3637
3700
  /**
3638
- * 签署截止时间戳,默认一年
3701
+ * 本签署人在此合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
3702
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3639
3703
  */
3640
3704
  Deadline?: number
3641
3705
  /**
@@ -3656,7 +3720,14 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3656
3720
  */
3657
3721
  ComponentLimitType?: Array<string>
3658
3722
  /**
3659
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
3723
+ * 签署方在签署合同之前,需要强制阅读合同的时长,可指定为3秒至300秒之间的任意值。
3724
+
3725
+ 若未指定阅读时间,则会按照合同页数大小计算阅读时间,计算规则如下:
3726
+ <ul>
3727
+ <li>合同页数少于等于2页,阅读时间为3秒;</li>
3728
+ <li>合同页数为3到5页,阅读时间为5秒;</li>
3729
+ <li>合同页数大于等于6页,阅读时间为10秒。</li>
3730
+ </ul>
3660
3731
  */
3661
3732
  PreReadTime?: number
3662
3733
  /**
@@ -3664,7 +3735,8 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3664
3735
  */
3665
3736
  JumpUrl?: string
3666
3737
  /**
3667
- * 签署人个性化能力值
3738
+ * 可以控制签署方在签署合同时能否进行某些操作,例如拒签、转交他人等。
3739
+ 详细操作可以参考开发者中心的ApproverOption结构体。
3668
3740
  */
3669
3741
  ApproverOption?: ApproverOption
3670
3742
  /**
@@ -3689,8 +3761,11 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3689
3761
  */
3690
3762
  SignId?: string
3691
3763
  /**
3692
- * SMS: 短信(需确保“电子签短信通知签署方”功能是开启状态才能生效); NONE: 不发信息
3693
- 默认为SMS(签署方为子客时该字段不生效)
3764
+ * 通知签署方经办人的方式, 有以下途径:
3765
+ <ul><li> **SMS** :(默认)短信</li>
3766
+ <li> **NONE** : 不通知</li></ul>
3767
+
3768
+ 注: `签署方为第三方子客企业时会被置为NONE, 不会发短信通知`
3694
3769
  */
3695
3770
  NotifyType?: string
3696
3771
  /**
@@ -3700,7 +3775,7 @@ ENTERPRISESERVER-企业自动签(他方企业自动签署或文件发起时的
3700
3775
  */
3701
3776
  AddSignComponentsLimits?: Array<ComponentLimit>
3702
3777
  /**
3703
- * 自定义签署方角色名称
3778
+ * 自定义签署人角色名,如收款人、开具人、见证人等
3704
3779
  */
3705
3780
  ApproverRoleName?: string
3706
3781
  }
@@ -4285,6 +4360,8 @@ export interface PrepareFlowsRequest {
4285
4360
  export interface ApproverItem {
4286
4361
  /**
4287
4362
  * 签署方唯一编号
4363
+
4364
+ 在动态签署人场景下,可以用此编号确定参与方
4288
4365
  注意:此字段可能返回 null,表示取不到有效值。
4289
4366
  */
4290
4367
  SignId?: string
@@ -1,7 +1,7 @@
1
- import { v20200303 } from "./v20200303"
2
1
  import { v20180301 } from "./v20180301"
2
+ import { v20200303 } from "./v20200303"
3
3
 
4
4
  export const iai = {
5
- v20200303: v20200303,
6
5
  v20180301: v20180301,
6
+ v20200303: v20200303,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20200713 } from "./v20200713"
2
1
  import { v20201229 } from "./v20201229"
2
+ import { v20200713 } from "./v20200713"
3
3
 
4
4
  export const ims = {
5
- v20200713: v20200713,
6
5
  v20201229: v20201229,
6
+ v20200713: v20200713,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20180614 } from "./v20180614"
2
1
  import { v20210408 } from "./v20210408"
2
+ import { v20180614 } from "./v20180614"
3
3
 
4
4
  export const iotcloud = {
5
- v20180614: v20180614,
6
5
  v20210408: v20210408,
6
+ v20180614: v20180614,
7
7
  }
@@ -80,7 +80,7 @@ import {
80
80
  DeviceDataHistoryItem,
81
81
  GetFamilyDeviceUserListResponse,
82
82
  BindDeviceInfo,
83
- ProjectEntryEx,
83
+ ModifyProjectRequest,
84
84
  DescribeBatchProductionResponse,
85
85
  ListTopicPolicyRequest,
86
86
  BatchProductionInfo,
@@ -190,6 +190,7 @@ import {
190
190
  UpdateFirmwareRequest,
191
191
  DescribeStudioProductRequest,
192
192
  CreatePositionSpaceResponse,
193
+ ProjectEntryEx,
193
194
  CreateBatchProductionResponse,
194
195
  ModifyLoRaFrequencyResponse,
195
196
  DeletePositionFenceRequest,
@@ -208,10 +209,11 @@ import {
208
209
  GetCOSURLRequest,
209
210
  DescribeLoRaFrequencyRequest,
210
211
  DescribeGatewayBindDevicesRequest,
212
+ GetDeviceSumStatisticsResponse,
211
213
  DescribeGatewaySubProductsRequest,
212
214
  DeleteStudioProductRequest,
213
215
  BindProductsRequest,
214
- ModifyProjectRequest,
216
+ GetDeviceSumStatisticsRequest,
215
217
  ModifySpacePropertyResponse,
216
218
  PublishMessageResponse,
217
219
  BindDevicesResponse,
@@ -648,6 +650,16 @@ export class Client extends AbstractClient {
648
650
  return this.request("CallDeviceActionAsync", req, cb)
649
651
  }
650
652
 
653
+ /**
654
+ * 拉取设备统计汇总数据
655
+ */
656
+ async GetDeviceSumStatistics(
657
+ req: GetDeviceSumStatisticsRequest,
658
+ cb?: (error: string, rep: GetDeviceSumStatisticsResponse) => void
659
+ ): Promise<GetDeviceSumStatisticsResponse> {
660
+ return this.request("GetDeviceSumStatistics", req, cb)
661
+ }
662
+
651
663
  /**
652
664
  * 提供删除某个项目的能力
653
665
  */
@@ -1221,9 +1221,9 @@ export interface BindDeviceInfo {
1221
1221
  }
1222
1222
 
1223
1223
  /**
1224
- * 项目详情
1224
+ * ModifyProject请求参数结构体
1225
1225
  */
1226
- export interface ProjectEntryEx {
1226
+ export interface ModifyProjectRequest {
1227
1227
  /**
1228
1228
  * 项目ID
1229
1229
  */
@@ -1236,46 +1236,6 @@ export interface ProjectEntryEx {
1236
1236
  * 项目描述
1237
1237
  */
1238
1238
  ProjectDesc: string
1239
- /**
1240
- * 项目创建时间,unix时间戳
1241
- */
1242
- CreateTime: number
1243
- /**
1244
- * 项目更新时间,unix时间戳
1245
- */
1246
- UpdateTime: number
1247
- /**
1248
- * 产品数量
1249
- */
1250
- ProductCount: number
1251
- /**
1252
- * NativeApp数量
1253
- */
1254
- NativeAppCount: number
1255
- /**
1256
- * WebApp数量
1257
- */
1258
- WebAppCount: number
1259
- /**
1260
- * 实例ID
1261
- 注意:此字段可能返回 null,表示取不到有效值。
1262
- */
1263
- InstanceId: string
1264
- /**
1265
- * 应用数量
1266
- 注意:此字段可能返回 null,表示取不到有效值。
1267
- */
1268
- ApplicationCount: number
1269
- /**
1270
- * 设备注册总数
1271
- 注意:此字段可能返回 null,表示取不到有效值。
1272
- */
1273
- DeviceCount: number
1274
- /**
1275
- * 是否开通物联使能
1276
- 注意:此字段可能返回 null,表示取不到有效值。
1277
- */
1278
- EnableOpenState: number
1279
1239
  }
1280
1240
 
1281
1241
  /**
@@ -3600,6 +3560,64 @@ export interface CreatePositionSpaceResponse {
3600
3560
  RequestId?: string
3601
3561
  }
3602
3562
 
3563
+ /**
3564
+ * 项目详情
3565
+ */
3566
+ export interface ProjectEntryEx {
3567
+ /**
3568
+ * 项目ID
3569
+ */
3570
+ ProjectId: string
3571
+ /**
3572
+ * 项目名称
3573
+ */
3574
+ ProjectName: string
3575
+ /**
3576
+ * 项目描述
3577
+ */
3578
+ ProjectDesc: string
3579
+ /**
3580
+ * 项目创建时间,unix时间戳
3581
+ */
3582
+ CreateTime: number
3583
+ /**
3584
+ * 项目更新时间,unix时间戳
3585
+ */
3586
+ UpdateTime: number
3587
+ /**
3588
+ * 产品数量
3589
+ */
3590
+ ProductCount: number
3591
+ /**
3592
+ * NativeApp数量
3593
+ */
3594
+ NativeAppCount: number
3595
+ /**
3596
+ * WebApp数量
3597
+ */
3598
+ WebAppCount: number
3599
+ /**
3600
+ * 实例ID
3601
+ 注意:此字段可能返回 null,表示取不到有效值。
3602
+ */
3603
+ InstanceId: string
3604
+ /**
3605
+ * 应用数量
3606
+ 注意:此字段可能返回 null,表示取不到有效值。
3607
+ */
3608
+ ApplicationCount: number
3609
+ /**
3610
+ * 设备注册总数
3611
+ 注意:此字段可能返回 null,表示取不到有效值。
3612
+ */
3613
+ DeviceCount: number
3614
+ /**
3615
+ * 是否开通物联使能
3616
+ 注意:此字段可能返回 null,表示取不到有效值。
3617
+ */
3618
+ EnableOpenState: number
3619
+ }
3620
+
3603
3621
  /**
3604
3622
  * CreateBatchProduction返回参数结构体
3605
3623
  */
@@ -3936,6 +3954,48 @@ export interface DescribeGatewayBindDevicesRequest {
3936
3954
  Limit: number
3937
3955
  }
3938
3956
 
3957
+ /**
3958
+ * GetDeviceSumStatistics返回参数结构体
3959
+ */
3960
+ export interface GetDeviceSumStatisticsResponse {
3961
+ /**
3962
+ * 激活设备总数
3963
+ */
3964
+ ActivationCount?: number
3965
+ /**
3966
+ * 在线设备总数
3967
+ */
3968
+ OnlineCount?: number
3969
+ /**
3970
+ * 前一天激活设备数
3971
+ */
3972
+ ActivationBeforeDay?: number
3973
+ /**
3974
+ * 前一天活跃设备数
3975
+ */
3976
+ ActiveBeforeDay?: number
3977
+ /**
3978
+ * 前一周激活设备数
3979
+ */
3980
+ ActivationWeekDayCount?: number
3981
+ /**
3982
+ * 前一周活跃设备数
3983
+ */
3984
+ ActiveWeekDayCount?: number
3985
+ /**
3986
+ * 上一周激活设备数
3987
+ */
3988
+ ActivationBeforeWeekDayCount?: number
3989
+ /**
3990
+ * 上一周活跃设备数
3991
+ */
3992
+ ActiveBeforeWeekDayCount?: number
3993
+ /**
3994
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3995
+ */
3996
+ RequestId?: string
3997
+ }
3998
+
3939
3999
  /**
3940
4000
  * DescribeGatewaySubProducts请求参数结构体
3941
4001
  */
@@ -3987,21 +4047,17 @@ export interface BindProductsRequest {
3987
4047
  }
3988
4048
 
3989
4049
  /**
3990
- * ModifyProject请求参数结构体
4050
+ * GetDeviceSumStatistics请求参数结构体
3991
4051
  */
3992
- export interface ModifyProjectRequest {
4052
+ export interface GetDeviceSumStatisticsRequest {
3993
4053
  /**
3994
- * 项目ID
4054
+ * 项目id
3995
4055
  */
3996
4056
  ProjectId: string
3997
4057
  /**
3998
- * 项目名称
3999
- */
4000
- ProjectName: string
4001
- /**
4002
- * 项目描述
4058
+ * 产品id列表,长度为0则拉取项目内全部产品
4003
4059
  */
4004
- ProjectDesc: string
4060
+ ProductIds?: Array<string>
4005
4061
  }
4006
4062
 
4007
4063
  /**
@@ -1,9 +1,9 @@
1
- import { v20211125 } from "./v20211125"
2
1
  import { v20191126 } from "./v20191126"
2
+ import { v20211125 } from "./v20211125"
3
3
  import { v20201215 } from "./v20201215"
4
4
 
5
5
  export const iotvideo = {
6
- v20211125: v20211125,
7
6
  v20191126: v20191126,
7
+ v20211125: v20211125,
8
8
  v20201215: v20201215,
9
9
  }
@@ -1,7 +1,7 @@
1
- import { v20190929 } from "./v20190929"
2
1
  import { v20201014 } from "./v20201014"
2
+ import { v20190929 } from "./v20190929"
3
3
 
4
4
  export const mgobe = {
5
- v20190929: v20190929,
6
5
  v20201014: v20201014,
6
+ v20190929: v20190929,
7
7
  }
@@ -1,7 +1,7 @@
1
- import { v20180408 } from "./v20180408"
2
1
  import { v20190725 } from "./v20190725"
2
+ import { v20180408 } from "./v20180408"
3
3
 
4
4
  export const mongodb = {
5
- v20180408: v20180408,
6
5
  v20190725: v20190725,
6
+ v20180408: v20180408,
7
7
  }