tencentcloud-sdk-nodejs-essbasic 4.0.649 → 4.0.651

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.
@@ -53,6 +53,270 @@ export interface ChannelCreateFlowRemindsResponse {
53
53
  RequestId?: string
54
54
  }
55
55
 
56
+ /**
57
+ * 此结构体 (Component) 用于描述控件属性。
58
+
59
+ 在通过文件发起合同时,对应的component有三种定位方式
60
+ 1. 绝对定位方式
61
+ 2. 表单域(FIELD)定位方式
62
+ 3. 关键字(KEYWORD)定位方式
63
+ 可以参考官网说明
64
+ https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
65
+ */
66
+ export interface Component {
67
+ /**
68
+ * 控件编号
69
+
70
+ CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
71
+
72
+ 注:
73
+ 当GenerateMode=KEYWORD时,通过"^"来决定是否使用关键字整词匹配能力。
74
+ 例:
75
+ 当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
76
+ 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
77
+
78
+ 创建控件时,此值为空
79
+ 查询时返回完整结构
80
+ */
81
+ ComponentId?: string
82
+ /**
83
+ * 如果是Component控件类型,则可选的字段为:
84
+ TEXT - 普通文本控件,输入文本字符串;
85
+ MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
86
+ CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
87
+ FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
88
+ DYNAMIC_TABLE - 动态表格控件;
89
+ ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分割;
90
+ SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
91
+ DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
92
+ DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
93
+
94
+ 如果是SignComponent控件类型,则可选的字段为
95
+ SIGN_SEAL - 签署印章控件;
96
+ SIGN_DATE - 签署日期控件;
97
+ SIGN_SIGNATURE - 用户签名控件;
98
+ SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
99
+ SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
100
+ SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
101
+ SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
102
+
103
+ 表单域的控件不能作为印章和签名控件
104
+ */
105
+ ComponentType?: string
106
+ /**
107
+ * 控件简称,不能超过30个字符
108
+ */
109
+ ComponentName?: string
110
+ /**
111
+ * 定义控件是否为必填项,默认为false
112
+ */
113
+ ComponentRequired?: boolean
114
+ /**
115
+ * 控件关联的签署方id
116
+ */
117
+ ComponentRecipientId?: string
118
+ /**
119
+ * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
120
+ */
121
+ FileIndex?: number
122
+ /**
123
+ * 控件生成的方式:
124
+ NORMAL - 普通控件
125
+ FIELD - 表单域
126
+ KEYWORD - 关键字
127
+ */
128
+ GenerateMode?: string
129
+ /**
130
+ * 参数控件宽度,默认100,单位px
131
+ 表单域和关键字转换控件不用填
132
+ */
133
+ ComponentWidth?: number
134
+ /**
135
+ * 参数控件高度,默认100,单位px
136
+ 表单域和关键字转换控件不用填
137
+ */
138
+ ComponentHeight?: number
139
+ /**
140
+ * 参数控件所在页码,从1开始
141
+ */
142
+ ComponentPage?: number
143
+ /**
144
+ * 参数控件X位置,单位px
145
+ */
146
+ ComponentPosX?: number
147
+ /**
148
+ * 参数控件Y位置,单位px
149
+ */
150
+ ComponentPosY?: number
151
+ /**
152
+ * 扩展参数:
153
+ 为JSON格式。
154
+ 不同类型的控件会有部分非通用参数
155
+
156
+ TEXT/MULTI_LINE_TEXT控件可以指定
157
+ 1 Font:目前只支持黑体、宋体
158
+ 2 FontSize: 范围12-72
159
+ 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
160
+ 例如:{"FontSize":12}
161
+
162
+ ComponentType为FILL_IMAGE时,支持以下参数:
163
+ NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
164
+ FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
165
+
166
+ ComponentType为SIGN_SIGNATURE类型可以控制签署方式
167
+ {“ComponentTypeLimit”: [“xxx”]}
168
+ xxx可以为:
169
+ HANDWRITE – 手写签名
170
+ OCR_ESIGN -- AI智能识别手写签名
171
+ ESIGN -- 个人印章类型
172
+ SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
173
+ 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
174
+
175
+ ComponentType为SIGN_DATE时,支持以下参数:
176
+ 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
177
+ 2 FontSize: 数字类型,范围6-72,默认值为12
178
+ 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
179
+ 4 Format: 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
180
+ 5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
181
+ 如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
182
+ 特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
183
+ 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
184
+
185
+ ComponentType为SIGN_SEAL类型时,支持以下参数:
186
+ 1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
187
+ 参数样例: "ComponentExtra":"{["PageRange":{"BeginPage":1,"EndPage":-1}]}"
188
+ */
189
+ ComponentExtra?: string
190
+ /**
191
+ * 控件填充vaule,ComponentType和传入值类型对应关系:
192
+ TEXT - 文本内容
193
+ MULTI_LINE_TEXT - 文本内容
194
+ CHECK_BOX - true/false
195
+ FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
196
+ SELECTOR - 选项值
197
+ DATE - 默认是格式化为xxxx年xx月xx日
198
+ DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
199
+ SIGN_SEAL - 印章ID
200
+ SIGN_PAGING_SEAL - 可以指定印章ID
201
+
202
+ 控件值约束说明:
203
+ 企业全称控件:
204
+ 约束:企业名称中文字符中文括号
205
+ 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
206
+
207
+ 统一社会信用代码控件:
208
+ 检查正则表达式:/^[A-Z0-9]{1,18}$/
209
+
210
+ 法人名称控件:
211
+ 约束:最大50个字符,2到25个汉字或者1到50个字母
212
+ 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
213
+
214
+ 签署意见控件:
215
+ 约束:签署意见最大长度为50字符
216
+
217
+ 签署人手机号控件:
218
+ 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
219
+
220
+ 签署人身份证控件:
221
+ 约束:合法的身份证号码检查
222
+
223
+ 控件名称:
224
+ 约束:控件名称最大长度为20字符
225
+
226
+ 单行文本控件:
227
+ 约束:只允许输入中文,英文,数字,中英文标点符号
228
+
229
+ 多行文本控件:
230
+ 约束:只允许输入中文,英文,数字,中英文标点符号
231
+
232
+ 勾选框控件:
233
+ 约束:选择填字符串true,不选填字符串false
234
+
235
+ 选择器控件:
236
+ 约束:同单行文本控件约束,填写选择值中的字符串
237
+
238
+ 数字控件:
239
+ 约束:请输入有效的数字(可带小数点)
240
+ 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
241
+
242
+ 日期控件:
243
+ 约束:格式:yyyy年mm月dd日
244
+
245
+ 附件控件:
246
+ 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
247
+
248
+ 图片控件:
249
+ 约束:JPG或PNG图片,填写上传的图片资源ID
250
+
251
+ 邮箱控件:
252
+ 约束:请输入有效的邮箱地址, w3c标准
253
+ 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
254
+ 参考:https://emailregex.com/
255
+
256
+ 地址控件:
257
+ 同单行文本控件约束
258
+
259
+ 省市区控件:
260
+ 同单行文本控件约束
261
+
262
+ 性别控件:
263
+ 同单行文本控件约束,填写选择值中的字符串
264
+
265
+ 学历控件:
266
+ 同单行文本控件约束,填写选择值中的字符串
267
+ */
268
+ ComponentValue?: string
269
+ /**
270
+ * 日期签署控件的字号,默认为 12
271
+
272
+ 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
273
+ */
274
+ ComponentDateFontSize?: number
275
+ /**
276
+ * 控件所属文档的Id, 模块相关接口为空值
277
+ */
278
+ DocumentId?: string
279
+ /**
280
+ * 控件描述,不能超过30个字符
281
+ */
282
+ ComponentDescription?: string
283
+ /**
284
+ * 指定关键字时横坐标偏移量,单位pt
285
+ */
286
+ OffsetX?: number
287
+ /**
288
+ * 指定关键字时纵坐标偏移量,单位pt
289
+ */
290
+ OffsetY?: number
291
+ /**
292
+ * 平台企业控件ID。
293
+ 如果不为空,属于平台企业预设控件;
294
+ */
295
+ ChannelComponentId?: string
296
+ /**
297
+ * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
298
+ 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
299
+ */
300
+ KeywordOrder?: string
301
+ /**
302
+ * 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
303
+ */
304
+ KeywordPage?: number
305
+ /**
306
+ * 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
307
+ */
308
+ RelativeLocation?: string
309
+ /**
310
+ * 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
311
+ */
312
+ KeywordIndexes?: Array<number>
313
+ /**
314
+ * 填写提示的内容
315
+ 注意:此字段可能返回 null,表示取不到有效值。
316
+ */
317
+ Placeholder?: string
318
+ }
319
+
56
320
  /**
57
321
  * ChannelDeleteSealPolicies请求参数结构体
58
322
  */
