tencentcloud-sdk-nodejs-ess 4.0.523 → 4.0.525

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.
@@ -142,73 +142,6 @@ export interface CreateMultiFlowSignQRCodeResponse {
142
142
  */
143
143
  RequestId?: string;
144
144
  }
145
- /**
146
- * DescribeThirdPartyAuthCode返回参数结构体
147
- */
148
- export interface DescribeThirdPartyAuthCodeResponse {
149
- /**
150
- * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
151
- */
152
- VerifyStatus: string;
153
- /**
154
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
155
- */
156
- RequestId?: string;
157
- }
158
- /**
159
- * CreateIntegrationEmployees请求参数结构体
160
- */
161
- export interface CreateIntegrationEmployeesRequest {
162
- /**
163
- * 操作人信息,userId必填
164
- */
165
- Operator: UserInfo;
166
- /**
167
- * 待创建员工的信息,Mobile和DisplayName必填
168
- */
169
- Employees: Array<Staff>;
170
- }
171
- /**
172
- * CreateFlowEvidenceReport请求参数结构体
173
- */
174
- export interface CreateFlowEvidenceReportRequest {
175
- /**
176
- * 调用方用户信息,userId 必填
177
- */
178
- Operator: UserInfo;
179
- /**
180
- * 签署流程编号
181
- */
182
- FlowId: string;
183
- }
184
- /**
185
- * StartFlow返回参数结构体
186
- */
187
- export interface StartFlowResponse {
188
- /**
189
- * 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
190
- */
191
- Status: string;
192
- /**
193
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
194
- */
195
- RequestId?: string;
196
- }
197
- /**
198
- * 集成版企业角色信息
199
- */
200
- export interface StaffRole {
201
- /**
202
- * 角色id
203
- 注意:此字段可能返回 null,表示取不到有效值。
204
- */
205
- RoleId: string;
206
- /**
207
- * 角色名称
208
- 注意:此字段可能返回 null,表示取不到有效值。
209
- */
210
- RoleName: string;
211
- }
212
145
  /**
213
146
  * 创建流程的签署方信息
214
147
  */
@@ -288,6 +221,98 @@ export interface FlowCreateApprover {
288
221
  */
289
222
  ApproverOption?: ApproverOption;
290
223
  }
224
+ /**
225
+ * DescribeThirdPartyAuthCode返回参数结构体
226
+ */
227
+ export interface DescribeThirdPartyAuthCodeResponse {
228
+ /**
229
+ * 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
230
+ */
231
+ VerifyStatus: string;
232
+ /**
233
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
234
+ */
235
+ RequestId?: string;
236
+ }
237
+ /**
238
+ * CreateIntegrationEmployees请求参数结构体
239
+ */
240
+ export interface CreateIntegrationEmployeesRequest {
241
+ /**
242
+ * 操作人信息,userId必填
243
+ */
244
+ Operator: UserInfo;
245
+ /**
246
+ * 待创建员工的信息,Mobile和DisplayName必填
247
+ */
248
+ Employees: Array<Staff>;
249
+ }
250
+ /**
251
+ * CreateFlowEvidenceReport请求参数结构体
252
+ */
253
+ export interface CreateFlowEvidenceReportRequest {
254
+ /**
255
+ * 调用方用户信息,userId 必填
256
+ */
257
+ Operator: UserInfo;
258
+ /**
259
+ * 签署流程编号
260
+ */
261
+ FlowId: string;
262
+ }
263
+ /**
264
+ * StartFlow返回参数结构体
265
+ */
266
+ export interface StartFlowResponse {
267
+ /**
268
+ * 返回描述,START-发起成功, REVIEW-提交审核成功,EXECUTING-已提交发起任务
269
+ */
270
+ Status: string;
271
+ /**
272
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
273
+ */
274
+ RequestId?: string;
275
+ }
276
+ /**
277
+ * 集成版企业角色信息
278
+ */
279
+ export interface StaffRole {
280
+ /**
281
+ * 角色id
282
+ 注意:此字段可能返回 null,表示取不到有效值。
283
+ */
284
+ RoleId: string;
285
+ /**
286
+ * 角色名称
287
+ 注意:此字段可能返回 null,表示取不到有效值。
288
+ */
289
+ RoleName: string;
290
+ }
291
+ /**
292
+ * 签署链接信息
293
+ */
294
+ export interface FlowApproverUrlInfo {
295
+ /**
296
+ * 签署链接,注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
297
+ 注意:此字段可能返回 null,表示取不到有效值。
298
+ */
299
+ SignUrl?: string;
300
+ /**
301
+ * 签署人手机号
302
+ 注意:此字段可能返回 null,表示取不到有效值。
303
+ */
304
+ ApproverMobile?: string;
305
+ /**
306
+ * 签署人姓名
307
+ 注意:此字段可能返回 null,表示取不到有效值。
308
+ */
309
+ ApproverName?: string;
310
+ /**
311
+ * 签署人类型 1-个人
312
+ 注意:此字段可能返回 null,表示取不到有效值。
313
+ */
314
+ ApproverType?: number;
315
+ }
291
316
  /**
292
317
  * CreateConvertTaskApi请求参数结构体
293
318
  */
