tencentcloud-sdk-nodejs 4.0.794 → 4.0.796

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 (58) hide show
  1. package/CHANGELOG.md +205 -0
  2. package/SERVICE_CHANGELOG.md +277 -19
  3. package/package.json +1 -1
  4. package/products.md +14 -14
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cfs/v20190719/cfs_client.ts +1 -1
  7. package/src/services/cfs/v20190719/cfs_models.ts +1 -1
  8. package/src/services/cynosdb/v20190107/cynosdb_client.ts +29 -5
  9. package/src/services/cynosdb/v20190107/cynosdb_models.ts +617 -155
  10. package/src/services/dlc/v20210125/dlc_models.ts +25 -20
  11. package/src/services/dnspod/v20210323/dnspod_client.ts +1 -1
  12. package/src/services/ecm/v20190719/ecm_models.ts +108 -90
  13. package/src/services/emr/v20190103/emr_client.ts +1 -0
  14. package/src/services/emr/v20190103/emr_models.ts +19 -0
  15. package/src/services/ess/v20201111/ess_client.ts +13 -10
  16. package/src/services/ess/v20201111/ess_models.ts +13 -9
  17. package/src/services/essbasic/v20210526/essbasic_client.ts +8 -22
  18. package/src/services/essbasic/v20210526/essbasic_models.ts +90 -240
  19. package/src/services/faceid/v20180301/faceid_models.ts +1 -1
  20. package/src/services/ocr/v20181119/ocr_client.ts +1 -1
  21. package/src/services/ocr/v20181119/ocr_models.ts +13 -0
  22. package/src/services/rce/v20201103/rce_models.ts +1 -1
  23. package/src/services/ssm/v20190923/ssm_models.ts +17 -16
  24. package/src/services/tcr/v20190924/tcr_client.ts +12 -0
  25. package/src/services/tcr/v20190924/tcr_models.ts +36 -0
  26. package/src/services/thpc/v20230321/thpc_models.ts +1 -1
  27. package/tencentcloud/common/sdk_version.d.ts +1 -1
  28. package/tencentcloud/common/sdk_version.js +1 -1
  29. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +1 -1
  30. package/tencentcloud/services/cfs/v20190719/cfs_client.js +1 -1
  31. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +1 -1
  32. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +5 -1
  33. package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +6 -0
  34. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +600 -152
  35. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +25 -20
  36. package/tencentcloud/services/dnspod/v20210323/dnspod_client.d.ts +1 -1
  37. package/tencentcloud/services/dnspod/v20210323/dnspod_client.js +1 -1
  38. package/tencentcloud/services/ecm/v20190719/ecm_models.d.ts +108 -90
  39. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +18 -0
  40. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +11 -8
  41. package/tencentcloud/services/ess/v20201111/ess_client.js +11 -8
  42. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +13 -9
  43. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +8 -13
  44. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +7 -14
  45. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +90 -237
  46. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +1 -1
  47. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  48. package/tencentcloud/services/ocr/v20181119/ocr_client.js +1 -1
  49. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +13 -0
  50. package/tencentcloud/services/rce/v20201103/rce_models.d.ts +1 -1
  51. package/tencentcloud/services/ssm/v20190923/ssm_models.d.ts +17 -16
  52. package/tencentcloud/services/tcr/v20190924/tcr_client.d.ts +5 -1
  53. package/tencentcloud/services/tcr/v20190924/tcr_client.js +6 -0
  54. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +34 -0
  55. package/tencentcloud/services/thpc/v20230321/thpc_models.d.ts +1 -1
  56. package/test/cynosdb.v20190107.test.js +10 -0
  57. package/test/essbasic.v20210526.test.js +0 -10
  58. package/test/tcr.v20190924.test.js +10 -0
