tencentcloud-sdk-nodejs-ess 4.0.531 → 4.0.533

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.
@@ -109,79 +109,68 @@ APP:第三方APP或小程序跳转电子签小程序的path。
109
109
  }
110
110
 
111
111
  /**
112
- * CreateFlowApprovers返回参数结构体
112
+ * 二期接口返回的模板中文件的信息结构
113
113
  */
114
- export interface CreateFlowApproversResponse {
114
+ export interface FileInfo {
115
115
  /**
116
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
116
+ * 文件Id
117
117
  */
118
- RequestId?: string
119
- }
120
-
121
- /**
122
- * UploadFiles请求参数结构体
123
- */
124
- export interface UploadFilesRequest {
125
- /**
126
- * 文件对应业务类型
127
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
128
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
129
- 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
130
- */
131
- BusinessType: string
118
+ FileId?: string
132
119
 
133
120
  /**
134
- * 调用方信息,其中OperatorId为必填字段,即用户的UserId
121
+ * 文件名
135
122
  */
136
- Caller?: Caller
123
+ FileName?: string
137
124
 
138
125
  /**
139
- * 上传文件内容数组,最多支持20个文件
126
+ * 文件大小,单位为Byte
140
127
  */
141
- FileInfos?: Array<UploadFile>
142
-
143
- /**
144
- * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
145
- 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
146
- */
147
- FileType?: string
128
+ FileSize?: number
148
129
 
149
130
  /**
150
- * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
151
- true--是,处理置白
152
- 默认为false--否,不处理
153
- */
154
- CoverRect?: boolean
131
+ * 文件上传时间,10位时间戳(精确到秒)
132
+ */
133
+ CreatedOn?: number
134
+ }
155
135
 
136
+ /**
137
+ * CreateFlowApprovers返回参数结构体
138
+ */
139
+ export interface CreateFlowApproversResponse {
156
140
  /**
157
- * 用户自定义ID数组,与上传文件一一对应
141
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
158
142
  */
159
- CustomIds?: Array<string>
143
+ RequestId?: string
144
+ }
160
145
 
146
+ /**
147
+ * DescribeIntegrationMainOrganizationUser请求参数结构体
148
+ */
149
+ export interface DescribeIntegrationMainOrganizationUserRequest {
161
150
  /**
162
- * 不再使用,上传文件链接数组,最多支持20个URL
151
+ * 操作人信息,userId必填
163
152
  */
164
- FileUrls?: string
153
+ Operator: UserInfo
165
154
  }
166
155
 
167
156
  /**
168
- * 催办接口返回详细信息
157
+ * CreateMultiFlowSignQRCode返回参数结构体
169
158
  */
170
- export interface RemindFlowRecords {
159
+ export interface CreateMultiFlowSignQRCodeResponse {
171
160
  /**
172
- * 是否能够催办
161
+ * 签署二维码对象
173
162
  */
174
- CanRemind: boolean
163
+ QrCode: SignQrCode
175
164
 
176
165
  /**
177
- * 合同id
166
+ * 签署链接对象
178
167
  */
179
- FlowId: string
168
+ SignUrls: SignUrl
180
169
 
181
170
  /**
182
- * 催办详情
171
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
183
172
  */
184
- RemindMessage: string
173
+ RequestId?: string
185
174
  }
186
175
 
187
176
  /**
@@ -436,6 +425,46 @@ export interface CreateFlowRemindsResponse {
436
425
  RequestId?: string
437
426
  }
438
427
 
428
+ /**
429
+ * DescribeOrganizationGroupOrganizations请求参数结构体
430
+ */
431
+ export interface DescribeOrganizationGroupOrganizationsRequest {
432
+ /**
433
+ * 操作人信息,userId必填
434
+ */
435
+ Operator: UserInfo
436
+
437
+ /**
438
+ * 单次查询成员企业最大返回数量
439
+ */
440
+ Limit: number
441
+
442
+ /**
443
+ * 页面偏移量
444
+ */
445
+ Offset: number
446
+
447
+ /**
448
+ * 查询成员企业的企业名,模糊匹配
449
+ */
450
+ Name?: string
451
+
452
+ /**
453
+ * 成员企业加入集团的当前状态:1-待授权;2-已授权待激活;3-拒绝授权;4-已解除;5-已加入
454
+ */
455
+ Status?: number
456
+
457
+ /**
458
+ * 是否到处当前成员企业数据
459
+ */
460
+ Export?: boolean
461
+
462
+ /**
463
+ * 成员企业id
464
+ */
465
+ Id?: string
466
+ }
467
+
439
468
  /**
440
469
  * 应用相关信息
441
470
  */
@@ -882,6 +911,11 @@ export interface DescribeFlowInfoRequest {
882
911
  * 调用方用户信息
883
912
  */
884
913
  Operator?: UserInfo
914
+
915
+ /**
916
+ * 应用信息
917
+ */
918
+ Agent?: Agent
885
919
  }
886
920
 
887
921
  /**
@@ -1750,23 +1784,23 @@ export interface CreateDocumentRequest {
1750
1784
  }
1751
1785
 
1752
1786
  /**
1753
- * CreateMultiFlowSignQRCode返回参数结构体
1787
+ * 催办接口返回详细信息
1754
1788
  */
1755
- export interface CreateMultiFlowSignQRCodeResponse {
1789
+ export interface RemindFlowRecords {
1756
1790
  /**
1757
- * 签署二维码对象
1791
+ * 是否能够催办
1758
1792
  */
1759
- QrCode: SignQrCode
1793
+ CanRemind: boolean
1760
1794
 
1761
1795
  /**
1762
- * 签署链接对象
1796
+ * 合同id
1763
1797
  */
1764
- SignUrls: SignUrl
1798
+ FlowId: string
1765
1799
 
1766
1800
  /**
1767
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1801
+ * 催办详情
1768
1802
  */
1769
- RequestId?: string
1803
+ RemindMessage: string
1770
1804
  }
1771
1805
 
1772
1806
  /**
@@ -1864,6 +1898,83 @@ export interface RegisterInfo {
1864
1898
  Uscc: string
1865
1899
  }
1866
1900
 
1901
+ /**
1902
+ * 成员企业信息
1903
+ */
1904
+ export interface GroupOrganization {
1905
+ /**
1906
+ * 成员企业名
1907
+ 注意:此字段可能返回 null,表示取不到有效值。
1908
+ */
1909
+ Name?: string
1910
+
1911
+ /**
1912
+ * 成员企业别名
1913
+ 注意:此字段可能返回 null,表示取不到有效值。
1914
+ */
1915
+ Alias?: string
1916
+
1917
+ /**
1918
+ * 成员企业id
1919
+ 注意:此字段可能返回 null,表示取不到有效值。
1920
+ */
1921
+ OrganizationId?: string
1922
+
1923
+ /**
1924
+ * 更新时间
1925
+ 注意:此字段可能返回 null,表示取不到有效值。
1926
+ */
1927
+ UpdateTime?: number
1928
+
1929
+ /**
1930
+ * 成员企业状态
1931
+ 注意:此字段可能返回 null,表示取不到有效值。
1932
+ */
1933
+ Status?: number
1934
+
1935
+ /**
1936
+ * 是否为集团主企业
1937
+ 注意:此字段可能返回 null,表示取不到有效值。
1938
+ */
1939
+ IsMainOrganization?: boolean
1940
+
1941
+ /**
1942
+ * 企业社会信用代码
1943
+ 注意:此字段可能返回 null,表示取不到有效值。
1944
+ */
1945
+ IdCardNumber?: string
1946
+
1947
+ /**
1948
+ * 企业超管信息
1949
+ 注意:此字段可能返回 null,表示取不到有效值。
1950
+ */
1951
+ AdminInfo?: Admin
1952
+
1953
+ /**
1954
+ * 企业许可证
1955
+ 注意:此字段可能返回 null,表示取不到有效值。
1956
+ */
1957
+ License?: string
1958
+
1959
+ /**
1960
+ * 企业许可证过期时间
1961
+ 注意:此字段可能返回 null,表示取不到有效值。
1962
+ */
1963
+ LicenseExpireTime?: number
1964
+
1965
+ /**
1966
+ * 成员企业加入集团时间
1967
+ 注意:此字段可能返回 null,表示取不到有效值。
1968
+ */
1969
+ JoinTime?: number
1970
+
1971
+ /**
1972
+ * 是否可以使用审批流引擎
1973
+ 注意:此字段可能返回 null,表示取不到有效值。
1974
+ */
1975
+ FlowEngineEnable?: boolean
1976
+ }
1977
+
1867
1978
  /**
1868
1979
  * CreateFlowSignUrl请求参数结构体
1869
1980
  */
@@ -2238,28 +2349,19 @@ export interface CreateStaffResult {
2238
2349
  }
2239
2350
 
2240
2351
  /**
2241
- * 二期接口返回的模板中文件的信息结构
2352
+ * DescribeIntegrationMainOrganizationUser返回参数结构体
2242
2353
  */
2243
- export interface FileInfo {
2244
- /**
2245
- * 文件Id
2246
- */
2247
- FileId?: string
2248
-
2249
- /**
2250
- * 文件名
2251
- */
2252
- FileName?: string
2253
-
2354
+ export interface DescribeIntegrationMainOrganizationUserResponse {
2254
2355
  /**
2255
- * 文件大小,单位为Byte
2256
- */
2257
- FileSize?: number
2356
+ * 主企业员工账号信息
2357
+ 注意:此字段可能返回 null,表示取不到有效值。
2358
+ */
2359
+ IntegrationMainOrganizationUser?: IntegrationMainOrganizationUser
2258
2360
 
2259
2361
  /**
2260
- * 文件上传时间,10位时间戳(精确到秒)
2362
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2261
2363
  */
2262
- CreatedOn?: number
2364
+ RequestId?: string
2263
2365
  }
2264
2366
 
2265
2367
  /**
@@ -2379,6 +2481,29 @@ export interface CancelMultiFlowSignQRCodeRequest {
2379
2481
  Agent?: Agent
2380
2482
  }
2381
2483
 
2484
+ /**
2485
+ * 主企业员工账号信息
2486
+ */
2487
+ export interface IntegrationMainOrganizationUser {
2488
+ /**
2489
+ * 主企业id
2490
+ 注意:此字段可能返回 null,表示取不到有效值。
2491
+ */
2492
+ MainOrganizationId?: string
2493
+
2494
+ /**
2495
+ * 主企业员工UserId
2496
+ 注意:此字段可能返回 null,表示取不到有效值。
2497
+ */
2498
+ MainUserId?: string
2499
+
2500
+ /**
2501
+ * 主企业员工名
2502
+ 注意:此字段可能返回 null,表示取不到有效值。
2503
+ */
2504
+ UserName?: string
2505
+ }
2506
+
2382
2507
  /**
2383
2508
  * StartFlow请求参数结构体
2384
2509
  */
@@ -2796,7 +2921,7 @@ export interface CreateFlowRemindsRequest {
2796
2921
  Operator: UserInfo
2797
2922
 
2798
2923
  /**
2799
- * 需要执行撤回的签署流程id数组,最多100个
2924
+ * 需要执行催办的签署流程id数组,最多100个
2800
2925
  */
2801
2926
  FlowIds: Array<string>
2802
2927
  }
@@ -2899,6 +3024,23 @@ export interface DescribeFlowBriefsResponse {
2899
3024
  RequestId?: string
2900
3025
  }
2901
3026
 
3027
+ /**
3028
+ * 企业超管信息
3029
+ */
3030
+ export interface Admin {
3031
+ /**
3032
+ * 超管名
3033
+ 注意:此字段可能返回 null,表示取不到有效值。
3034
+ */
3035
+ Name?: string
3036
+
3037
+ /**
3038
+ * 超管手机号
3039
+ 注意:此字段可能返回 null,表示取不到有效值。
3040
+ */
3041
+ Mobile?: string
3042
+ }
3043
+
2902
3044
  /**
2903
3045
  * 持有的电子印章信息
2904
3046
  */
@@ -2981,6 +3123,52 @@ export interface DescribeFlowTemplatesResponse {
2981
3123
  RequestId?: string
2982
3124
  }
2983
3125
 
3126
+ /**
3127
+ * UploadFiles请求参数结构体
3128
+ */
3129
+ export interface UploadFilesRequest {
3130
+ /**
3131
+ * 文件对应业务类型
3132
+ 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
3133
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
3134
+ 3. SEAL - 印章; 文件类型:.jpg/.jpeg/.png
3135
+ */
3136
+ BusinessType: string
3137
+
3138
+ /**
3139
+ * 调用方信息,其中OperatorId为必填字段,即用户的UserId
3140
+ */
3141
+ Caller?: Caller
3142
+
3143
+ /**
3144
+ * 上传文件内容数组,最多支持20个文件
3145
+ */
3146
+ FileInfos?: Array<UploadFile>
3147
+
3148
+ /**
3149
+ * 文件类型, 默认通过文件内容解析得到文件类型,客户可以显示的说明上传文件的类型。
3150
+ 如:PDF 表示上传的文件 xxx.pdf的文件类型是 PDF
3151
+ */
3152
+ FileType?: string
3153
+
3154
+ /**
3155
+ * 此参数只对 PDF 文件有效。是否将pdf灰色矩阵置白
3156
+ true--是,处理置白
3157
+ 默认为false--否,不处理
3158
+ */
3159
+ CoverRect?: boolean
3160
+
3161
+ /**
3162
+ * 用户自定义ID数组,与上传文件一一对应
3163
+ */
3164
+ CustomIds?: Array<string>
3165
+
3166
+ /**
3167
+ * 不再使用,上传文件链接数组,最多支持20个URL
3168
+ */
3169
+ FileUrls?: string
3170
+ }
3171
+
2984
3172
  /**
2985
3173
  * CreateBatchCancelFlowUrl请求参数结构体
2986
3174
  */
@@ -3061,7 +3249,7 @@ export interface DescribeFlowInfoResponse {
3061
3249
  /**
3062
3250
  * 签署流程信息
3063
3251
  */
3064
- FlowDetailInfos: Array<FlowDetailInfo>
3252
+ FlowDetailInfos?: Array<FlowDetailInfo>
3065
3253
 
3066
3254
  /**
3067
3255
  * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -3149,6 +3337,46 @@ export interface FlowBrief {
3149
3337
  FlowMessage: string
3150
3338
  }
3151
3339
 
3340
+ /**
3341
+ * DescribeOrganizationGroupOrganizations返回参数结构体
3342
+ */
3343
+ export interface DescribeOrganizationGroupOrganizationsResponse {
3344
+ /**
3345
+ * 查询到的符合条件的成员企业总数量
3346
+ 注意:此字段可能返回 null,表示取不到有效值。
3347
+ */
3348
+ Total?: number
3349
+
3350
+ /**
3351
+ * 已授权待激活的企业数量
3352
+ 注意:此字段可能返回 null,表示取不到有效值。
3353
+ */
3354
+ JoinedTotal?: number
3355
+
3356
+ /**
3357
+ * 已加入的企业数量
3358
+ 注意:此字段可能返回 null,表示取不到有效值。
3359
+ */
3360
+ ActivedTotal?: number
3361
+
3362
+ /**
3363
+ * 导出文件的url
3364
+ 注意:此字段可能返回 null,表示取不到有效值。
3365
+ */
3366
+ ExportUrl?: string
3367
+
3368
+ /**
3369
+ * 成员企业信息列表
3370
+ 注意:此字段可能返回 null,表示取不到有效值。
3371
+ */
3372
+ List?: Array<GroupOrganization>
3373
+
3374
+ /**
3375
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3376
+ */
3377
+ RequestId?: string
3378
+ }
3379
+
3152
3380
  /**
3153
3381
  * CancelMultiFlowSignQRCode返回参数结构体
3154
3382
  */
@@ -1,11 +1,15 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, UploadFilesRequest, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, CreateFlowRemindsResponse, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, CreateBatchCancelFlowUrlResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, CreateMultiFlowSignQRCodeResponse, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, CreateSchemeUrlResponse, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, StartFlowRequest, CreatePrepareFlowRequest, DeleteIntegrationEmployeesResponse, DescribeOrganizationSealsRequest, CancelFlowRequest, CreateFlowRemindsRequest, DescribeFlowBriefsRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
2
+ import { CancelFlowResponse, DescribeFlowEvidenceReportRequest, CreateSchemeUrlRequest, CreateFlowApproversResponse, DescribeIntegrationMainOrganizationUserRequest, CreateMultiFlowSignQRCodeResponse, DescribeThirdPartyAuthCodeResponse, CreateIntegrationEmployeesRequest, CreateFlowEvidenceReportRequest, StartFlowResponse, CreateConvertTaskApiRequest, CreateFlowRemindsResponse, DescribeOrganizationGroupOrganizationsRequest, DescribeFlowTemplatesRequest, DescribeFlowEvidenceReportResponse, CreateDocumentResponse, DescribeIntegrationEmployeesRequest, CreateFlowRequest, DescribeThirdPartyAuthCodeRequest, DescribeFlowInfoRequest, CreateBatchCancelFlowUrlResponse, DescribeIntegrationEmployeesResponse, CreateConvertTaskApiResponse, CreateFlowSignReviewRequest, CreateFlowByFilesRequest, CreateFlowSignUrlResponse, DescribeFileUrlsRequest, CreateFlowApproversRequest, CreateFlowEvidenceReportResponse, DescribeFileUrlsResponse, CreateDocumentRequest, DescribeOrganizationSealsResponse, DeleteIntegrationEmployeesRequest, GetTaskResultApiRequest, CreateFlowSignUrlRequest, CreateIntegrationEmployeesResponse, CreateFlowByFilesResponse, UploadFilesResponse, VerifyPdfRequest, CreateFlowSignReviewResponse, DescribeIntegrationMainOrganizationUserResponse, CreateSchemeUrlResponse, CreatePrepareFlowResponse, GetTaskResultApiResponse, CancelMultiFlowSignQRCodeRequest, StartFlowRequest, CreatePrepareFlowRequest, DeleteIntegrationEmployeesResponse, DescribeOrganizationSealsRequest, CancelFlowRequest, CreateFlowRemindsRequest, DescribeFlowBriefsRequest, VerifyPdfResponse, DescribeFlowBriefsResponse, DescribeFlowTemplatesResponse, UploadFilesRequest, CreateBatchCancelFlowUrlRequest, CreateMultiFlowSignQRCodeRequest, DescribeFlowInfoResponse, CreateFlowResponse, DescribeOrganizationGroupOrganizationsResponse, CancelMultiFlowSignQRCodeResponse } from "./ess_models";
3
3
  /**
4
4
  * ess client
5
5
  * @class
6
6
  */
7
7
  export declare class Client extends TencentCloudCommon.AbstractClient {
8
8
  constructor(clientConfig: TencentCloudCommon.ClientConfig);
9
+ /**
10
+ * 此API接口用户查询加入集团的成员企业
11
+ */
12
+ DescribeOrganizationGroupOrganizations(req: DescribeOrganizationGroupOrganizationsRequest, cb?: (error: string, rep: DescribeOrganizationGroupOrganizationsResponse) => void): Promise<DescribeOrganizationGroupOrganizationsResponse>;
9
13
  /**
10
14
  * 此接口用于发起流程
11
15
  适用场景:见创建签署流程接口。
@@ -135,6 +139,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
135
139
  该接口需要开白后使用
136
140
  */
137
141
  CreateFlowReminds(req: CreateFlowRemindsRequest, cb?: (error: string, rep: CreateFlowRemindsResponse) => void): Promise<CreateFlowRemindsResponse>;
142
+ /**
143
+ * 通过子企业影子账号查询主企业员工账号
144
+ */
145
+ DescribeIntegrationMainOrganizationUser(req: DescribeIntegrationMainOrganizationUserRequest, cb?: (error: string, rep: DescribeIntegrationMainOrganizationUserResponse) => void): Promise<DescribeIntegrationMainOrganizationUserResponse>;
138
146
  /**
139
147
  * 通过AuthCode查询用户是否实名
140
148
  */
@@ -27,6 +27,12 @@ class Client extends TencentCloudCommon.AbstractClient {
27
27
  constructor(clientConfig) {
28
28
  super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
29
29
  }
30
+ /**
31
+ * 此API接口用户查询加入集团的成员企业
32
+ */
33
+ async DescribeOrganizationGroupOrganizations(req, cb) {
34
+ return this.request("DescribeOrganizationGroupOrganizations", req, cb);
35
+ }
30
36
  /**
31
37
  * 此接口用于发起流程
32
38
  适用场景:见创建签署流程接口。
@@ -204,6 +210,12 @@ class Client extends TencentCloudCommon.AbstractClient {
204
210
  async CreateFlowReminds(req, cb) {
205
211
  return this.request("CreateFlowReminds", req, cb);
206
212
  }
213
+ /**
214
+ * 通过子企业影子账号查询主企业员工账号
215
+ */
216
+ async DescribeIntegrationMainOrganizationUser(req, cb) {
217
+ return this.request("DescribeIntegrationMainOrganizationUser", req, cb);
218
+ }
207
219
  /**
208
220
  * 通过AuthCode查询用户是否实名
209
221
  */