tencentcloud-sdk-nodejs-ess 4.1.122 → 4.1.123
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.
package/README.md
CHANGED
|
@@ -62,6 +62,8 @@ npm install tencentcloud-sdk-slim-nodejs --save
|
|
|
62
62
|
|
|
63
63
|
1. clone 代码到本地：
|
|
64
64
|
```
|
|
65
|
+
git clone https://cnb.cool/tencent/cloud/api/sdk/tencentcloud-sdk-nodejs
|
|
66
|
+
# 或者
|
|
65
67
|
git clone https://github.com/tencentcloud/tencentcloud-sdk-nodejs
|
|
66
68
|
# 或者
|
|
67
69
|
git clone https://gitee.com/tencentcloud/tencentcloud-sdk-nodejs
|
|
@@ -135,7 +137,7 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
|
135
137
|
// ...
|
|
136
138
|
```
|
|
137
139
|
|
|
138
|
-
实例化 `Client` 的入参支持 `clientConfig`，数据结构和说明详见 [ClientConfig](
|
|
140
|
+
实例化 `Client` 的入参支持 `clientConfig`，数据结构和说明详见 [ClientConfig](src/common/interface.ts)。
|
|
139
141
|
|
|
140
142
|
## Common Client
|
|
141
143
|
|
|
@@ -143,17 +145,17 @@ const CvmClient = tencentcloud.cvm.v20170312.Client
|
|
|
143
145
|
|
|
144
146
|
**注意，您必须明确知道您调用的接口所需参数，否则可能会调用失败。**
|
|
145
147
|
|
|
146
|
-
详细使用请参阅示例：[使用 Common Client 进行调用](
|
|
148
|
+
详细使用请参阅示例：[使用 Common Client 进行调用](examples/common)
|
|
147
149
|
|
|
148
150
|
## 更多示例
|
|
149
151
|
|
|
150
|
-
请参考 [examples](
|
|
152
|
+
请参考 [examples](examples) 目录。
|
|
151
153
|
|
|
152
154
|
# 相关配置
|
|
153
155
|
|
|
154
156
|
## 代理
|
|
155
157
|
|
|
156
|
-
如果是有代理的环境下，需要配置代理，请在创建 Client 时传入 [profile.httpProfile.proxy](
|
|
158
|
+
如果是有代理的环境下，需要配置代理，请在创建 Client 时传入 [profile.httpProfile.proxy](src/common/interface.ts#L78) 参数，或设置系统环境变量 `http_proxy` ，否则可能无法正常调用，抛出连接超时的异常。
|
|
157
159
|
|
|
158
160
|
# 凭证管理
|
|
159
161
|
|
package/package.json
CHANGED
|
@@ -505,7 +505,7 @@ export interface NeedReviewApproverInfo {
|
|
|
505
505
|
*/
|
|
506
506
|
ApproverName: string;
|
|
507
507
|
/**
|
|
508
|
-
* 签署方经办人手机号码，
|
|
508
|
+
* 签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 请确认手机号所有方为此合同签署方。
|
|
509
509
|
*/
|
|
510
510
|
ApproverMobile?: string;
|
|
511
511
|
/**
|
|
@@ -1789,7 +1789,7 @@ export interface FormField {
|
|
|
1789
1789
|
|
|
1790
1790
|
|
|
1791
1791
|
<b>控件值约束说明</b>：
|
|
1792
|
-
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td
|
|
1792
|
+
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
|
|
1793
1793
|
|
|
1794
1794
|
*/
|
|
1795
1795
|
ComponentValue: string;
|
|
@@ -1843,7 +1843,7 @@ export interface Staff {
|
|
|
1843
1843
|
*/
|
|
1844
1844
|
DisplayName?: string;
|
|
1845
1845
|
/**
|
|
1846
|
-
* 用户手机号码，
|
|
1846
|
+
* 用户手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
|
|
1847
1847
|
*/
|
|
1848
1848
|
Mobile?: string;
|
|
1849
1849
|
/**
|
|
@@ -2757,7 +2757,7 @@ export interface CreateOrganizationInfoChangeUrlRequest {
|
|
|
2757
2757
|
*/
|
|
2758
2758
|
export interface CcInfo {
|
|
2759
2759
|
/**
|
|
2760
|
-
* 被抄送方手机号码，
|
|
2760
|
+
* 被抄送方手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
|
|
2761
2761
|
请确认手机号所有方为此业务通知方。
|
|
2762
2762
|
*/
|
|
2763
2763
|
Mobile?: string;
|
|
@@ -2889,9 +2889,7 @@ export interface CreateSchemeUrlRequest {
|
|
|
2889
2889
|
*/
|
|
2890
2890
|
Name?: string;
|
|
2891
2891
|
/**
|
|
2892
|
-
* 合同流程里边签署方经办人手机号码，
|
|
2893
|
-
|
|
2894
|
-
`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
|
|
2892
|
+
* 合同流程里边签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。`注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
|
|
2895
2893
|
*/
|
|
2896
2894
|
Mobile?: string;
|
|
2897
2895
|
/**
|
|
@@ -3345,7 +3343,7 @@ export interface FlowCreateApprover {
|
|
|
3345
3343
|
*/
|
|
3346
3344
|
ApproverName?: string;
|
|
3347
3345
|
/**
|
|
3348
|
-
* 签署方经办人手机号码，
|
|
3346
|
+
* 签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
|
|
3349
3347
|
|
|
3350
3348
|
注：`在未指定签署人电子签UserId情况下，为必填参数`
|
|
3351
3349
|
|
|
@@ -3618,8 +3616,7 @@ export interface DescribeFlowTemplatesRequest {
|
|
|
3618
3616
|
*/
|
|
3619
3617
|
ContentType?: number;
|
|
3620
3618
|
/**
|
|
3621
|
-
* 搜索过滤的条件，本字段允许您通过指定模板 ID
|
|
3622
|
-
<ul><li><strong>模板 ID</strong>：<strong>Key</strong>设置为 <code>template-id</code> ，<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>：<strong>Key</strong>设置为 <code>share-template-id</code> ，<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 <strong>Agent.ProxyOrganizationId</strong>（子企业的组织ID）为必填项。</li> <li><strong>模板名称</strong>：<strong>Key</strong>设置为 <code>template-name</code> ，<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>：<strong>Key</strong>设置为 <code>user-flow-type-id</code> ，<strong>Values</strong>为您想要查询的用户模版类型id列表。</li></ul>
|
|
3619
|
+
* 搜索过滤的条件，本字段允许您通过指定模板 ID 或模板名称来进行查询。<ul><li><strong>模板 ID</strong>：<strong>Key</strong>设置为 <code>template-id</code> ，<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">模板 ID </a>列表。</li> <li><strong>主企业模板 ID</strong>：<strong>Key</strong>设置为 <code>share-template-id</code> ，<strong>Values</strong>为您想要查询的 <a href="https://qcloudimg.tencent-cloud.cn/raw/5c27b917b2bbe8c341566c78ca6f8782.png" target="_blank">主企业模板 ID </a>列表。用来查询主企业分享模板到子企业场景下，子企业的模板信息，在此情境下，参数 <strong>Agent.ProxyOrganizationId</strong>（子企业的组织ID）为必填项。</li> <li><strong>模板名称</strong>：<strong>Key</strong>设置为 <code>template-name</code> ，<strong>Values</strong>为您想要查询的<a href="https://qcloudimg.tencent-cloud.cn/raw/03a924ee0a53d86575f8067d1c97876d.png" target="_blank">模板名称</a>列表。</li><li><strong>模板的用户合同类型</strong>：<strong>Key</strong>设置为 <code>user-flow-type-id</code> ，<strong>Values</strong>为您想要查询的用户模板类型id列表。</li></ul>
|
|
3623
3620
|
*/
|
|
3624
3621
|
Filters?: Array<Filter>;
|
|
3625
3622
|
/**
|
|
@@ -3688,7 +3685,7 @@ export interface DescribeFlowEvidenceReportResponse {
|
|
|
3688
3685
|
RequestId?: string;
|
|
3689
3686
|
}
|
|
3690
3687
|
/**
|
|
3691
|
-
* 批量认证企业任务详情信息，其中包括 TaskId
|
|
3688
|
+
* 批量认证企业任务详情信息，其中包括 TaskId，状态信息等。
|
|
3692
3689
|
*/
|
|
3693
3690
|
export interface BatchOrganizationRegistrationTasksDetails {
|
|
3694
3691
|
/**
|
|
@@ -4308,7 +4305,7 @@ export interface VerifyDigitFileResponse {
|
|
|
4308
4305
|
*/
|
|
4309
4306
|
VerifyResult?: number;
|
|
4310
4307
|
/**
|
|
4311
|
-
* 验签序列号, 为11
|
|
4308
|
+
* 验签序列号, 为11位数字组成的字符串
|
|
4312
4309
|
*/
|
|
4313
4310
|
VerifySerialNo?: string;
|
|
4314
4311
|
/**
|
|
@@ -4911,7 +4908,7 @@ export interface MiniAppCreateApproverInfo {
|
|
|
4911
4908
|
*/
|
|
4912
4909
|
ApproverName?: string;
|
|
4913
4910
|
/**
|
|
4914
|
-
* 签署方经办人手机号码，
|
|
4911
|
+
* 签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。 此手机号用于通知和用户的实名认证等环境，请确认手机号所有方为此合同签署方。
|
|
4915
4912
|
|
|
4916
4913
|
注：`在未指定签署人电子签UserId情况下，为必填参数`
|
|
4917
4914
|
|
|
@@ -4998,13 +4995,7 @@ export interface CreateBatchSignUrlRequest {
|
|
|
4998
4995
|
*/
|
|
4999
4996
|
Name?: string;
|
|
5000
4997
|
/**
|
|
5001
|
-
* 手机号码，
|
|
5002
|
-
请确认手机号所有方为此业务通知方。
|
|
5003
|
-
|
|
5004
|
-
注：
|
|
5005
|
-
<ul>
|
|
5006
|
-
<li>请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li>
|
|
5007
|
-
</ul>
|
|
4998
|
+
* 手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。请确认手机号所有方为此业务通知方。注：<ul><li>请确保和合同中填入的一致, 若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li></ul>
|
|
5008
4999
|
*/
|
|
5009
5000
|
Mobile?: string;
|
|
5010
5001
|
/**
|
|
@@ -9135,7 +9126,7 @@ export interface Component {
|
|
|
9135
9126
|
|
|
9136
9127
|
|
|
9137
9128
|
<b>控件值约束说明</b>：
|
|
9138
|
-
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td
|
|
9129
|
+
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符，2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>中国大陆手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符，不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true，不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束，填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式：yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片，上传数量限制，1到6个，最大6个附件，填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片，填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文，英文，数字，中英文标点符号，不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>水印控件</td> <td>水印控件设置为CUSTOM_WATERMARK类型时的水印内容</td> </tr> </tbody> </table>
|
|
9139
9130
|
注： `部分特殊控件需要在控制台配置模板形式创建`
|
|
9140
9131
|
*/
|
|
9141
9132
|
ComponentValue?: string;
|
|
@@ -10940,7 +10931,7 @@ export interface ApproverInfo {
|
|
|
10940
10931
|
*/
|
|
10941
10932
|
ApproverName?: string;
|
|
10942
10933
|
/**
|
|
10943
|
-
* 签署方经办人手机号码，
|
|
10934
|
+
* 签署方经办人手机号码， 支持中国大陆手机号11位数字(无需加+86前缀或其他字符)。
|
|
10944
10935
|
请确认手机号所有方为此合同签署方。
|
|
10945
10936
|
*/
|
|
10946
10937
|
ApproverMobile?: string;
|