@@ -1048,6 +1073,19 @@ export interface CreateFlowByFilesRequest {
1048
1073
  */
1049
1074
  SignBeanTag?: number;
1050
1075
  }
1076
+ /**
1077
+ * CreateFlowSignUrl返回参数结构体
1078
+ */
1079
+ export interface CreateFlowSignUrlResponse {
1080
+ /**
1081
+ * 签署人签署链接信息
1082
+ */
1083
+ FlowApproverUrlInfos: Array<FlowApproverUrlInfo>;
1084
+ /**
1085
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1086
+ */
1087
+ RequestId?: string;
1088
+ }
1051
1089
  /**
1052
1090
  * DescribeFileUrls请求参数结构体
1053
1091
  */
@@ -1506,6 +1544,27 @@ export interface RegisterInfo {
1506
1544
  */
1507
1545
  Uscc: string;
1508
1546
  }
1547
+ /**
1548
+ * CreateFlowSignUrl请求参数结构体
1549
+ */
1550
+ export interface CreateFlowSignUrlRequest {
1551
+ /**
1552
+ * 流程编号
1553
+ */
1554
+ FlowId: string;
1555
+ /**
1556
+ * 流程签署人,其中ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
1557
+ */
1558
+ FlowApproverInfos: Array<FlowCreateApprover>;
1559
+ /**
1560
+ * 机构信息,暂未开放
1561
+ */
1562
+ Organization: OrganizationInfo;
1563
+ /**
1564
+ * 用户信息,此结构体UserId必填
1565
+ */
1566
+ Operator?: UserInfo;
1567
+ }
1509
1568
  /**
1510
1569
  * CreateIntegrationEmployees返回参数结构体
1511
1570
  */
@@ -1692,17 +1751,76 @@ export interface VerifyPdfRequest {
1692
1751
  Operator?: UserInfo;
1693
1752
  }
1694
1753
  /**
1695
- * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
1754
+ * 参与者信息
1696
1755
  */
