tencentcloud-sdk-nodejs 4.0.306 → 4.0.309

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 (92) hide show
  1. package/CHANGELOG.md +504 -0
  2. package/SERVICE_CHANGELOG.md +529 -13
  3. package/package.json +1 -1
  4. package/products.md +35 -35
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/antiddos/v20200309/antiddos_models.ts +6 -0
  7. package/src/services/apigateway/v20180808/apigateway_client.ts +1 -1
  8. package/src/services/apigateway/v20180808/apigateway_models.ts +32 -4
  9. package/src/services/captcha/v20190722/captcha_models.ts +21 -6
  10. package/src/services/cdb/v20170320/cdb_models.ts +1 -1
  11. package/src/services/cdn/v20180606/cdn_models.ts +8 -0
  12. package/src/services/cfw/v20190904/cfw_client.ts +13 -0
  13. package/src/services/cfw/v20190904/cfw_models.ts +50 -0
  14. package/src/services/ckafka/v20190819/ckafka_models.ts +10 -0
  15. package/src/services/cls/v20201016/cls_client.ts +80 -27
  16. package/src/services/cls/v20201016/cls_models.ts +656 -129
  17. package/src/services/cpdp/v20190820/cpdp_models.ts +9 -8
  18. package/src/services/cvm/v20170312/cvm_models.ts +18 -8
  19. package/src/services/dbbrain/v20210527/dbbrain_client.ts +1 -1
  20. package/src/services/dlc/v20210125/dlc_models.ts +82 -5
  21. package/src/services/ess/v20201111/ess_models.ts +22 -0
  22. package/src/services/essbasic/v20210526/essbasic_models.ts +21 -5
  23. package/src/services/iecp/v20210914/iecp_client.ts +560 -474
  24. package/src/services/iecp/v20210914/iecp_models.ts +497 -189
  25. package/src/services/mps/v20190612/mps_client.ts +3 -3
  26. package/src/services/mps/v20190612/mps_models.ts +158 -158
  27. package/src/services/nlp/v20190408/nlp_client.ts +16 -0
  28. package/src/services/nlp/v20190408/nlp_models.ts +30 -0
  29. package/src/services/partners/v20180321/partners_models.ts +4 -4
  30. package/src/services/redis/v20180412/redis_models.ts +1 -1
  31. package/src/services/rum/v20210622/rum_models.ts +5 -0
  32. package/src/services/scf/v20180416/scf_models.ts +12 -0
  33. package/src/services/ses/v20201002/ses_client.ts +14 -2
  34. package/src/services/ses/v20201002/ses_models.ts +55 -30
  35. package/src/services/smh/v20210712/smh_models.ts +35 -0
  36. package/src/services/tiia/v20190529/tiia_models.ts +7 -5
  37. package/src/services/tke/v20180525/tke_models.ts +6 -0
  38. package/src/services/tse/v20201207/tse_models.ts +6 -0
  39. package/src/services/vpc/v20170312/vpc_client.ts +108 -15
  40. package/src/services/vpc/v20170312/vpc_models.ts +119 -29
  41. package/tencentcloud/common/sdk_version.d.ts +1 -1
  42. package/tencentcloud/common/sdk_version.js +1 -1
  43. package/tencentcloud/services/antiddos/v20200309/antiddos_models.d.ts +5 -0
  44. package/tencentcloud/services/apigateway/v20180808/apigateway_client.d.ts +1 -1
  45. package/tencentcloud/services/apigateway/v20180808/apigateway_client.js +1 -1
  46. package/tencentcloud/services/apigateway/v20180808/apigateway_models.d.ts +28 -4
  47. package/tencentcloud/services/captcha/v20190722/captcha_models.d.ts +18 -6
  48. package/tencentcloud/services/cdb/v20170320/cdb_models.d.ts +1 -1
  49. package/tencentcloud/services/cdn/v20180606/cdn_models.d.ts +8 -0
  50. package/tencentcloud/services/cfw/v20190904/cfw_client.d.ts +5 -1
  51. package/tencentcloud/services/cfw/v20190904/cfw_client.js +6 -0
  52. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +43 -0
  53. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +8 -0
  54. package/tencentcloud/services/cls/v20201016/cls_client.d.ts +24 -8
  55. package/tencentcloud/services/cls/v20201016/cls_client.js +34 -10
  56. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +586 -146
  57. package/tencentcloud/services/cpdp/v20190820/cpdp_models.d.ts +7 -6
  58. package/tencentcloud/services/cvm/v20170312/cvm_models.d.ts +16 -8
  59. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.d.ts +1 -1
  60. package/tencentcloud/services/dbbrain/v20210527/dbbrain_client.js +1 -1
  61. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +69 -5
  62. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +18 -0
  63. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +18 -5
  64. package/tencentcloud/services/iecp/v20210914/iecp_client.d.ts +183 -155
  65. package/tencentcloud/services/iecp/v20210914/iecp_client.js +273 -231
  66. package/tencentcloud/services/iecp/v20210914/iecp_models.d.ts +420 -157
  67. package/tencentcloud/services/mps/v20190612/mps_client.d.ts +3 -3
  68. package/tencentcloud/services/mps/v20190612/mps_client.js +3 -3
  69. package/tencentcloud/services/mps/v20190612/mps_models.d.ts +158 -158
  70. package/tencentcloud/services/nlp/v20190408/nlp_client.d.ts +9 -1
  71. package/tencentcloud/services/nlp/v20190408/nlp_client.js +10 -0
  72. package/tencentcloud/services/nlp/v20190408/nlp_models.d.ts +26 -0
  73. package/tencentcloud/services/partners/v20180321/partners_models.d.ts +4 -4
  74. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +1 -1
  75. package/tencentcloud/services/rum/v20210622/rum_models.d.ts +4 -0
  76. package/tencentcloud/services/scf/v20180416/scf_models.d.ts +10 -0
  77. package/tencentcloud/services/ses/v20201002/ses_client.d.ts +5 -1
  78. package/tencentcloud/services/ses/v20201002/ses_client.js +6 -0
  79. package/tencentcloud/services/ses/v20201002/ses_models.d.ts +47 -25
  80. package/tencentcloud/services/smh/v20210712/smh_models.d.ts +28 -0
  81. package/tencentcloud/services/tiia/v20190529/tiia_models.d.ts +7 -5
  82. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +5 -0
  83. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +5 -0
  84. package/tencentcloud/services/vpc/v20170312/vpc_client.d.ts +51 -6
  85. package/tencentcloud/services/vpc/v20170312/vpc_client.js +64 -7
  86. package/tencentcloud/services/vpc/v20170312/vpc_models.d.ts +103 -25
  87. package/test/cfw.v20190904.test.js +10 -0
  88. package/test/cls.v20201016.test.js +46 -6
  89. package/test/iecp.v20210914.test.js +226 -156
  90. package/test/nlp.v20190408.test.js +10 -0
  91. package/test/ses.v20201002.test.js +10 -0
  92. package/test/vpc.v20170312.test.js +64 -4