@@ -314,6 +578,23 @@ export interface CreateSealByImageResponse {
314
578
  RequestId?: string
315
579
  }
316
580
 
581
+ /**
582
+ * 主题配置
583
+ */
584
+ export interface WebThemeConfig {
585
+ /**
586
+ * 页面底部是否显示电子签logo
587
+ <br/>true:允许在页面底部隐藏电子签logo
588
+ <br/>默认false,不允许允许在页面底部隐藏电子签logo
589
+ */
590
+ DisplaySignBrandLogo?: boolean
591
+ /**
592
+ * 嵌入式主题颜色
593
+ <br/>支持十六进制颜色值以及RGB格式颜色值,例如:#D54941,rgb(213, 73, 65)
594
+ */
595
+ WebEmbedThemeColor?: string
596
+ }
597
+
317
598
  /**
318
599
  * OperateChannelTemplate返回参数结构体
319
600
  */
@@ -784,6 +1065,25 @@ export interface FlowApproverUrlInfo {
784
1065
  LongUrl?: string
785
1066
  }
786
1067
 
1068
+ /**
1069
+ * ChannelCreateWebThemeConfig请求参数结构体
1070
+ */
1071
+ export interface ChannelCreateWebThemeConfigRequest {
1072
+ /**
1073
+ * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
1074
+ */
1075
+ Agent: Agent
1076
+ /**
1077
+ * 主题类型<br/>EMBED_WEB_THEME:嵌入式主题
1078
+ <br/>目前只支持EMBED_WEB_THEME,web页面嵌入的主题风格配置
1079
+ */
1080
+ ThemeType: string
1081
+ /**
1082
+ * 主题配置
1083
+ */
1084
+ WebThemeConfig: WebThemeConfig
1085
+ }
1086
+
787
1087
  /**
788
1088
  * ChannelCreateConvertTaskApi请求参数结构体
789
1089
  */