1697
- export interface UploadFile {
1756
+ export interface ApproverInfo {
1698
1757
  /**
1699
- * Base64编码后的文件内容
1758
+ * 参与者类型:
1759
+ 0:企业
1760
+ 1:个人
1761
+ 3:企业静默签署
1762
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
1763
+ */
1764
+ ApproverType: number;
1765
+ /**
1766
+ * 本环节需要操作人的名字
1700
1767
  */
1701
- FileBody: string;
1768
+ ApproverName: string;
1702
1769
  /**
1703
- * 文件名,最大长度不超过200字符
1770
+ * 本环节需要操作人的手机号
1704
1771
  */
1705
- FileName?: string;
1772
+ ApproverMobile: string;
1773
+ /**
1774
+ * 本环节操作人签署控件配置
1775
+ */
1776
+ SignComponents: Array<Component>;
1777
+ /**
1778
+ * 如果是企业,则为企业的名字
1779
+ */
1780
+ OrganizationName?: string;
1781
+ /**
1782
+ * 身份证号
1783
+ */
1784
+ ApproverIdCardNumber?: string;
1785
+ /**
1786
+ * 证件类型
1787
+ ID_CARD 身份证
1788
+ HONGKONG_AND_MACAO 港澳居民来往内地通行证
1789
+ HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
1790
+ */
1791
+ ApproverIdCardType?: string;
1792
+ /**
1793
+ * sms--短信,none--不通知
1794
+ */
1795
+ NotifyType?: string;
1796
+ /**
1797
+ * 1--收款人、2--开具人、3--见证人
1798
+ */
1799
+ ApproverRole?: number;
1800
+ /**
1801
+ * 签署意愿确认渠道,WEIXINAPP:人脸识别
1802
+ */
1803
+ VerifyChannel?: Array<string>;
1804
+ /**
1805
+ * 合同的强制预览时间:3~300s,未指定则按合同页数计算
1806
+ */
1807
+ PreReadTime?: number;
1808
+ /**
1809
+ * 签署人userId,传此字段则不用传姓名、手机号
1810
+ */
1811
+ UserId?: string;
1812
+ /**
1813
+ * 签署人用户来源,企微侧用户请传入:WEWORKAPP
1814
+ */
1815
+ ApproverSource?: string;
1816
+ /**
1817
+ * 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
1818
+ */
1819
+ CustomApproverTag?: string;
1820
+ /**
1821
+ * 签署人个性化能力值
1822
+ */
1823
+ ApproverOption?: ApproverOption;
1706
1824
  }
1707
1825
  /**
1708
1826
  * CreateFlowSignReview返回参数结构体
@@ -1995,76 +2113,17 @@ export interface CancelFlowRequest {
1995
2113
  Agent?: Agent;
1996
2114
  }
1997
2115
  /**
1998
- * 参与者信息
2116
+ * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
1999
2117
  */
2000
- export interface ApproverInfo {
2001
- /**
2002
- * 参与者类型:
2003
- 0:企业
2004
- 1:个人
2005
- 3:企业静默签署
2006
- 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
2007
- */
2008
- ApproverType: number;
2009
- /**
2010
- * 本环节需要操作人的名字
2011
- */
2012
- ApproverName: string;
2013
- /**
2014
- * 本环节需要操作人的手机号
2015
- */
2016
- ApproverMobile: string;
2017
- /**
2018
- * 本环节操作人签署控件配置
2019
- */
2020
- SignComponents: Array<Component>;
2021
- /**
2022
- * 如果是企业,则为企业的名字
2023
- */
2024
- OrganizationName?: string;
2025
- /**
2026
- * 身份证号
2027
- */
2028
- ApproverIdCardNumber?: string;
2029
- /**
2030
- * 证件类型
2031
- ID_CARD 身份证
2032
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
2033
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
2034
- */
2035
- ApproverIdCardType?: string;
2036
- /**
2037
- * sms--短信,none--不通知
2038
- */
2039
- NotifyType?: string;
2040
- /**
2041
- * 1--收款人、2--开具人、3--见证人
2042
- */
2043
- ApproverRole?: number;
2044
- /**
2045
- * 签署意愿确认渠道,WEIXINAPP:人脸识别
2046
- */
2047
- VerifyChannel?: Array<string>;
2048
- /**
2049
- * 合同的强制预览时间:3~300s,未指定则按合同页数计算
2050
- */
2051
- PreReadTime?: number;
2052
- /**
2053
- * 签署人userId,传此字段则不用传姓名、手机号
2054
- */
2055
- UserId?: string;
2056
- /**
2057
- * 签署人用户来源,企微侧用户请传入:WEWORKAPP
2058
- */
2059
- ApproverSource?: string;
2118
+ export interface UploadFile {
2060
2119
  /**
2061
- * 客户自定义签署人标识,64位长度,保证唯一,非企微场景不使用此字段
2120
+ * Base64编码后的文件内容
2062
2121
  */
2063
- CustomApproverTag?: string;
2122
+ FileBody: string;
2064
2123
  /**
2065
- * 签署人个性化能力值
2124
+ * 文件名,最大长度不超过200字符
2066
2125
  */
2067
- ApproverOption?: ApproverOption;
2126
+ FileName?: string;
2068
2127
  }
2069
2128
  /**
2070
2129
  * 模板控件信息