@@ -373,11 +373,11 @@ export interface QueryOpenBankPaymentOrderRequest {
373
373
  */
374
374
  ChannelMerchantId: string;
375
375
  /**
376
- * 外部商户订单号。与ChannelOrderId不能同时为空字符串。
376
+ * 外部商户订单号。与ChannelOrderId二者选一。
377
377
  */
378
378
  OutOrderId: string;
379
379
  /**
380
- * 云平台订单号。与OutOrderId不能同时为空字符串。
380
+ * 云平台订单号。与OutOrderId二者选一。
381
381
  */
382
382
  ChannelOrderId: string;
383
383
  /**
@@ -3016,11 +3016,11 @@ export interface OpenBankSceneInfo {
3016
3016
  /**
3017
3017
  * 用户端实际 ip,示例值:14.17.22.32
3018
3018
  */
3019
- PayerClientIp: string;
3019
+ PayerClientIp?: string;
3020
3020
  /**
3021
3021
  * 浏览器 User-Agent
3022
3022
  */
3023
- PayerUa: string;
3023
+ PayerUa?: string;
3024
3024
  /**
3025
3025
  * 用户下单时间,若不上送,服务端默认当前时间
3026
3026
  */
@@ -7796,6 +7796,7 @@ export interface QueryOpenBankDownLoadUrlResponse {
7796
7796
  ErrMessage: string;
7797
7797
  /**
7798
7798
  * 查询对账文件下载响应对象。
7799
+ 注意:此字段可能返回 null,表示取不到有效值。
7799
7800
  */
7800
7801
  Result: QueryOpenBankDownLoadUrlResult;
7801
7802
  /**
@@ -9942,7 +9943,7 @@ export interface OpenBankGoodsInfo {
9942
9943
  /**
9943
9944
  * 商品名称,默认值“商品支付”
9944
9945
  */
9945
- GoodsName: string;
9946
+ GoodsName?: string;
9946
9947
  /**
9947
9948
  * 商品详细描述(商品列表)
9948
9949
  */
@@ -11499,7 +11500,7 @@ export interface OpenBankPayeeInfo {
11499
11500
  BankBranchId?: string;
11500
11501
  /**
11501
11502
  * 收款方绑卡序列号。
11502
- 当渠道为TENPAY,付款方式为EBANK_PAYMENT时,上送收款方入驻云企付平台时,下发的绑卡序列号。
11503
+ 当渠道为TENPAY,付款方式为EBANK_PAYMENT时,必填,上送收款方入驻云企付平台时,下发的绑卡序列号。
11503
11504
  */
11504
11505
  BindSerialNo?: string;
11505
11506
  }
@@ -383,11 +383,11 @@ export interface DescribeHostsResponse {
383
383
  /**
384
384
  * 符合查询条件的cdh实例总数
385
385
  */
386
- TotalCount?: number;
386
+ TotalCount: number;
387
387
  /**
388
388
  * cdh实例详细信息列表
389
389
  */
390
- HostSet?: Array<HostItem>;
390
+ HostSet: Array<HostItem>;
391
391
  /**
392
392
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
393
393
  */
@@ -657,11 +657,11 @@ export interface DescribeInstancesStatusResponse {
657
657
  /**
658
658
  * 符合条件的实例状态数量。
659
659
  */
660
- TotalCount?: number;
660
+ TotalCount: number;
661
661
  /**
662
662
  * [实例状态](https://cloud.tencent.com/document/api/213/15753#InstanceStatus) 列表。
663
663
  */
664
- InstanceStatusSet?: Array<InstanceStatus>;
664
+ InstanceStatusSet: Array<InstanceStatus>;
665
665
  /**
666
666
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
667
667
  */
@@ -792,7 +792,7 @@ export interface InquiryPriceModifyInstancesChargeTypeResponse {
792
792
  /**
793
793
  * 该参数表示对应配置实例转换计费模式的价格。
794
794
  */
795
- Price?: Price;
795
+ Price: Price;
796
796
  /**
797
797
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
798
798
  */
@@ -919,13 +919,17 @@ export interface ModifyInstancesChargeTypeRequest {
919
919
  */
920
920
  InstanceIds: Array<string>;
921
921
  /**
922
- * 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月。
922
+ * 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月。<br><li>POSTPAID_BY_HOUR:后付费,即按量付费。
923
923
  */
924
924
  InstanceChargeType: string;
925
925
  /**
926
926
  * 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。<dx-alert infotype="explain" title="">若指定实例的付费模式为预付费则该参数必传。</dx-alert>
927
927
  */
928
928
  InstanceChargePrepaid?: InstanceChargePrepaid;
929
+ /**
930
+ * 是否同时切换弹性数据云盘计费模式。取值范围:<br><li>TRUE:表示切换弹性数据云盘计费模式<br><li>FALSE:表示不切换弹性数据云盘计费模式<br><br>默认取值:FALSE。
931
+ */
932
+ ModifyPortableDataDisk?: boolean;
929
933
  }
930
934
  /**
931
935
  * DescribeInstanceVncUrl请求参数结构体
@@ -2037,13 +2041,17 @@ export interface InquiryPriceModifyInstancesChargeTypeRequest {
2037
2041
  */
2038
2042
  InstanceIds: Array<string>;
2039
2043
  /**
2040
- * 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月。
2044
+ * 实例[计费类型](https://cloud.tencent.com/document/product/213/2180)。<br><li>PREPAID:预付费,即包年包月。<br><li>POSTPAID_BY_HOUR:后付费,即按量付费。
2041
2045
  */
2042
2046
  InstanceChargeType: string;
2043
2047
  /**
2044
- * 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
2048
+ * 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的购买时长、是否设置自动续费等属性。<dx-alert infotype="explain" title="">若指定实例的付费模式为预付费则该参数必传。</dx-alert>
2045
2049
  */
2046
2050
  InstanceChargePrepaid?: InstanceChargePrepaid;
2051
+ /**
2052
+ * 是否同时切换弹性数据云盘计费模式。取值范围:<br><li>TRUE:表示切换弹性数据云盘计费模式<br><li>FALSE:表示不切换弹性数据云盘计费模式<br><br>默认取值:FALSE。
2053
+ */
2054
+ ModifyPortableDataDisk?: boolean;
2047
2055
  }
2048
2056
  /**
2049
2057
  * CreateImage请求参数结构体
@@ -116,7 +116,7 @@ export declare class Client extends AbstractClient {
116
116
  */
117
117
  CreateKillTask(req: CreateKillTaskRequest, cb?: (error: string, rep: CreateKillTaskResponse) => void): Promise<CreateKillTaskResponse>;
118
118
  /**
119
- * 获取SQL优化建议。
119
+ * 获取SQL优化建议。【产品用户回馈,此接口限免开放,后续将并入dbbrain专业版】
120
120
  */
121
121
  DescribeUserSqlAdvice(req: DescribeUserSqlAdviceRequest, cb?: (error: string, rep: DescribeUserSqlAdviceResponse) => void): Promise<DescribeUserSqlAdviceResponse>;
122
122
  /**
@@ -190,7 +190,7 @@ class Client extends abstract_client_1.AbstractClient {
190
190
  return this.request("CreateKillTask", req, cb);
191
191
  }
192
192
  /**
193
- * 获取SQL优化建议。
193
+ * 获取SQL优化建议。【产品用户回馈,此接口限免开放,后续将并入dbbrain专业版】
194
194
  */
195
195
  async DescribeUserSqlAdvice(req, cb) {
196
196
  return this.request("DescribeUserSqlAdvice", req, cb);
@@ -648,6 +648,10 @@ export interface DescribeUsersRequest {
648
648
  * 排序方式,desc表示正序,asc表示反序, 默认为asc
649
649
  */
650
650
  Sorting?: string;
651
+ /**
652
+ * 过滤条件,支持如下字段类型,user-type:根据用户类型过滤。
653
+ */
654
+ Filters?: Array<Filter>;
651
655
  }
652
656
  /**
653
657
  * DescribeScripts请求参数结构体
@@ -773,10 +777,15 @@ export interface UserInfo {
773
777
  */
774
778
  WorkGroupSet: Array<WorkGroupMessage>;
775
779
  /**
776
- * 是否是管理员账号
780
+ * 是否是主账号
777
781
  注意:此字段可能返回 null,表示取不到有效值。
778
782
  */
779
783
  IsOwner: boolean;
784
+ /**
785
+ * 用户类型。ADMIN:管理员 COMMON:普通用户。
786
+ 注意:此字段可能返回 null,表示取不到有效值。
787
+ */
788
+ UserType: string;
780
789
  }
781
790
  /**
782
791
  * AttachWorkGroupPolicy返回参数结构体
@@ -1065,7 +1074,7 @@ string|tinyint|smallint|int|bigint|boolean|float|double|decimal|timestamp|date|b
1065
1074
  */
1066
1075
  Nullable?: string;
1067
1076
  /**
1068
- * 字段位置
1077
+ * 字段位置,小的在前
1069
1078
  注意:此字段可能返回 null,表示取不到有效值。
1070
1079
  */
1071
1080
  Position?: number;
@@ -1508,7 +1517,7 @@ export interface Policy {
1508
1517
  */
1509
1518
  Database: string;
1510
1519
  /**
1511
- * 需要授权的数据源名称,管理员级别下只支持填*(代表该级别全部资源);数据源级别和数据库级别鉴权的情况下,只支持填COSDataCatalog或者*;在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为COSDataCatalog。注意:如果是对用户自定义数据源进行鉴权,DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。
1520
+ * 需要授权的数据源名称,管理员级别下只支持填*(代表该级别全部资源);数据源级别和数据库级别鉴权的情况下,只支持填COSDataCatalog或者*;在数据表级别鉴权下可以填写用户自定义数据源。不填情况下默认为DataLakeCatalog。注意:如果是对用户自定义数据源进行鉴权,DLC能够管理的权限是用户接入数据源的时候提供的账户的子集。
1512
1521
  */
1513
1522
  Catalog: string;
1514
1523
  /**
@@ -1516,13 +1525,58 @@ export interface Policy {
1516
1525
  */
1517
1526
  Table: string;
1518
1527
  /**
1519
- * 授权的权限操作,对于不同级别的鉴权提供不同操作。管理员权限:ALL,不填默认为ALL;数据连接级鉴权:CRETE;数据库级别鉴权:ALL、CREATE、ALTER、DROP;数据表权限:ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意:在数据表权限下,指定的数据源不为COSDataCatalog的时候,只支持SELECT操作。
1528
+ * 授权的权限操作,对于不同级别的鉴权提供不同操作。管理员权限:ALL,不填默认为ALL;数据连接级鉴权:CREATE;数据库级别鉴权:ALL、CREATE、ALTER、DROP;数据表权限:ALL、SELECT、INSERT、ALTER、DELETE、DROP、UPDATE。注意:在数据表权限下,指定的数据源不为COSDataCatalog的时候,只支持SELECT操作。
1520
1529
  */
1521
1530
  Operation: string;
1522
1531
  /**
1523
- * 授权类型,现在支持四种授权类型:ADMIN:管理员级别鉴权 DATASOURCE:数据连接级别鉴权 DATABASE:数据库级别鉴权 TABLE:表级别鉴权。不填默认为管理员级别鉴权。
1532
+ * 授权类型,现在支持八种授权类型:ADMIN:管理员级别鉴权 DATASOURCE:数据连接级别鉴权 DATABASE:数据库级别鉴权 TABLE:表级别鉴权 VIEW:视图级别鉴权 FUNCTION:函数级别鉴权 COLUMN:列级别鉴权 ENGINE:数据引擎鉴权。不填默认为管理员级别鉴权。
1524
1533
  */
1525
1534
  PolicyType?: string;
1535
+ /**
1536
+ * 需要授权的函数名,填*代表当前Catalog下所有函数。当授权类型为管理员级别时,只允许填“*”,当授权类型为数据连接级别时只允许填空,其他类型下可以任意指定函数。
1537
+ 注意:此字段可能返回 null,表示取不到有效值。
1538
+ */
1539
+ Function?: string;
1540
+ /**
1541
+ * 需要授权的视图,填*代表当前Database下所有视图。当授权类型为管理员级别时,只允许填“*”,当授权类型为数据连接级别、数据库级别时只允许填空,其他类型下可以任意指定视图。
1542
+ 注意:此字段可能返回 null,表示取不到有效值。
1543
+ */
1544
+ View?: string;
1545
+ /**
1546
+ * 需要授权的列,填*代表当前所有列。当授权类型为管理员级别时,只允许填“*”
1547
+ 注意:此字段可能返回 null,表示取不到有效值。
1548
+ */
1549
+ Column?: string;
1550
+ /**
1551
+ * 需要授权的数据引擎,填*代表当前所有引擎。当授权类型为管理员级别时,只允许填“*”
1552
+ 注意:此字段可能返回 null,表示取不到有效值。
1553
+ */
1554
+ DataEngine?: string;
1555
+ /**
1556
+ * 用户是否可以进行二次授权。当为true的时候,被授权的用户可以将本次获取的权限再次授权给其他子用户。默认为false
1557
+ 注意:此字段可能返回 null,表示取不到有效值。
1558
+ */
1559
+ ReAuth?: boolean;
1560
+ /**
1561
+ * 权限来源,入参不填。USER:权限来自用户本身;WORKGROUP:权限来自绑定的工作组
1562
+ 注意:此字段可能返回 null,表示取不到有效值。
1563
+ */
1564
+ Source?: string;
1565
+ /**
1566
+ * 授权模式,入参不填。COMMON:普通模式;SENIOR:高级模式。
1567
+ 注意:此字段可能返回 null,表示取不到有效值。
1568
+ */
1569
+ Mode?: string;
1570
+ /**
1571
+ * 操作者,入参不填。
1572
+ 注意:此字段可能返回 null,表示取不到有效值。
1573
+ */
1574
+ Operator?: string;
1575
+ /**
1576
+ * 权限创建的时间,入参不填
1577
+ 注意:此字段可能返回 null,表示取不到有效值。
1578
+ */
1579
+ CreateTime?: string;
1526
1580
  }
1527
1581
  /**
1528
1582
  * CreateTasks请求参数结构体
@@ -1644,6 +1698,16 @@ export interface TableResponseInfo {
1644
1698
  注意:此字段可能返回 null,表示取不到有效值。
1645
1699
  */
1646
1700
  InputFormat: string;
1701
+ /**
1702
+ * 数据表存储大小(单位:Byte)
1703
+ 注意:此字段可能返回 null,表示取不到有效值。
1704
+ */
1705
+ StorageSize: number;
1706
+ /**
1707
+ * 数据表行数
1708
+ 注意:此字段可能返回 null,表示取不到有效值。
1709
+ */
1710
+ RecordCount: number;
1647
1711
  }
1648
1712
  /**
1649
1713
  * AddUsersToWorkGroup返回参数结构体
@@ -23,6 +23,11 @@ export interface CreateDocumentResponse {
23
23
  * 返回的电子文档ID
24
24
  */
25
25
  DocumentId: string;
26
+ /**
27
+ * 返回合同文件的预览地址 5分钟内有效。仅当NeedPreview为true 时返回
28
+ 注意:此字段可能返回 null,表示取不到有效值。
29
+ */
30
+ PreviewFileUrl: string;
26
31
  /**
27
32
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
28
33
  */
@@ -90,6 +95,10 @@ export interface CreateDocumentRequest {
90
95
  * 客户端Token,保持接口幂等性
91
96
  */
92
97
  ClientToken?: string;
98
+ /**
99
+ * 是否需要生成预览文件 默认不生成
100
+ */
101
+ NeedPreview?: boolean;
93
102
  }
94
103
  /**
95
104
  * CreateFlow请求参数结构体
@@ -325,6 +334,11 @@ export interface CreateFlowByFilesResponse {
325
334
  * 流程编号
326
335
  */
327
336
  FlowId: string;
337
+ /**
338
+ * 合同预览链接
339
+ 注意:此字段可能返回 null,表示取不到有效值。
340
+ */
341
+ PreviewUrl: string;
328
342
  /**
329
343
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
330
344
  */
@@ -598,6 +612,10 @@ MULTI_LINE_TEXT - 多行文本控件
598
612
  * 被抄送人的信息列表
599
613
  */
600
614
  CcInfos?: Array<CcInfo>;
615
+ /**
616
+ * 是否需要预览,true:预览模式,false:非预览(默认)
617
+ */
618
+ NeedPreview?: boolean;
601
619
  }
602
620
  /**
603
621
  * CreateFlow返回参数结构体
@@ -83,6 +83,11 @@ export interface FlowApproverInfo {
83
83
  * 企业签署方在同一渠道下的其他合作企业OpenId,签署方为非发起方企业场景下必传;
84
84
  */
85
85
  OrganizationOpenId?: string;
86
+ /**
87
+ * 指定签署人非渠道企业下员工,在ApproverType为ORGANIZATION时指定。
88
+ 默认为false,即签署人位于同一个渠道应用号下;
89
+ */
90
+ NotChannelOrganization?: boolean;
86
91
  }
87
92
  /**
88
93
  * PrepareFlows返回参数结构体
@@ -316,7 +321,7 @@ export interface CreateSignUrlsRequest {
316
321
  */
317
322
  Endpoint?: string;
318
323
  /**
319
- * 签署完成后H5引导页跳转URL
324
+ * 签署完之后的H5页面的跳转链接,针对Endpoint为CHANNEL时有效
320
325
  */
321
326
  JumpUrl?: string;
322
327
  }