@@ -2479,11 +2779,11 @@ ENTERPRISESERVER-企业静默签(文件发起时的企业静默签字)。
2479
2779
  */
2480
2780
  CallbackUrl?: string
2481
2781
  /**
2482
- * 使用PDF文件直接发起合同时,签署人指定的签署控件
2782
+ * 使用PDF文件直接发起合同时,签署人指定的签署控件;<br/>使用模板发起合同时,指定本企业印章签署控件的印章ID: <br/>通过ComponentId或ComponenetName指定签署控件,ComponentValue为印章ID。
2483
2783
  */
2484
2784
  SignComponents?: Array<Component>
2485
2785
  /**
2486
- * 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
2786
+ * 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
2487
2787
  HANDWRITE – 手写签名
2488
2788
  OCR_ESIGN -- AI智能识别手写签名
2489
2789
  ESIGN -- 个人印章类型
@@ -3138,400 +3438,146 @@ export interface ProxyOrganizationOperator {
3138
3438
  /**
3139
3439
  * 经办人证件号
3140
3440
  */
3141
- IdCardNumber?: string
3142
- /**
3143
- * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
3144
- */
3145
- Mobile?: string
3146
- /**
3147
- * 默认角色,值为以下三个对应的英文:
3148
- 业务管理员:admin
3149
- 经办人:channel-normal-operator
3150
- 业务员:channel-sales-man
3151
- */
3152
- DefaultRole?: string
3153
- }
3154
-
3155
- /**
3156
- * ModifyExtendedService返回参数结构体
3157
- */
3158
- export interface ModifyExtendedServiceResponse {
3159
- /**
3160
- * 操作跳转链接,有效期24小时
3161
- 若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
3162
-
3163
- 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
3164
- 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
3165
- */
3166
- OperateUrl?: string
3167
- /**
3168
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3169
- */
3170
- RequestId?: string
3171
- }
3172
-
3173
- /**
3174
- * ChannelCreateUserRoles请求参数结构体
3175
- */
3176
- export interface ChannelCreateUserRolesRequest {
3177
- /**
3178
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3179
- */
3180
- Agent: Agent
3181
- /**
3182
- * 绑定角色的角色id列表
3183
- */
3184
- RoleIds: Array<string>
3185
- /**
3186
- * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
3187
- */
3188
- UserIds?: Array<string>
3189
- /**
3190
- * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
3191
- */
3192
- OpenIds?: Array<string>
3193
- /**
3194
- * 操作者信息
3195
- * @deprecated
3196
- */
3197
- Operator?: UserInfo
3198
- }
3199
-
3200
- /**
3201
- * ChannelGetTaskResultApi返回参数结构体
3202
- */
3203
- export interface ChannelGetTaskResultApiResponse {
3204
- /**
3205
- * 任务Id
3206
- */
3207
- TaskId?: string
3208
- /**
3209
- * 任务状态,需要关注的状态
3210
- 0 :NeedTranform - 任务已提交
3211
- 4 :Processing - 文档转换中
3212
- 8 :TaskEnd - 任务处理完成
3213
- -2 :DownloadFailed - 下载失败
3214
- -6 :ProcessFailed - 转换失败
3215
- -13:ProcessTimeout - 转换文件超时
3216
- */
3217
- TaskStatus?: number
3218
- /**
3219
- * 状态描述,需要关注的状态
3220
- NeedTranform - 任务已提交
3221
- Processing - 文档转换中
3222
- TaskEnd - 任务处理完成
3223
- DownloadFailed - 下载失败
3224
- ProcessFailed - 转换失败
3225
- ProcessTimeout - 转换文件超时
3226
- */
3227
- TaskMessage?: string
3228
- /**
3229
- * 资源Id,也是FileId,用于文件发起使用
3230
- */
3231
- ResourceId?: string
3232
- /**
3233
- * 预览文件Url,有效期30分钟
3234
- 当前字段返回为空,发起的时候,将ResourceId 放入发起即可
3235
- 注意:此字段可能返回 null,表示取不到有效值。
3236
- * @deprecated
3237
- */
3238
- PreviewUrl?: string
3239
- /**
3240
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3241
- */
3242
- RequestId?: string
3243
- }
3244
-
3245
- /**
3246
- * ChannelCreateOrganizationModifyQrCode返回参数结构体
3247
- */
3248
- export interface ChannelCreateOrganizationModifyQrCodeResponse {
3249
- /**
3250
- * 二维码下载链接
3251
- */
3252
- QrCodeUrl?: string
3253
- /**
3254
- * 二维码失效时间 UNIX 时间戳 精确到秒
3255
- */
3256
- ExpiredTime?: number
3257
- /**
3258
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3259
- */
3260
- RequestId?: string
3261
- }
3262
-
3263
- /**
3264
- * ChannelDeleteSealPolicies返回参数结构体
3265
- */
3266
- export interface ChannelDeleteSealPoliciesResponse {
3267
- /**
3268
- * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3269
- */
3270
- RequestId?: string
3271
- }
3272
-
3273
- /**
3274
- * 此结构体 (Component) 用于描述控件属性。
3275
-
3276
- 在通过文件发起合同时,对应的component有三种定位方式
3277
- 1. 绝对定位方式
3278
- 2. 表单域(FIELD)定位方式
3279
- 3. 关键字(KEYWORD)定位方式
3280
- 可以参考官网说明
3281
- https://cloud.tencent.com/document/product/1323/78346#component-.E4.B8.89.E7.A7.8D.E5.AE.9A.E4.BD.8D.E6.96.B9.E5.BC.8F.E8.AF.B4.E6.98.8E
3282
- */
3283
- export interface Component {
3284
- /**
3285
- * 控件编号
3286
-
3287
- CreateFlowByTemplates发起合同时优先以ComponentId(不为空)填充;否则以ComponentName填充
3288
-
3289
- 注:
3290
- 当GenerateMode=3时,通过"^"来决定是否使用关键字整词匹配能力。
3291
- 例:
3292
- 当GenerateMode=3时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
3293
- 如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
3294
-
3295
- 创建控件时,此值为空
3296
- 查询时返回完整结构
3297
- */
3298
- ComponentId?: string
3299
- /**
3300
- * 如果是Component控件类型,则可选的字段为:
3301
- TEXT - 普通文本控件,输入文本字符串;
3302
- MULTI_LINE_TEXT - 多行文本控件,输入文本字符串;
3303
- CHECK_BOX - 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;
3304
- FILL_IMAGE - 图片控件,ComponentValue 填写图片的资源 ID;
3305
- DYNAMIC_TABLE - 动态表格控件;
3306
- ATTACHMENT - 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分割;
3307
- SELECTOR - 选择器控件,ComponentValue填写选择的字符串内容;
3308
- DATE - 日期控件;默认是格式化为xxxx年xx月xx日字符串;
3309
- DISTRICT - 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;
3310
-
3311
- 如果是SignComponent控件类型,则可选的字段为
3312
- SIGN_SEAL - 签署印章控件;
3313
- SIGN_DATE - 签署日期控件;
3314
- SIGN_SIGNATURE - 用户签名控件;
3315
- SIGN_PERSONAL_SEAL - 个人签署印章控件(使用文件发起暂不支持此类型);
3316
- SIGN_PAGING_SEAL - 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight
3317
- SIGN_OPINION - 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;
3318
- SIGN_LEGAL_PERSON_SEAL - 企业法定代表人控件。
3319
-
3320
- 表单域的控件不能作为印章和签名控件
3321
- */
3322
- ComponentType?: string
3323
- /**
3324
- * 控件简称,不能超过30个字符
3325
- */
3326
- ComponentName?: string
3327
- /**
3328
- * 定义控件是否为必填项,默认为false
3329
- */
3330
- ComponentRequired?: boolean
3331
- /**
3332
- * 控件关联的签署方id
3333
- */
3334
- ComponentRecipientId?: string
3335
- /**
3336
- * 控件所属文件的序号 (文档中文件的排列序号,从0开始)
3337
- */
3338
- FileIndex?: number
3441
+ IdCardNumber?: string
3339
3442
  /**
3340
- * 控件生成的方式:
3341
- NORMAL - 普通控件
3342
- FIELD - 表单域
3343
- KEYWORD - 关键字
3443
+ * 经办人手机号,大陆手机号输入11位,暂不支持海外手机号。
3344
3444
  */
3345
- GenerateMode?: string
3445
+ Mobile?: string
3346
3446
  /**
3347
- * 参数控件宽度,默认100,单位px
3348
- 表单域和关键字转换控件不用填
3447
+ * 默认角色,值为以下三个对应的英文:
3448
+ 业务管理员:admin
3449
+ 经办人:channel-normal-operator
3450
+ 业务员:channel-sales-man
3349
3451
  */
3350
- ComponentWidth?: number
3452
+ DefaultRole?: string
3453
+ }
3454
+
3455
+ /**
3456
+ * ModifyExtendedService返回参数结构体
3457
+ */
3458
+ export interface ModifyExtendedServiceResponse {
3351
3459
  /**
3352
- * 参数控件高度,默认100,单位px
3353
- 表单域和关键字转换控件不用填
3460
+ * 操作跳转链接,有效期24小时
3461
+ 若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
3462
+
3463
+ 当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
3464
+ 返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作。
3354
3465
  */
3355
- ComponentHeight?: number
3466
+ OperateUrl?: string
3356
3467
  /**
3357
- * 参数控件所在页码,从1开始
3468
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3358
3469
  */
3359
- ComponentPage?: number
3470
+ RequestId?: string
3471
+ }
3472
+
3473
+ /**
3474
+ * ChannelCreateUserRoles请求参数结构体
3475
+ */
3476
+ export interface ChannelCreateUserRolesRequest {
3360
3477
  /**
3361
- * 参数控件X位置,单位px
3478
+ * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3362
3479
  */
3363
- ComponentPosX?: number
3480
+ Agent: Agent
3364
3481
  /**
3365
- * 参数控件Y位置,单位px
3482
+ * 绑定角色的角色id列表
3366
3483
  */
3367
- ComponentPosY?: number
3484
+ RoleIds: Array<string>
3368
3485
  /**
3369
- * 扩展参数:
3370
- 为JSON格式。
3371
- 不同类型的控件会有部分非通用参数
3372
-
3373
- TEXT/MULTI_LINE_TEXT控件可以指定
3374
- 1 Font:目前只支持黑体、宋体
3375
- 2 FontSize: 范围12-72
3376
- 3 FontAlign: Left/Right/Center,左对齐/居中/右对齐
3377
- 例如:{"FontSize":12}
3378
-
3379
- ComponentType为FILL_IMAGE时,支持以下参数:
3380
- NotMakeImageCenter:bool。是否设置图片居中。false:居中(默认)。 true: 不居中
3381
- FillMethod: int. 填充方式。0-铺满(默认);1-等比例缩放
3382
-
3383
- ComponentType为SIGN_SIGNATURE类型可以控制签署方式
3384
- {“ComponentTypeLimit”: [“xxx”]}
3385
- xxx可以为:
3386
- HANDWRITE – 手写签名
3387
- OCR_ESIGN -- AI智能识别手写签名
3388
- ESIGN -- 个人印章类型
3389
- SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
3390
- 如:{“ComponentTypeLimit”: [“SYSTEM_ESIGN”]}
3391
-
3392
- ComponentType为SIGN_DATE时,支持以下参数:
3393
- 1 Font:字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"
3394
- 2 FontSize: 数字类型,范围6-72,默认值为12
3395
- 3 FontAlign: 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐
3396
- 4 Format: 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。
3397
- 5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
3398
- 如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
3399
- 特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
3400
- 参数样例: "ComponentExtra": "{"Format":“yyyy m d”,"FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"
3401
-
3402
- ComponentType为SIGN_SEAL类型时,支持以下参数:
3403
- 1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
3404
- 参数样例: "ComponentExtra":"{["PageRange":{"BeginPage":1,"EndPage":-1}]}"
3486
+ * 电子签用户ID列表,与OpenIds参数二选一,优先UserIds参数
3405
3487
  */
3406
- ComponentExtra?: string
3488
+ UserIds?: Array<string>
3407
3489
  /**
3408
- * 控件填充vaule,ComponentType和传入值类型对应关系:
3409
- TEXT - 文本内容
3410
- MULTI_LINE_TEXT - 文本内容
3411
- CHECK_BOX - true/false
3412
- FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
3413
- SELECTOR - 选项值
3414
- DATE - 默认是格式化为xxxx年xx月xx日
3415
- DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
3416
- SIGN_SEAL - 印章ID
3417
- SIGN_PAGING_SEAL - 可以指定印章ID
3418
-
3419
- 控件值约束说明:
3420
- 企业全称控件:
3421
- 约束:企业名称中文字符中文括号
3422
- 检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
3423
-
3424
- 统一社会信用代码控件:
3425
- 检查正则表达式:/^[A-Z0-9]{1,18}$/
3426
-
3427
- 法人名称控件:
3428
- 约束:最大50个字符,2到25个汉字或者1到50个字母
3429
- 检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
3430
-
3431
- 签署意见控件:
3432
- 约束:签署意见最大长度为50字符
3433
-
3434
- 签署人手机号控件:
3435
- 约束:国内手机号 13,14,15,16,17,18,19号段长度11位
3436
-
3437
- 签署人身份证控件:
3438
- 约束:合法的身份证号码检查
3439
-
3440
- 控件名称:
3441
- 约束:控件名称最大长度为20字符
3442
-
3443
- 单行文本控件:
3444
- 约束:只允许输入中文,英文,数字,中英文标点符号
3445
-
3446
- 多行文本控件:
3447
- 约束:只允许输入中文,英文,数字,中英文标点符号
3448
-
3449
- 勾选框控件:
3450
- 约束:选择填字符串true,不选填字符串false
3451
-
3452
- 选择器控件:
3453
- 约束:同单行文本控件约束,填写选择值中的字符串
3454
-
3455
- 数字控件:
3456
- 约束:请输入有效的数字(可带小数点)
3457
- 检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
3458
-
3459
- 日期控件:
3460
- 约束:格式:yyyy年mm月dd日
3461
-
3462
- 附件控件:
3463
- 约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
3464
-
3465
- 图片控件:
3466
- 约束:JPG或PNG图片,填写上传的图片资源ID
3467
-
3468
- 邮箱控件:
3469
- 约束:请输入有效的邮箱地址, w3c标准
3470
- 检查正则表达式:/^([A-Za-z0-9_\-.!#$%&])+@([A-Za-z0-9_\-.])+\.([A-Za-z]{2,4})$/
3471
- 参考:https://emailregex.com/
3472
-
3473
- 地址控件:
3474
- 同单行文本控件约束
3475
-
3476
- 省市区控件:
3477
- 同单行文本控件约束
3478
-
3479
- 性别控件:
3480
- 同单行文本控件约束,填写选择值中的字符串
3481
-
3482
- 学历控件:
3483
- 同单行文本控件约束,填写选择值中的字符串
3490
+ * 客户系统用户ID列表,与UserIds参数二选一,优先UserIds参数
3484
3491
  */
3485
- ComponentValue?: string
3492
+ OpenIds?: Array<string>
3486
3493
  /**
3487
- * 日期签署控件的字号,默认为 12
3494
+ * 操作者信息
3495
+ * @deprecated
3496
+ */
3497
+ Operator?: UserInfo
3498
+ }
3488
3499
 