@@ -87,6 +87,7 @@ import {
87
87
  PodNewParameter,
88
88
  DescribeInstanceRenewNodesResponse,
89
89
  ModifyResourcesTagsResponse,
90
+ ScaleOutServiceConfGroupsInfo,
90
91
  DescribeClusterNodesResponse,
91
92
  DescribeYarnApplicationsRequest,
92
93
  InquiryPriceUpdateInstanceResponse,
@@ -463,6 +463,10 @@ export interface ScaleOutClusterRequest {
463
463
  * 子网,默认是集群创建时的子网
464
464
  */
465
465
  SubnetId?: string
466
+ /**
467
+ * 扩容指定配置组
468
+ */
469
+ ScaleOutServiceConfGroupsInfo?: Array<ScaleOutServiceConfGroupsInfo>
466
470
  }
467
471
 
468
472
  /**
@@ -2994,6 +2998,21 @@ export interface ModifyResourcesTagsResponse {
2994
2998
  RequestId?: string
2995
2999
  }
2996
3000
 
3001
+ /**
3002
+ * 扩容指定配置组
3003
+ */
3004
+ export interface ScaleOutServiceConfGroupsInfo {
3005
+ /**
3006
+ * 组件版本名称 如 HDFS-2.8.5
3007
+ */
3008
+ ServiceComponentName?: string
3009
+ /**
3010
+ * 配置组名 如hdfs-core-defaultGroup ConfGroupName参数传入 代表配置组维度
3011
+ ConfGroupName参数不传 默认 代表集群维度
3012
+ */
3013
+ ConfGroupName?: string
3014
+ }
3015
+
2997
3016
  /**
2998
3017
  * DescribeClusterNodes返回参数结构体
2999
3018
  */
@@ -524,8 +524,10 @@ export class Client extends AbstractClient {
524
524
  }
525
525
 
526
526
  /**
527
- * 此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
528
- */
527
+ * 此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
528
+
529
+ 此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用
530
+ */
529
531
  async BindEmployeeUserIdWithClientOpenId(
530
532
  req: BindEmployeeUserIdWithClientOpenIdRequest,
531
533
  cb?: (error: string, rep: BindEmployeeUserIdWithClientOpenIdResponse) => void
@@ -639,8 +641,8 @@ export class Client extends AbstractClient {
639
641
  ![image](https://qcloudimg.tencent-cloud.cn/raw/06f2bc0f1772d8deac2f92b5df61a5ac.png)
640
642
 
641
643
 
642
- ### 填充模版中定义的填写控件
643
- 模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
644
+ ### 填充模板中定义的填写控件
645
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
644
646
 
645
647
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
646
648
 
@@ -762,7 +764,7 @@ export class Client extends AbstractClient {
762
764
 
763
765
  <font color="red">相关视频指引</font> <br>
764
766
  1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4" target="_blank">创建静默(自动)签署模板和开通自动签署</a><br>
765
- 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模版创建发起合同</a><br>
767
+ 2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模板创建发起合同</a><br>
766
768
  */
767
769
  async CreateFlow(
768
770
  req: CreateFlowRequest,
@@ -1237,6 +1239,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1237
1239
  3. **每个合同只能催办一次**
1238
1240
 
1239
1241
  **催办的效果**: 对方会收到如下的短信通知
1242
+
1240
1243
  ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
1241
1244
 
1242
1245
  注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
@@ -1477,18 +1480,18 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1477
1480
  </tr>
1478
1481
  <tr>
1479
1482
  <td>普通saas员工</td>
1480
- <td>不需要传递 InvitationNotifyType</td>
1481
- <td>短信</td>
1483
+ <td>将Employees中的DisplayName设置员工的名字,Mobile设置成员工的手机号</td>
1484
+ <td>发送短信通知员工(短信中带有认证加入企业的链接)</td>
1482
1485
  </tr>
1483
1486
  <tr>
1484
1487
  <td>企微员工</td>
1485
- <td>不需要传递 InvitationNotifyType,将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,但需确保该企微员工在应用的可见范围内</td>
1488
+ <td>将Employees 中的WeworkOpenId字段设置为企微员工明文的openid,需<font color="red">确保该企微员工在应用的可见范围内</font></td>
1486
1489
  <td>企微内部实名消息</td>
1487
1490
  </tr>
1488
1491
  <tr>
1489
1492
  <td>H5端 saas员工</td>
1490
- <td>传递 InvitationNotifyType = H5,不支持企微</td>
1491
- <td>生成H5链接</td>
1493
+ <td>传递 InvitationNotifyType = H5,将Employees中的DisplayName设置员工的名字,Mobile设置成员工的手机号,<font color="red">此场景不支持企微</font></td>
1494
+ <td>生成认证加入企业的H5链接,贵方可以通过自己的渠道触达到此员工</td>
1492
1495
  </tr>
1493
1496
  </tbody>
1494
1497
  </table>
@@ -2135,7 +2135,9 @@ export interface BindEmployeeUserIdWithClientOpenIdRequest {
2135
2135
  Operator: UserInfo
2136
2136
  /**
2137
2137
  * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
2138
- 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID);或者通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取。
2138
+
2139
+ 通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取,也可登录腾讯电子签控制台查看
2140
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)
2139
2141
  */
2140
2142
  UserId: string
2141
2143
  /**
@@ -3005,7 +3007,9 @@ export interface UnbindEmployeeUserIdWithClientOpenIdRequest {
3005
3007
  Operator: UserInfo
3006
3008
  /**
3007
3009
  * 员工在腾讯电子签平台的唯一身份标识,为32位字符串。
3008
- 可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查看某位员工的UserId(在页面中展示为用户ID)。
3010
+
3011
+ 通过<a href="https://qian.tencent.com/developers/companyApis/staffs/DescribeIntegrationEmployees" target="_blank">DescribeIntegrationEmployees</a>接口获取,也可登录腾讯电子签控制台查看
3012
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/97cfffabb0caa61df16999cd395d7850.png)
3009
3013
  */
3010
3014
  UserId: string
3011
3015
  /**
@@ -3659,13 +3663,13 @@ DYNAMIC_TABLE :传入json格式的表格内容,具体见数据结构[点击
3659
3663
  /**
3660
3664
  * 控件id,和ComponentName选择一项传入即可
3661
3665
 
3662
- <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件ID的方式</a>
3666
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模板中找到控件ID的方式</a>
3663
3667
  */
3664
3668
  ComponentId?: string
3665
3669
  /**
3666
3670
  * 控件名字,最大长度不超过30字符,和ComponentId选择一项传入即可
3667
3671
 
3668
- <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模版中找到控件名字的方式</a>
3672
+ <a href="https://dyn.ess.tencent.cn/guide/apivideo/component_name.mp4" target="_blank">点击查看在模板中找到控件名字的方式</a>
3669
3673
  */
3670
3674
  ComponentName?: string
3671
3675
  }
@@ -4992,7 +4996,7 @@ export interface CreateFlowByFilesResponse {
4992
4996
 
4993
4997
  注: 如果是预览模式(即NeedPreview设置为true)时, 此处不会有值返回。
4994
4998
 
4995
- [点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
4999
+ [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
4996
5000
  */
4997
5001
  FlowId?: string
4998
5002
  /**
@@ -6244,13 +6248,13 @@ export interface CancelFlowRequest {
6244
6248
  /**
6245
6249
  * 合同流程ID, 为32位字符串。
6246
6250
 
6247
- 可登录腾讯电子签控制台,[点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
6251
+ 可登录腾讯电子签控制台,[点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
6248
6252
  */
6249
6253
  FlowId: string
6250
6254
  /**
6251
6255
  * 撤销此合同流程的**撤销理由**,最多支持200个字符长度。只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
6252
6256
 
6253
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
6257
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/f16cf37dbb3a09d6569877f093b92204/channel_ChannelCancelFlow.png)
6254
6258
  */
6255
6259
  CancelMessage: string
6256
6260
  /**
@@ -6778,7 +6782,7 @@ export interface DescribeFlowBriefsRequest {
6778
6782
 
6779
6783
  可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6780
6784
 
6781
- [点击产看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
6785
+ [点击查看FlowId在控制台中的位置](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
6782
6786
  */
6783
6787
  FlowIds: Array<string>
6784
6788
  /**
@@ -7486,7 +7490,7 @@ export interface CreateFlowResponse {
7486
7490
  建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
7487
7491
 
7488
7492
  注:
7489
- 此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节,[点击产看FlowId在控制台中的位置(只在进如签署环节后有效)](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
7493
+ 此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节,[点击查看FlowId在控制台中的位置(只在进入签署环节后有效)](https://qcloudimg.tencent-cloud.cn/raw/0a83015166cfe1cb043d14f9ec4bd75e.png)
7490
7494
 
7491
7495
 
7492
7496
  */
@@ -19,7 +19,6 @@ import { AbstractClient } from "../../../common/abstract_client"
19
19
  import { ClientConfig } from "../../../common/interface"
20
20
  import {
21
21
  SyncProxyOrganizationResponse,
22
- BillUsageDetail,
23
22
  ChannelCreateConvertTaskApiResponse,
24
23
  ChannelCreateFlowRemindsResponse,
25
24
  Component,
@@ -131,7 +130,6 @@ import {
131
130
  ChannelDeleteRoleUsersResponse,
132
131
  SyncProxyOrganizationOperatorsRequest,
133
132
  ChannelCreateFlowApproversResponse,
134
- DescribeBillUsageDetailResponse,
135
133
  DescribeUsageResponse,
136
134
  CreateSignUrlsRequest,
137
135
  RegistrationOrganizationInfo,
@@ -200,7 +198,7 @@ import {
200
198
  SignUrl,
201
199
  CreateFlowGroupSignReviewRequest,
202
200
  ChannelBillUsageDetail,
203
- DescribeBillUsageDetailRequest,
201
+ DescribeTemplatesRequest,
204
202
  RelieveInfo,
205
203
  ChannelCreateSealPolicyRequest,
206
204
  OccupiedSeal,
@@ -223,7 +221,6 @@ import {
223
221
  ChannelCreateFlowApproversRequest,
224
222
  ChannelUpdateSealStatusResponse,
225
223
  ChannelCreateFlowSignUrlRequest,
226
- DescribeTemplatesRequest,
227
224
  DescribeExtendedServiceAuthInfoResponse,
228
225
  ChannelCreateEmbedWebUrlRequest,
229
226
  CcInfo,
@@ -679,8 +676,8 @@ export class Client extends AbstractClient {
679
676
  </tbody>
680
677
  </table>
681
678
 
682
- ### 三. 填充模版中定义的填写控件
683
- 模版中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
679
+ ### 三. 填充模板中定义的填写控件
680
+ 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充
684
681
 
685
682
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
686
683
  填充的传参示例如下
@@ -870,7 +867,7 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
870
867
  | 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
871
868
  | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
872
869
 
873
- **主要使用场景可以更加EndPoint分类如下**
870
+ **主要使用场景EndPoint分类**
874
871
 
875
872
  |EndPoint| 场景| 说明和示例|
876
873
  | ---- | ---- | --- |
@@ -1563,11 +1560,12 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1563
1560
  }
1564
1561
 
1565
1562
  /**
1566
- * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
1563
+ * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。
1564
+ 子客Web控制台的组织架构管理,依赖于第三方应用平台的,无法在页面针对员工做新增/更新/离职等操作, 必须通过 API 来操作。
1567
1565
 
1568
- - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
1566
+ - **新增员工的场景**: 通过本接口提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起。
1569
1567
 
1570
- - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
1568
+ - **员工离职的场景**: 通过本接口将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**。
1571
1569
 
1572
1570
  ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
1573
1571
 
@@ -1637,18 +1635,6 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
1637
1635
  return this.request("ChannelCreatePreparedPersonalEsign", req, cb)
1638
1636
  }
1639
1637
 
1640
- /**
1641
- * 废弃接口
1642
-
1643
- 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1644
- */
1645
- async DescribeBillUsageDetail(
1646
- req: DescribeBillUsageDetailRequest,
1647
- cb?: (error: string, rep: DescribeBillUsageDetailResponse) => void
1648
- ): Promise<DescribeBillUsageDetailResponse> {
1649
- return this.request("DescribeBillUsageDetail", req, cb)
1650
- }
1651
-
1652
1638
  /**
1653
1639
  * 接口(ChannelCreateFlowGroupByFiles)用于使用 PDF 文件创建合同组签署流程。
1654
1640
 
@@ -25,98 +25,6 @@ export interface SyncProxyOrganizationResponse {
25
25
  RequestId?: string
26
26
  }
27
27
 
28
- /**
29
- * 用户计费使用情况详情
30
- */
31
- export interface BillUsageDetail {
32
- /**
33
- * 合同流程ID,为32位字符串。
34
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
35
- 注意:此字段可能返回 null,表示取不到有效值。
36
- */
37
- FlowId?: string
38
- /**
39
- * 合同经办人名称
40
- 如果有多个经办人用分号隔开。
41
- 注意:此字段可能返回 null,表示取不到有效值。
42
- */
43
- OperatorName?: string
44
- /**
45
- * 发起方组织机构名称
46
- 注意:此字段可能返回 null,表示取不到有效值。
47
- */
48
- CreateOrganizationName?: string
49
- /**
50
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
51
- 该名称还将用于合同签署完成后的下载文件名。
52
- 注意:此字段可能返回 null,表示取不到有效值。
53
- */
54
- FlowName?: string
55
- /**
56
- * 当前合同状态,如下是状态码对应的状态。
57
- 0-还没有发起
58
- 1-等待签署
59
- 2-部分签署
60
- 3-拒签
61
- 4-已签署
62
- 5-已过期
63
- 6-已撤销
64
- 7-还没有预发起
65
- 8-等待填写
66
- 9-部分填写
67
- 10-拒填
68
- 11-已解除
69
- 注意:此字段可能返回 null,表示取不到有效值。
70
- */
71
- Status?: number
72
- /**
73
- * 套餐类型
74
- 对应关系如下
75
- CloudEnterprise-企业版合同
76
- SingleSignature-单方签章
77
- CloudProve-签署报告
78
- CloudOnlineSign-腾讯会议在线签约
79
- ChannelWeCard-微工卡
80
- SignFlow-合同套餐
81
- SignFace-签署意愿(人脸识别)
82
- SignPassword-签署意愿(密码)
83
- SignSMS-签署意愿(短信)
84
- PersonalEssAuth-签署人实名(腾讯电子签认证)
85
- PersonalThirdAuth-签署人实名(信任第三方认证)
86
- OrgEssAuth-签署企业实名
87
- FlowNotify-短信通知
88
- AuthService-企业工商信息查询
89
- 注意:此字段可能返回 null,表示取不到有效值。
90
- */
91
- QuotaType?: string
92
- /**
93
- * 合同使用量
94
- 注意:此字段可能返回 null,表示取不到有效值。
95
- */
96
- UseCount?: number
97
- /**
98
- * 消耗的时间戳,格式为Unix标准时间戳(秒)。
99
- 注意:此字段可能返回 null,表示取不到有效值。
100
- */
101
- CostTime?: number
102
- /**
103
- * 消耗的套餐名称
104
- 注意:此字段可能返回 null,表示取不到有效值。
105
- */
106
- QuotaName?: string
107
- /**
108
- * 消耗类型
109
- 1.扣费 2.撤销返还
110
- 注意:此字段可能返回 null,表示取不到有效值。
111
- */
112
- CostType?: number
113
- /**
114
- * 备注
115
- 注意:此字段可能返回 null,表示取不到有效值。
116
- */
117
- Remark?: string
118
- }
119
-
120
28
  /**
121
29
  * ChannelCreateConvertTaskApi返回参数结构体
122
30
  */
@@ -1806,7 +1714,11 @@ export interface ChannelCreateWebThemeConfigRequest {
1806
1714
  Agent: Agent
1807
1715
  /**
1808
1716
  * 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
1809
- <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
1717
+ <ul>
1718
+ <li>EMBED_WEB_THEME,web页面嵌入的主题风格配置</li>
1719
+ <li>COMPANY_AUTHENTICATE,子客认证主题配置, 对当前第三方应用号生效,
1720
+ 目前支持的有,背景图替换,隐藏企业认证页面导航栏和隐藏企业认证顶部logo</li>
1721
+ </ul>
1810
1722
  */
1811
1723
  ThemeType: string
1812
1724
  /**
@@ -2302,7 +2214,7 @@ export interface ChannelCreateFlowByFilesResponse {
2302
2214
  * 合同流程ID,为32位字符串。
2303
2215
  建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
2304
2216
 
2305
- [点击产看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2217
+ [点击查看FlowId在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
2306
2218
  注意:此字段可能返回 null,表示取不到有效值。
2307
2219
  */
2308
2220
  FlowId?: string
@@ -4488,24 +4400,6 @@ export interface ChannelCreateFlowApproversResponse {
4488
4400
  RequestId?: string
4489
4401
  }
4490
4402
 
4491
- /**
4492
- * DescribeBillUsageDetail返回参数结构体
4493
- */
4494
- export interface DescribeBillUsageDetailResponse {
4495
- /**
4496
- * 返回查询记录总数
4497
- */
4498
- Total?: number
4499
- /**
4500
- * 消耗记录详情
4501
- */
4502
- Details?: Array<BillUsageDetail>
4503
- /**
4504
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4505
- */
4506
- RequestId?: string
4507
- }
4508
-
4509
4403
  /**
4510
4404
  * DescribeUsage返回参数结构体
4511
4405
  */
@@ -4560,7 +4454,8 @@ export interface CreateSignUrlsRequest {
4560
4454
 
4561
4455
  **注:**动态签署人场景,如果签署链接类型设置为`APP`,则仅支持跳转到封面页。
4562
4456
 
4563
- 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
4457
+ 详细使用场景可以参考接口描述说明中的 **主要使用场景EndPoint分类**
4458
+
4564
4459
  */
4565
4460
  Endpoint?: string
4566
4461
  /**
@@ -6042,7 +5937,7 @@ export interface ChannelCreateReleaseFlowRequest {
6042
5937
  * 待解除的签署流程编号(即原签署流程的编号)。
6043
5938
 
6044
5939
 
6045
- [点击产看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
5940
+ [点击查看流程编号在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/05af26573d5106763b4cfbb9f7c64b41.png)
6046
5941
  */
6047
5942
  NeedRelievedFlowId: string
6048
5943
  /**
@@ -6887,48 +6782,103 @@ export interface ChannelBillUsageDetail {
6887
6782
  }
6888
6783
 
6889
6784
  /**
6890
- * DescribeBillUsageDetail请求参数结构体
6785
+ * DescribeTemplates请求参数结构体
6891
6786
  */
6892
- export interface DescribeBillUsageDetailRequest {
6787
+ export interface DescribeTemplatesRequest {
6893
6788
  /**
6894
6789
  * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6790
+
6791
+ 此接口下面信息必填。
6792
+ <ul>
6793
+ <li>渠道应用标识: Agent.AppId</li>
6794
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6795
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6796
+ </ul>
6797
+ 第三方平台子客企业和员工必须已经经过实名认证
6895
6798
  */
6896
6799
  Agent: Agent
6897
6800
  /**
6898
- * 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6801
+ * 合同模板ID,为32位字符串。
6802
+
6803
+ 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
6804
+
6805
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6899
6806
  */
6900
- StartTime: string
6807
+ TemplateId?: string
6901
6808
  /**
6902
- * 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
6809
+ * 查询模板的内容
6810
+
6811
+ <ul><li>**0**:(默认)模板列表及详情</li>
6812
+ <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
6903
6813
  */
6904
- EndTime: string
6814
+ ContentType?: number
6905
6815
  /**
6906
- * 查询的套餐类型 (选填 )不传则查询所有套餐;
6907
- 对应关系如下
6908
- CloudEnterprise-企业版合同
6909
- SingleSignature-单方签章
6910
- CloudProve-签署报告
6911
- CloudOnlineSign-腾讯会议在线签约
6912
- ChannelWeCard-微工卡
6913
- SignFlow-合同套餐
6914
- SignFace-签署意愿(人脸识别)
6915
- SignPassword-签署意愿(密码)
6916
- SignSMS-签署意愿(短信)
6917
- PersonalEssAuth-签署人实名(腾讯电子签认证)
6918
- PersonalThirdAuth-签署人实名(信任第三方认证)
6919
- OrgEssAuth-签署企业实名
6920
- FlowNotify-短信通知
6921
- AuthService-企业工商信息查询
6816
+ * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
6817
+
6818
+ 注意:
6819
+ 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
6820
+ 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
6821
+ 4. `若传递此参数,分页参数(Limit,Offset)无效`
6822
+
6823
+
6824
+ [点击查看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
6825
+
6922
6826
  */
6923
- QuotaType?: string
6827
+ TemplateIds?: Array<string>
6924
6828
  /**
6925
- * 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
6829
+ * 指定每页返回的数据条数,和Offset参数配合使用。
6830
+
6831
+ 注:`1.默认值为20,单页做大值为200。`
6832
+ */
6833
+ Limit?: number
6834
+ /**
6835
+ * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
6836
+
6837
+ 注:`1.offset从0开始,即第一页为0。`
6838
+ `2.默认从第一页返回。`
6926
6839
  */
6927
6840
  Offset?: number
6928
6841
  /**
6929
- * 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
6842
+ * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
6930
6843
  */
6931
- Limit?: number
6844
+ TemplateName?: string
6845
+ /**
6846
+ * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
6847
+ */
6848
+ ChannelTemplateId?: string
6849
+ /**
6850
+ * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
6851
+
6852
+ <ul><li>**false**:(默认)只返回发起方控件</li>
6853
+ <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
6854
+ */
6855
+ QueryAllComponents?: boolean
6856
+ /**
6857
+ * 是否获取模板预览链接。
6858
+
6859
+ <ul><li>**false**:不获取(默认)</li>
6860
+ <li>**true**:获取</li></ul>
6861
+
6862
+ 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
6863
+
6864
+ */
6865
+ WithPreviewUrl?: boolean
6866
+ /**
6867
+ * 是否获取模板的PDF文件链接。
6868
+
6869
+ <ul><li>**false**:不获取(默认)</li>
6870
+ <li>**true**:获取</li></ul>
6871
+
6872
+ 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
6873
+
6874
+ 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
6875
+ */
6876
+ WithPdfUrl?: boolean
6877
+ /**
6878
+ * 操作者的信息
6879
+ * @deprecated
6880
+ */
6881
+ Operator?: UserInfo
6932
6882
  }
6933
6883
 
6934
6884
  /**
@@ -7630,106 +7580,6 @@ export interface ChannelCreateFlowSignUrlRequest {
7630
7580
  UrlType?: number
7631
7581
  }
7632
7582
 
7633
- /**
7634
- * DescribeTemplates请求参数结构体
7635
- */
7636
- export interface DescribeTemplatesRequest {
7637
- /**
7638
- * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
7639
-
7640
- 此接口下面信息必填。
7641
- <ul>
7642
- <li>渠道应用标识: Agent.AppId</li>
7643
- <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
7644
- <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
7645
- </ul>
7646
- 第三方平台子客企业和员工必须已经经过实名认证
7647
- */
7648
- Agent: Agent
7649
- /**
7650
- * 合同模板ID,为32位字符串。
7651
-
7652
- 可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
7653
-
7654
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
7655
- */
7656
- TemplateId?: string
7657
- /**
7658
- * 查询模板的内容
7659
-
7660
- <ul><li>**0**:(默认)模板列表及详情</li>
7661
- <li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
7662
- */
7663
- ContentType?: number
7664
- /**
7665
- * 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
7666
-
7667
- 注意:
7668
- 1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
7669
- 2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
7670
- 4. `若传递此参数,分页参数(Limit,Offset)无效`
7671
-
7672
-
7673
- [点击产看模板Id在控制台上的位置](https://qcloudimg.tencent-cloud.cn/raw/e988be12bf28a89b4716aed4502c2e02.png)
7674
-
7675
- */
7676
- TemplateIds?: Array<string>
7677
- /**
7678
- * 指定每页返回的数据条数,和Offset参数配合使用。
7679
-
7680
- 注:`1.默认值为20,单页做大值为200。`
7681
- */
7682
- Limit?: number
7683
- /**
7684
- * 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
7685
-
7686
- 注:`1.offset从0开始,即第一页为0。`
7687
- `2.默认从第一页返回。`
7688
- */
7689
- Offset?: number
7690
- /**
7691
- * 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
7692
- */
7693
- TemplateName?: string
7694
- /**
7695
- * 对应第三方应用平台企业的模板ID,通过此值可以搜索由第三方应用平台模板ID下发或领取得到的子客模板列表。
7696
- */
7697
- ChannelTemplateId?: string
7698
- /**
7699
- * 返回控件的范围, 是只返回发起方自己的还是所有参与方的
7700
-
7701
- <ul><li>**false**:(默认)只返回发起方控件</li>
7702
- <li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
7703
- */
7704
- QueryAllComponents?: boolean
7705
- /**
7706
- * 是否获取模板预览链接。
7707
-
7708
- <ul><li>**false**:不获取(默认)</li>
7709
- <li>**true**:获取</li></ul>
7710
-
7711
- 设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
7712
-
7713
- */
7714
- WithPreviewUrl?: boolean
7715
- /**
7716
- * 是否获取模板的PDF文件链接。
7717
-
7718
- <ul><li>**false**:不获取(默认)</li>
7719
- <li>**true**:获取</li></ul>
7720
-
7721
- 设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
7722
-
7723
- 注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
7724
- */
7725
- WithPdfUrl?: boolean
7726
- /**
7727
- * 操作者的信息
7728
- * @deprecated
7729
- */
7730
- Operator?: UserInfo
7731
- }
7732
-
7733
7583
  /**
7734
7584
  * DescribeExtendedServiceAuthInfo返回参数结构体
7735
7585
  */