@@ -575,6 +580,10 @@ export interface CreateFlowsByTemplatesResponse {
575
580
  成功为“”,创建失败则对应失败消息
576
581
  */
577
582
  ErrorMessages: Array<string>;
583
+ /**
584
+ * 预览模式下返回的预览文件url数组
585
+ */
586
+ PreviewUrls: Array<string>;
578
587
  /**
579
588
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
580
589
  */
@@ -632,7 +641,7 @@ export interface SignUrlInfo {
632
641
  */
633
642
  SignUrl: string;
634
643
  /**
635
- * 链接失效时间
644
+ * 链接失效时间,默认30分钟
636
645
  注意:此字段可能返回 null,表示取不到有效值。
637
646
  */
638
647
  Deadline: number;
@@ -747,7 +756,7 @@ export interface SyncProxyOrganizationOperatorsRequest {
747
756
  */
748
757
  export interface CreateConsoleLoginUrlResponse {
749
758
  /**
750
- * 控制台url
759
+ * 控制台url,此链接5分钟内有效,且只能访问一次
751
760
  */
752
761
  ConsoleUrl: string;
753
762
  /**
@@ -776,6 +785,10 @@ export interface CreateFlowsByTemplatesRequest {
776
785
  * 操作者的信息
777
786
  */
778
787
  Operator?: UserInfo;
788
+ /**
789
+ * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,则返回PreviewUrls;
790
+ */
791
+ NeedPreview?: boolean;
779
792
  }
780
793
  /**
781
794
  * SyncProxyOrganization请求参数结构体
@@ -1052,7 +1065,7 @@ export interface FlowInfo {
1052
1065
  */
1053
1066
  FlowName: string;
1054
1067
  /**
1055
- * 签署截止时间戳,超过有效签署时间则该签署流程失败
1068
+ * 签署截止时间戳,超过有效签署时间则该签署流程失败,默认一年
1056
1069
  */
1057
1070
  Deadline: number;
1058
1071
  /**
@@ -1072,7 +1085,7 @@ export interface FlowInfo {
1072
1085
  */
1073
1086
  CallbackUrl?: string;
1074
1087
  /**
1075
- * 多个签署人信息
1088
+ * 多个签署人信息,渠道侧目前不支持超过5个签署方信息
1076
1089
  */
1077
1090
  FlowApprovers?: Array<FlowApproverInfo>;
1078
1091
  /**