3489
- 签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
3500
+ /**
3501
+ * ChannelGetTaskResultApi返回参数结构体
3502
+ */
3503
+ export interface ChannelGetTaskResultApiResponse {
3504
+ /**
3505
+ * 任务Id
3490
3506
  */
3491
- ComponentDateFontSize?: number
3507
+ TaskId?: string
3492
3508
  /**
3493
- * 控件所属文档的Id, 模块相关接口为空值
3509
+ * 任务状态,需要关注的状态
3510
+ 0 :NeedTranform - 任务已提交
3511
+ 4 :Processing - 文档转换中
3512
+ 8 :TaskEnd - 任务处理完成
3513
+ -2 :DownloadFailed - 下载失败
3514
+ -6 :ProcessFailed - 转换失败
3515
+ -13:ProcessTimeout - 转换文件超时
3494
3516
  */
3495
- DocumentId?: string
3517
+ TaskStatus?: number
3496
3518
  /**
3497
- * 控件描述,不能超过30个字符
3519
+ * 状态描述,需要关注的状态
3520
+ NeedTranform - 任务已提交
3521
+ Processing - 文档转换中
3522
+ TaskEnd - 任务处理完成
3523
+ DownloadFailed - 下载失败
3524
+ ProcessFailed - 转换失败
3525
+ ProcessTimeout - 转换文件超时
3498
3526
  */
3499
- ComponentDescription?: string
3527
+ TaskMessage?: string
3500
3528
  /**
3501
- * 指定关键字时横坐标偏移量,单位pt
3529
+ * 资源Id,也是FileId,用于文件发起使用
3502
3530
  */
3503
- OffsetX?: number
3531
+ ResourceId?: string
3504
3532
  /**
3505
- * 指定关键字时纵坐标偏移量,单位pt
3533
+ * 预览文件Url,有效期30分钟
3534
+ 当前字段返回为空,发起的时候,将ResourceId 放入发起即可
3535
+ 注意:此字段可能返回 null,表示取不到有效值。
3536
+ * @deprecated
3506
3537
  */
3507
- OffsetY?: number
3538
+ PreviewUrl?: string
3508
3539
  /**
3509
- * 平台企业控件ID。
3510
- 如果不为空,属于平台企业预设控件;
3540
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId
3511
3541
  */
3512
- ChannelComponentId?: string
3542
+ RequestId?: string
3543
+ }
3544
+
3545
+ /**
3546
+ * ChannelCreateOrganizationModifyQrCode返回参数结构体
3547
+ */
3548
+ export interface ChannelCreateOrganizationModifyQrCodeResponse {
3513
3549
  /**
3514
- * 指定关键字排序规则,Positive-正序,Reverse-倒序。传入Positive时会根据关键字在PDF文件内的顺序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的第一个关键字。
3515
- 传入Reverse时会根据关键字在PDF文件内的反序进行排列。在指定KeywordIndexes时,0代表在PDF内查找内容时,查找到的最后一个关键字。
3550
+ * 二维码下载链接
3516
3551
  */
3517
- KeywordOrder?: string
3552
+ QrCodeUrl?: string
3518
3553
  /**
3519
- * 指定关键字页码,可选参数,指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
3554
+ * 二维码失效时间 UNIX 时间戳 精确到秒
3520
3555
  */
3521
- KeywordPage?: number
3556
+ ExpiredTime?: number
3522
3557
  /**
3523
- * 关键字位置模式,Middle-居中,Below-正下方,Right-正右方,LowerRight-右上角,UpperRight-右下角。示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
3558
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3524
3559
  */
3525
- RelativeLocation?: string
3560
+ RequestId?: string
3561
+ }
3562
+
3563
+ /**
3564
+ * ChannelDeleteSealPolicies返回参数结构体
3565
+ */
3566
+ export interface ChannelDeleteSealPoliciesResponse {
3526
3567
  /**
3527
- * 关键字索引,可选参数,如果一个关键字在PDF文件中存在多个,可以通过关键字索引指定使用第几个关键字作为最后的结果,可指定多个索引。示例[0,2],说明使用PDF文件内第1个和第3个关键字位置。
3568
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3528
3569
  */
3529
- KeywordIndexes?: Array<number>
3570
+ RequestId?: string
3571
+ }
3572
+
3573
+ /**
3574
+ * ChannelCreateWebThemeConfig返回参数结构体
3575
+ */
3576
+ export interface ChannelCreateWebThemeConfigResponse {
3530
3577
  /**
3531
- * 填写提示的内容
3532
- 注意:此字段可能返回 null,表示取不到有效值。
3578
+ * 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3533
3579
  */
3534
- Placeholder?: string
3580
+ RequestId?: string
3535
3581
  }
3536
3582
 
3537
3583
  /**