tencentcloud-sdk-nodejs-essbasic 4.0.1038 → 4.0.1041

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.
@@ -364,21 +364,18 @@ export interface Component {
364
364
  /**
365
365
  * 填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。
366
366
  注:`签署控件设置此字段无效`
367
- 注意:此字段可能返回 null,表示取不到有效值。
368
367
  */
369
368
  Placeholder?: string;
370
369
  /**
371
370
  * **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
372
371
  <ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
373
372
  <li>true:锁定控件值,在页面编辑控件值</li></ul>
374
- 注意:此字段可能返回 null,表示取不到有效值。
375
373
  */
376
374
  LockComponentValue?: boolean;
377
375
  /**
378
376
  * **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
379
377
  <ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
380
378
  <li> <b>true</b> : 可以移动和删除控件</li></ul>
381
- 注意:此字段可能返回 null,表示取不到有效值。
382
379
  */
383
380
  ForbidMoveAndDelete?: boolean;
384
381
  }
@@ -513,12 +510,10 @@ export interface DescribeExtendedServiceAuthDetailResponse {
513
510
  export interface Department {
514
511
  /**
515
512
  * 部门id
516
- 注意:此字段可能返回 null,表示取不到有效值。
517
513
  */
518
514
  DepartmentId?: string;
519
515
  /**
520
516
  * 部门名称
521
- 注意:此字段可能返回 null,表示取不到有效值。
522
517
  */
523
518
  DepartmentName?: string;
524
519
  }
@@ -803,17 +798,14 @@ export interface IntentionQuestionResult {
803
798
  * 视频base64(其中包含全程问题和回答音频,mp4格式)
804
799
 
805
800
  注:`需进行base64解码获取视频文件`
806
- 注意:此字段可能返回 null,表示取不到有效值。
807
801
  */
808
802
  Video?: string;
809
803
  /**
810
804
  * 和答案匹配结果列表
811
- 注意:此字段可能返回 null,表示取不到有效值。
812
805
  */
813
806
  ResultCode?: Array<string>;
814
807
  /**
815
808
  * 回答问题语音识别结果列表
816
- 注意:此字段可能返回 null,表示取不到有效值。
817
809
  */
818
810
  AsrResult?: Array<string>;
819
811
  }
@@ -823,32 +815,26 @@ export interface IntentionQuestionResult {
823
815
  export interface AuthInfoDetail {
824
816
  /**
825
817
  * 扩展服务类型,和入参一致
826
- 注意:此字段可能返回 null,表示取不到有效值。
827
818
  */
828
819
  Type?: string;
829
820
  /**
830
821
  * 扩展服务名称
831
- 注意:此字段可能返回 null,表示取不到有效值。
832
822
  */
833
823
  Name?: string;
834
824
  /**
835
825
  * 授权员工列表
836
- 注意:此字段可能返回 null,表示取不到有效值。
837
826
  */
838
827
  HasAuthUserList?: Array<HasAuthUser>;
839
828
  /**
840
829
  * 授权企业列表(企业自动签时,该字段有值)
841
- 注意:此字段可能返回 null,表示取不到有效值。
842
830
  */
843
831
  HasAuthOrganizationList?: Array<HasAuthOrganization>;
844
832
  /**
845
833
  * 授权员工列表总数
846
- 注意:此字段可能返回 null,表示取不到有效值。
847
834
  */
848
835
  AuthUserTotal?: number;
849
836
  /**
850
837
  * 授权企业列表总数
851
- 注意:此字段可能返回 null,表示取不到有效值。
852
838
  */
853
839
  AuthOrganizationTotal?: number;
854
840
  }
@@ -907,7 +893,6 @@ export interface HasAuthUser {
907
893
  * 第三方应用平台自定义,对应第三方平台子客企业员工的唯一标识。
908
894
 
909
895
 
910
- 注意:此字段可能返回 null,表示取不到有效值。
911
896
  */
912
897
  OpenId?: string;
913
898
  }
@@ -994,7 +979,6 @@ export interface DetectInfoVideoData {
994
979
  * 活体视频的base64编码,mp4格式
995
980
 
996
981
  注:`需进行base64解码获取活体视频文件`
997
- 注意:此字段可能返回 null,表示取不到有效值。
998
982
  */
999
983
  LiveNessVideo?: string;
1000
984
  }
@@ -1742,7 +1726,6 @@ export interface FlowApproverUrlInfo {
1742
1726
  1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1743
1727
  2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1744
1728
  3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
1745
- 注意:此字段可能返回 null,表示取不到有效值。
1746
1729
  */
1747
1730
  LongUrl?: string;
1748
1731
  }
@@ -2073,57 +2056,46 @@ export interface UploadFilesResponse {
2073
2056
  export interface Permission {
2074
2057
  /**
2075
2058
  * 权限名称
2076
- 注意:此字段可能返回 null,表示取不到有效值。
2077
2059
  */
2078
2060
  Name?: string;
2079
2061
  /**
2080
2062
  * 权限key
2081
- 注意:此字段可能返回 null,表示取不到有效值。
2082
2063
  */
2083
2064
  Key?: string;
2084
2065
  /**
2085
2066
  * 权限类型 1前端,2后端
2086
- 注意:此字段可能返回 null,表示取不到有效值。
2087
2067
  */
2088
2068
  Type?: number;
2089
2069
  /**
2090
2070
  * 是否隐藏
2091
- 注意:此字段可能返回 null,表示取不到有效值。
2092
2071
  */
2093
2072
  Hide?: number;
2094
2073
  /**
2095
2074
  * 数据权限标签 1:表示根节点,2:表示叶子结点
2096
- 注意:此字段可能返回 null,表示取不到有效值。
2097
2075
  */
2098
2076
  DataLabel?: number;
2099
2077
  /**
2100
2078
  * 数据权限独有,1:关联其他模块鉴权,2:表示关联自己模块鉴权
2101
- 注意:此字段可能返回 null,表示取不到有效值。
2102
2079
  */
2103
2080
  DataType?: number;
2104
2081
  /**
2105
2082
  * 数据权限独有,表示数据范围,1:全公司,2:部门及下级部门,3:自己
2106
- 注意:此字段可能返回 null,表示取不到有效值。
2107
2083
  */
2108
2084
  DataRange?: number;
2109
2085
  /**
2110
2086
  * 关联权限, 表示这个功能权限要受哪个数据权限管控
2111
- 注意:此字段可能返回 null,表示取不到有效值。
2112
2087
  */
2113
2088
  DataTo?: string;
2114
2089
  /**
2115
2090
  * 父级权限key
2116
- 注意:此字段可能返回 null,表示取不到有效值。
2117
2091
  */
2118
2092
  ParentKey?: string;
2119
2093
  /**
2120
2094
  * 是否选中
2121
- 注意:此字段可能返回 null,表示取不到有效值。
2122
2095
  */
2123
2096
  IsChecked?: boolean;
2124
2097
  /**
2125
2098
  * 子权限集合
2126
- 注意:此字段可能返回 null,表示取不到有效值。
2127
2099
  */
2128
2100
  Children?: Array<Permission>;
2129
2101
  }
@@ -2184,7 +2156,6 @@ export interface FlowApproverDetail {
2184
2156
  ReceiptId?: string;
2185
2157
  /**
2186
2158
  * 第三方平台子客企业的唯一标识,定义Agent中的ProxyOrganizationOpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>
2187
- 注意:此字段可能返回 null,表示取不到有效值。
2188
2159
  */
2189
2160
  ProxyOrganizationOpenId?: string;
2190
2161
  /**
@@ -2206,7 +2177,6 @@ export interface FlowApproverDetail {
2206
2177
  /**
2207
2178
  * 签署方经办人的姓名。
2208
2179
  经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2209
- 注意:此字段可能返回 null,表示取不到有效值。
2210
2180
  */
2211
2181
  ApproveName?: string;
2212
2182
  /**
@@ -2223,12 +2193,10 @@ export interface FlowApproverDetail {
2223
2193
  <li> **FORWARD** :已经转他人处理</li>
2224
2194
  <li> **STOP** :流程已终止</li>
2225
2195
  <li> **RELIEVED** :解除协议(已解除)</li></ul>
2226
- 注意:此字段可能返回 null,表示取不到有效值。
2227
2196
  */
2228
2197
  ApproveStatus?: string;
2229
2198
  /**
2230
2199
  * 签署人拒签等情况的时候填写的原因
2231
- 注意:此字段可能返回 null,表示取不到有效值。
2232
2200
  */
2233
2201
  ApproveMessage?: string;
2234
2202
  /**
@@ -2239,17 +2207,14 @@ export interface FlowApproverDetail {
2239
2207
  * 参与者类型
2240
2208
  <ul><li> **ORGANIZATION** :企业签署人</li>
2241
2209
  <li> **PERSON** :个人签署人</li></ul>
2242
- 注意:此字段可能返回 null,表示取不到有效值。
2243
2210
  */
2244
2211
  ApproveType?: string;
2245
2212
  /**
2246
2213
  * 自定义签署人的角色名, 如: 收款人、开具人、见证人等
2247
- 注意:此字段可能返回 null,表示取不到有效值。
2248
2214
  */
2249
2215
  ApproverRoleName?: string;
2250
2216
  /**
2251
2217
  * 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点。
2252
- 注意:此字段可能返回 null,表示取不到有效值。
2253
2218
  */
2254
2219
  SignId?: string;
2255
2220
  /**
@@ -2387,19 +2352,16 @@ export interface ApproverItem {
2387
2352
  * 签署方唯一编号
2388
2353
 
2389
2354
  在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
2390
- 注意:此字段可能返回 null,表示取不到有效值。
2391
2355
  */
2392
2356
  SignId?: string;
2393
2357
  /**
2394
2358
  * 签署方角色编号
2395
2359
 
2396
2360
  在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
2397
- 注意:此字段可能返回 null,表示取不到有效值。
2398
2361
  */
2399
2362
  RecipientId?: string;
2400
2363
  /**
2401
2364
  * 签署方角色名称
2402
- 注意:此字段可能返回 null,表示取不到有效值。
2403
2365
  */
2404
2366
  ApproverRoleName?: string;
2405
2367
  }
@@ -2453,12 +2415,10 @@ export interface RecipientComponentInfo {
2453
2415
 
2454
2416
  <ul><li> **true** : 是发起方角色</li>
2455
2417
  <li> **false** : 不是发起方角色</li></ul>
2456
- 注意:此字段可能返回 null,表示取不到有效值。
2457
2418
  */
2458
2419
  IsPromoter?: boolean;
2459
2420
  /**
2460
2421
  * 此角色的填写控件列表
2461
- 注意:此字段可能返回 null,表示取不到有效值。
2462
2422
  */
2463
2423
  Components?: Array<FilledComponent>;
2464
2424
  }
@@ -2684,14 +2644,12 @@ export interface TemplateInfo {
2684
2644
  您可以通过浏览器直接打开此链接预览模板,或将其嵌入到 iframe 中进行预览。
2685
2645
 
2686
2646
  注意:只有在请求接口时将 <b>WithPreviewUrl </b>参数设置为 true,才会生成预览链接。
2687
- 注意:此字段可能返回 null,表示取不到有效值。
2688
2647
  */
2689
2648
  PreviewUrl?: string;
2690
2649
  /**
2691
2650
  * 第三方应用集成-模板PDF文件链接,有效期5分钟。
2692
2651
  请求参数WithPdfUrl=true时返回
2693
2652
  (此功能开放需要联系客户经理)。
2694
- 注意:此字段可能返回 null,表示取不到有效值。
2695
2653
  */
2696
2654
  PdfUrl?: string;
2697
2655
  /**
@@ -2700,19 +2658,16 @@ export interface TemplateInfo {
2700
2658
  ChannelTemplateId?: string;
2701
2659
  /**
2702
2660
  * 本模板关联的三方应用平台平台企业模板名称
2703
- 注意:此字段可能返回 null,表示取不到有效值。
2704
2661
  */
2705
2662
  ChannelTemplateName?: string;
2706
2663
  /**
2707
2664
  * 0-需要子客企业手动领取平台企业的模板(默认);
2708
2665
  1-平台自动设置子客模板
2709
- 注意:此字段可能返回 null,表示取不到有效值。
2710
2666
  */
2711
2667
  ChannelAutoSave?: number;
2712
2668
  /**
2713
2669
  * 模板版本,由全数字字符组成。
2714
2670
  默认为空,模板版本号由日期和序号组成,初始版本为yyyyMMdd001,yyyyMMdd002表示第二个版本,以此类推。
2715
- 注意:此字段可能返回 null,表示取不到有效值。
2716
2671
  */
2717
2672
  TemplateVersion?: string;
2718
2673
  /**
@@ -2720,7 +2675,6 @@ export interface TemplateInfo {
2720
2675
 
2721
2676
  <ul><li>1:启用(默认),表示模板处于启用状态,可以被用户正常使用。</li>
2722
2677
  <li>2:停用,表示模板处于停用状态,禁止用户使用该模板。</li></ul>
2723
- 注意:此字段可能返回 null,表示取不到有效值。
2724
2678
  */
2725
2679
  Available?: number;
2726
2680
  }
@@ -2794,12 +2748,10 @@ export interface GetDownloadFlowUrlResponse {
2794
2748
  export interface ChannelRole {
2795
2749
  /**
2796
2750
  * 角色ID,为32位字符串
2797
- 注意:此字段可能返回 null,表示取不到有效值。
2798
2751
  */
2799
2752
  RoleId?: string;
2800
2753
  /**
2801
2754
  * 角色的名称
2802
- 注意:此字段可能返回 null,表示取不到有效值。
2803
2755
  */
2804
2756
  RoleName?: string;
2805
2757
  /**
@@ -2810,7 +2762,6 @@ export interface ChannelRole {
2810
2762
  RoleStatus?: number;
2811
2763
  /**
2812
2764
  * 此角色对应的权限列表
2813
- 注意:此字段可能返回 null,表示取不到有效值。
2814
2765
  */
2815
2766
  PermissionGroups?: Array<PermissionGroup>;
2816
2767
  }
@@ -2992,12 +2943,10 @@ export interface AutoSignConfig {
2992
2943
  export interface StaffRole {
2993
2944
  /**
2994
2945
  * 角色id
2995
- 注意:此字段可能返回 null,表示取不到有效值。
2996
2946
  */
2997
2947
  RoleId?: string;
2998
2948
  /**
2999
2949
  * 角色名称
3000
- 注意:此字段可能返回 null,表示取不到有效值。
3001
2950
  */
3002
2951
  RoleName?: string;
3003
2952
  }
@@ -3268,22 +3217,18 @@ export interface Staff {
3268
3217
  Mobile?: string;
3269
3218
  /**
3270
3219
  * 员工邮箱
3271
- 注意:此字段可能返回 null,表示取不到有效值。
3272
3220
  */
3273
3221
  Email?: string;
3274
3222
  /**
3275
3223
  * 员工在第三方应用平台的用户ID
3276
- 注意:此字段可能返回 null,表示取不到有效值。
3277
3224
  */
3278
3225
  OpenId?: string;
3279
3226
  /**
3280
3227
  * 员工角色
3281
- 注意:此字段可能返回 null,表示取不到有效值。
3282
3228
  */
3283
3229
  Roles?: Array<StaffRole>;
3284
3230
  /**
3285
3231
  * 员工部门
3286
- 注意:此字段可能返回 null,表示取不到有效值。
3287
3232
  */
3288
3233
  Department?: Department;
3289
3234
  /**
@@ -3380,73 +3325,60 @@ export interface OrganizationCommonInfo {
3380
3325
  * 组织机构名称。
3381
3326
  请确认该名称与企业营业执照中注册的名称一致。
3382
3327
  如果名称中包含英文括号(),请使用中文括号()代替。
3383
- 注意:此字段可能返回 null,表示取不到有效值。
3384
3328
  */
3385
3329
  OrganizationName: string;
3386
3330
  /**
3387
3331
  * 组织机构企业统一社会信用代码。
3388
3332
  请确认该企业统一社会信用代码与企业营业执照中注册的统一社会信用代码一致。
3389
- 注意:此字段可能返回 null,表示取不到有效值。
3390
3333
  */
3391
3334
  UniformSocialCreditCode: string;
3392
3335
  /**
3393
3336
  * 组织机构法人的姓名。
3394
3337
  请确认该企业统一社会信用代码与企业营业执照中注册的法人姓名一致。
3395
- 注意:此字段可能返回 null,表示取不到有效值。
3396
3338
  */
3397
3339
  LegalName: string;
3398
3340
  /**
3399
3341
  * 组织机构法人的证件类型
3400
- 注意:此字段可能返回 null,表示取不到有效值。
3401
3342
  */
3402
3343
  LegalIdCardType?: string;
3403
3344
  /**
3404
3345
  * 组织机构法人的证件号码
3405
- 注意:此字段可能返回 null,表示取不到有效值。
3406
3346
  */
3407
3347
  LegalIdCardNumber?: string;
3408
3348
  /**
3409
3349
  * 组织机构超管姓名。
3410
3350
 
3411
- 注意:此字段可能返回 null,表示取不到有效值。
3412
3351
  */
3413
3352
  AdminName?: string;
3414
3353
  /**
3415
3354
  * 组织机构超管手机号。
3416
3355
 
3417
- 注意:此字段可能返回 null,表示取不到有效值。
3418
3356
  */
3419
3357
  AdminMobile?: string;
3420
3358
  /**
3421
3359
  * 组织机构超管证件类型
3422
3360
 
3423
- 注意:此字段可能返回 null,表示取不到有效值。
3424
3361
  */
3425
3362
  AdminIdCardType?: string;
3426
3363
  /**
3427
3364
  * 组织机构超管证件号码
3428
3365
 
3429
- 注意:此字段可能返回 null,表示取不到有效值。
3430
3366
  */
3431
3367
  AdminIdCardNumber?: string;
3432
3368
  /**
3433
3369
  * 原超管姓名
3434
- 注意:此字段可能返回 null,表示取不到有效值。
3435
3370
  */
3436
3371
  OldAdminName?: string;
3437
3372
  /**
3438
3373
  * 原超管手机号
3439
- 注意:此字段可能返回 null,表示取不到有效值。
3440
3374
  */
3441
3375
  OldAdminMobile?: string;
3442
3376
  /**
3443
3377
  * 原超管证件类型
3444
- 注意:此字段可能返回 null,表示取不到有效值。
3445
3378
  */
3446
3379
  OldAdminIdCardType?: string;
3447
3380
  /**
3448
3381
  * 原超管证件号码
3449
- 注意:此字段可能返回 null,表示取不到有效值。
3450
3382
  */
3451
3383
  OldAdminIdCardNumber?: string;
3452
3384
  }
@@ -3669,22 +3601,18 @@ export interface SignUrlInfo {
3669
3601
  * 签署链接,过期时间为90天
3670
3602
 
3671
3603
  注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
3672
- 注意:此字段可能返回 null,表示取不到有效值。
3673
3604
  */
3674
3605
  SignUrl?: string;
3675
3606
  /**
3676
3607
  * 合同过期时间戳,单位秒
3677
- 注意:此字段可能返回 null,表示取不到有效值。
3678
3608
  */
3679
3609
  Deadline?: number;
3680
3610
  /**
3681
3611
  * 当流程为顺序签署此参数有效时,数字越小优先级越高,暂不支持并行签署 可选
3682
- 注意:此字段可能返回 null,表示取不到有效值。
3683
3612
  */
3684
3613
  SignOrder?: number;
3685
3614
  /**
3686
3615
  * 签署人编号
3687
- 注意:此字段可能返回 null,表示取不到有效值。
3688
3616
  */
3689
3617
  SignId?: string;
3690
3618
  /**
@@ -3695,49 +3623,40 @@ export interface SignUrlInfo {
3695
3623
  CustomUserId?: string;
3696
3624
  /**
3697
3625
  * 用户姓名
3698
- 注意:此字段可能返回 null,表示取不到有效值。
3699
3626
  */
3700
3627
  Name?: string;
3701
3628
  /**
3702
3629
  * 用户手机号码
3703
- 注意:此字段可能返回 null,表示取不到有效值。
3704
3630
  */
3705
3631
  Mobile?: string;
3706
3632
  /**
3707
3633
  * 签署参与者机构名字
3708
- 注意:此字段可能返回 null,表示取不到有效值。
3709
3634
  */
3710
3635
  OrganizationName?: string;
3711
3636
  /**
3712
3637
  * 参与者类型, 类型如下:
3713
- **ORGANIZATION**:企业经办人
3714
- **PERSON**: 自然人
3715
- 注意:此字段可能返回 null,表示取不到有效值。
3638
+ **ORGANIZATION**:企业经办人
3639
+ **PERSON**: 自然人
3716
3640
  */
3717
3641
  ApproverType?: string;
3718
3642
  /**
3719
3643
  * 经办人身份证号
3720
- 注意:此字段可能返回 null,表示取不到有效值。
3721
3644
  */
3722
3645
  IdCardNumber?: string;
3723
3646
  /**
3724
3647
  * 签署链接对应流程Id
3725
- 注意:此字段可能返回 null,表示取不到有效值。
3726
3648
  */
3727
3649
  FlowId?: string;
3728
3650
  /**
3729
3651
  * 企业经办人 用户在渠道的编号
3730
- 注意:此字段可能返回 null,表示取不到有效值。
3731
3652
  */
3732
3653
  OpenId?: string;
3733
3654
  /**
3734
3655
  * 合同组签署链接对应的合同组id
3735
- 注意:此字段可能返回 null,表示取不到有效值。
3736
3656
  */
3737
3657
  FlowGroupId?: string;
3738
3658
  /**
3739
3659
  * 二维码,在生成动态签署人跳转封面页链接时返回
3740
- 注意:此字段可能返回 null,表示取不到有效值。
3741
3660
  */
3742
3661
  SignQrcodeUrl?: string;
3743
3662
  }
@@ -3968,7 +3887,6 @@ export interface CreatePersonAuthCertificateImageResponse {
3968
3887
  export interface IntentionActionResultDetail {
3969
3888
  /**
3970
3889
  * 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
3971
- 注意:此字段可能返回 null,表示取不到有效值。
3972
3890
  */
3973
3891
  Video?: string;
3974
3892
  }
@@ -4578,12 +4496,10 @@ export interface ModifyFlowDeadlineResponse {
4578
4496
  export interface TaskInfo {
4579
4497
  /**
4580
4498
  * 合成任务Id,可以通过 ChannelGetTaskResultApi 接口获取任务信息
4581
- 注意:此字段可能返回 null,表示取不到有效值。
4582
4499
  */
4583
4500
  TaskId?: string;
4584
4501
  /**
4585
4502
  * 任务状态:READY - 任务已完成;NOTREADY - 任务未完成;
4586
- 注意:此字段可能返回 null,表示取不到有效值。
4587
4503
  */
4588
4504
  TaskStatus?: string;
4589
4505
  }
@@ -4652,27 +4568,22 @@ export interface ApproverComponentLimitType {
4652
4568
  export interface HasAuthOrganization {
4653
4569
  /**
4654
4570
  * 授权企业openid,
4655
- 注意:此字段可能返回 null,表示取不到有效值。
4656
4571
  */
4657
4572
  OrganizationOpenId?: string;
4658
4573
  /**
4659
4574
  * 授权企业名称
4660
- 注意:此字段可能返回 null,表示取不到有效值。
4661
4575
  */
4662
4576
  OrganizationName?: string;
4663
4577
  /**
4664
4578
  * 被授权企业openid,
4665
- 注意:此字段可能返回 null,表示取不到有效值。
4666
4579
  */
4667
4580
  AuthorizedOrganizationOpenId?: string;
4668
4581
  /**
4669
4582
  * 被授权企业名称
4670
- 注意:此字段可能返回 null,表示取不到有效值。
4671
4583
  */
4672
4584
  AuthorizedOrganizationName?: string;
4673
4585
  /**
4674
4586
  * 授权时间,格式为时间戳,单位s
4675
- 注意:此字段可能返回 null,表示取不到有效值。
4676
4587
  */
4677
4588
  AuthorizeTime?: number;
4678
4589
  }
@@ -4682,17 +4593,14 @@ export interface HasAuthOrganization {
4682
4593
  export interface ResourceUrlInfo {
4683
4594
  /**
4684
4595
  * 资源链接地址,过期时间5分钟
4685
- 注意:此字段可能返回 null,表示取不到有效值。
4686
4596
  */
4687
4597
  Url?: string;
4688
4598
  /**
4689
4599
  * 资源名称
4690
- 注意:此字段可能返回 null,表示取不到有效值。
4691
4600
  */
4692
4601
  Name?: string;
4693
4602
  /**
4694
4603
  * 资源类型
4695
- 注意:此字段可能返回 null,表示取不到有效值。
4696
4604
  */
4697
4605
  Type?: string;
4698
4606
  }
@@ -5776,20 +5684,36 @@ export interface ChannelCreatePreparedPersonalEsignRequest {
5776
5684
  export interface FillError {
5777
5685
  /**
5778
5686
  * 为签署方经办人在签署合同中的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。与入参中补充的签署人角色ID对应,批量补充部分失败返回对应的错误信息。
5779
- 注意:此字段可能返回 null,表示取不到有效值。
5780
5687
  */
5781
5688
  RecipientId?: string;
5782
5689
  /**
5783
5690
  * 补充失败错误说明
5784
- 注意:此字段可能返回 null,表示取不到有效值。
5785
5691
  */
5786
5692
  ErrMessage?: string;
5787
5693
  /**
5788
5694
  * 合同流程ID,为32位字符串。
5789
- 注意:此字段可能返回 null,表示取不到有效值。
5790
5695
  */
5791
5696
  FlowId?: string;
5792
5697
  }
5698
+ /**
5699
+ * CreateEmployeeChangeUrl返回参数结构体
5700
+ */
5701
+ export interface CreateEmployeeChangeUrlResponse {
5702
+ /**
5703
+ * 修改员工信息的小程序链接<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a>
5704
+ */
5705
+ MiniAppPath?: string;
5706
+ /**
5707
+ * 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
5708
+
5709
+
5710
+ */
5711
+ ExpireTime?: number;
5712
+ /**
5713
+ * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
5714
+ */
5715
+ RequestId?: string;
5716
+ }
5793
5717
  /**
5794
5718
  * ChannelRenewAutoSignLicense请求参数结构体
5795
5719
  */
@@ -5836,7 +5760,6 @@ export interface ChannelDescribeBillUsageDetailResponse {
5836
5760
  export interface IntentionActionResult {
5837
5761
  /**
5838
5762
  * 意愿核身结果详细数据,与每段点头确认过程一一对应
5839
- 注意:此字段可能返回 null,表示取不到有效值。
5840
5763
  */
5841
5764
  Details?: Array<IntentionActionResultDetail>;
5842
5765
  }
@@ -5977,7 +5900,6 @@ export interface SyncFailReason {
5977
5900
  Id?: string;
5978
5901
  /**
5979
5902
  * 新增员工或者员工离职失败原因, 可能存证ID不符合规范、证件号码不合法等原因
5980
- 注意:此字段可能返回 null,表示取不到有效值。
5981
5903
  */
5982
5904
  Message?: string;
5983
5905
  }
@@ -6281,19 +6203,16 @@ export interface FormField {
6281
6203
  CreateFlowsByTemplates 接口不使用此字段。
6282
6204
 
6283
6205
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件ID的获取方式</a>
6284
- 注意:此字段可能返回 null,表示取不到有效值。
6285
6206
  */
6286
6207
  ComponentId?: string;
6287
6208
  /**
6288
6209
  * 控件的名字,跟ComponentId二选一,不能全为空
6289
6210
 
6290
6211
  <a href="https://dyn.ess.tencent.cn/guide/apivideo/channel_component_name.mp4" target="_blank">点击此处查看模板上控件名字的获取方式</a>
6291
- 注意:此字段可能返回 null,表示取不到有效值。
6292
6212
  */
6293
6213
  ComponentName?: string;
6294
6214
  /**
6295
6215
  * 是否锁定模板控件值,锁定后无法修改(用于嵌入式发起合同),true-锁定,false-不锁定
6296
- 注意:此字段可能返回 null,表示取不到有效值。
6297
6216
  */
6298
6217
  LockComponentValue?: boolean;
6299
6218
  }
@@ -6303,15 +6222,38 @@ export interface FormField {
6303
6222
  export interface FailedCreateRoleData {
6304
6223
  /**
6305
6224
  * 用户userId
6306
- 注意:此字段可能返回 null,表示取不到有效值。
6307
6225
  */
6308
6226
  UserId?: string;
6309
6227
  /**
6310
6228
  * 角色RoleId列表
6311
- 注意:此字段可能返回 null,表示取不到有效值。
6312
6229
  */
6313
6230
  RoleIds?: Array<string>;
6314
6231
  }
6232
+ /**
6233
+ * CreateEmployeeChangeUrl请求参数结构体
6234
+ */
6235
+ export interface CreateEmployeeChangeUrlRequest {
6236
+ /**
6237
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6238
+
6239
+ 此接口下面信息必填。
6240
+ <ul>
6241
+ <li>渠道应用标识: Agent.AppId</li>
6242
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6243
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6244
+ </ul>
6245
+ 第三方平台子客企业和员工必须已经经过实名认证
6246
+ */
6247
+ Agent: Agent;
6248
+ /**
6249
+ * 待修改的员工OpenId
6250
+ */
6251
+ OpenId?: string;
6252
+ /**
6253
+ * 待修改的员工手机号,支持海外格式
6254
+ */
6255
+ NewMobile?: string;
6256
+ }
6315
6257
  /**
6316
6258
  * ChannelDescribeUserAutoSignStatus请求参数结构体
6317
6259
  */
@@ -6341,12 +6283,10 @@ export interface ChannelDescribeUserAutoSignStatusRequest {
6341
6283
  export interface FlowResourceUrlInfo {
6342
6284
  /**
6343
6285
  * 合同流程的ID
6344
- 注意:此字段可能返回 null,表示取不到有效值。
6345
6286
  */
6346
6287
  FlowId?: string;
6347
6288
  /**
6348
6289
  * 对应的合同流程的PDF下载链接
6349
- 注意:此字段可能返回 null,表示取不到有效值。
6350
6290
  */
6351
6291
  ResourceUrlInfos?: Array<ResourceUrlInfo>;
6352
6292
  }
@@ -6393,12 +6333,10 @@ export interface ExtentServiceAuthInfo {
6393
6333
  Status?: string;
6394
6334
  /**
6395
6335
  * 操作扩展服务的操作人第三方应用平台的用户openid
6396
- 注意:此字段可能返回 null,表示取不到有效值。
6397
6336
  */
6398
6337
  OperatorOpenId?: string;
6399
6338
  /**
6400
6339
  * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
6401
- 注意:此字段可能返回 null,表示取不到有效值。
6402
6340
  */
6403
6341
  OperateOn?: number;
6404
6342
  }
@@ -6476,12 +6414,10 @@ export interface FilledComponent {
6476
6414
  export interface FlowApproverItem {
6477
6415
  /**
6478
6416
  * 合同编号
6479
- 注意:此字段可能返回 null,表示取不到有效值。
6480
6417
  */
6481
6418
  FlowId?: string;
6482
6419
  /**
6483
6420
  * 签署方信息,如角色ID、角色名称等
6484
- 注意:此字段可能返回 null,表示取不到有效值。
6485
6421
  */
6486
6422
  Approvers?: Array<ApproverItem>;
6487
6423
  }
@@ -7406,22 +7342,18 @@ export interface ChannelGetTaskResultApiResponse {
7406
7342
  export interface PermissionGroup {
7407
7343
  /**
7408
7344
  * 权限组名称
7409
- 注意:此字段可能返回 null,表示取不到有效值。
7410
7345
  */
7411
7346
  GroupName?: string;
7412
7347
  /**
7413
7348
  * 权限组key
7414
- 注意:此字段可能返回 null,表示取不到有效值。
7415
7349
  */
7416
7350
  GroupKey?: string;
7417
7351
  /**
7418
7352
  * 是否隐藏分组,0否1是
7419
- 注意:此字段可能返回 null,表示取不到有效值。
7420
7353
  */
7421
7354
  Hide?: number;
7422
7355
  /**
7423
7356
  * 权限集合
7424
- 注意:此字段可能返回 null,表示取不到有效值。
7425
7357
  */
7426
7358
  Permissions?: Array<Permission>;
7427
7359
  }
@@ -7735,12 +7667,10 @@ export interface ChannelModifyRoleRequest {
7735
7667
  export interface FlowGroupApprovers {
7736
7668
  /**
7737
7669
  * 合同流程ID
7738
- 注意:此字段可能返回 null,表示取不到有效值。
7739
7670
  */
7740
7671
  FlowId?: string;
7741
7672
  /**
7742
7673
  * 签署方信息,包含合同ID和角色ID用于定位RecipientId。
7743
- 注意:此字段可能返回 null,表示取不到有效值。
7744
7674
  */
7745
7675
  Approvers?: Array<ApproverItem>;
7746
7676
  }
@@ -8221,7 +8151,6 @@ export interface OccupiedSeal {
8221
8151
  SealStatus?: string;
8222
8152
  /**
8223
8153
  * 审核失败原因
8224
- 注意:此字段可能返回 null,表示取不到有效值。
8225
8154
  */
8226
8155
  FailReason?: string;
8227
8156
  /**
@@ -8531,12 +8460,10 @@ export interface UsageDetail {
8531
8460
  ProxyOrganizationOpenId?: string;
8532
8461
  /**
8533
8462
  * 子客企业名
8534
- 注意:此字段可能返回 null,表示取不到有效值。
8535
8463
  */
8536
8464
  ProxyOrganizationName?: string;
8537
8465
  /**
8538
8466
  * 对应的消耗日期, **如果是汇总数据则为1970-01-01**
8539
- 注意:此字段可能返回 null,表示取不到有效值。
8540
8467
  */
8541
8468
  Date?: string;
8542
8469
  /**
@@ -8545,12 +8472,10 @@ export interface UsageDetail {
8545
8472
  Usage?: number;
8546
8473
  /**
8547
8474
  * 撤回合同数量
8548
- 注意:此字段可能返回 null,表示取不到有效值。
8549
8475
  */
8550
8476
  Cancel?: number;
8551
8477
  /**
8552
8478
  * 消耗渠道
8553
- 注意:此字段可能返回 null,表示取不到有效值。
8554
8479
  */
8555
8480
  FlowChannel?: string;
8556
8481
  }