tencentcloud-sdk-nodejs-essbasic 4.0.667 → 4.0.669

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.
@@ -566,11 +566,11 @@ export interface ChannelCreateFlowSignUrlResponse {
566
566
  */
567
567
  export interface ChannelCreatePrepareFlowResponse {
568
568
  /**
569
- * 预发起的合同链接
569
+ * 预发起的合同链接, 可以直接点击进入进行合同发起
570
570
  */
571
571
  PrepareFlowUrl?: string;
572
572
  /**
573
- * 合同发起后预览链接
573
+ * 合同发起后预览链接, 注意此时合同并未发起,仅只是展示效果
574
574
  */
575
575
  PreviewFlowUrl?: string;
576
576
  /**
@@ -850,18 +850,22 @@ export interface CreateConsoleLoginUrlResponse {
850
850
  /**
851
851
  * 子客企业Web控制台url注意事项:
852
852
  1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
853
- 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接5分钟之内有效,且只能访问一次
854
- 3. 若企业认证完成且员工认证完成后,重新获取H5/APP的链接只要在有效期内(一年)都可以访问
855
- 4. 此链接仅单次有效,使用后需要再次创建新的链接(部分聊天软件,如企业微信默认会对链接进行解析,此时需要使用类似“代码片段”的方式或者放到txt文件里发送链接)
853
+ 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接在5分钟之内有效,且只能访问一次
854
+ 3. 若企业认证完成且员工认证完成后,重新获取CHANNEL/APP的链接只要在有效期内(一年)都可以访问
855
+ 4. 此链接仅单次有效,每次登录需要需要重新创建新的链接,尽量不要做链接存储,多次使用。
856
856
  5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
857
857
  */
858
858
  ConsoleUrl?: string;
859
859
  /**
860
860
  * 子客企业是否已开通腾讯电子签,true-是,false-否
861
+ 注意:
862
+ 1、企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码
861
863
  */
862
864
  IsActivated?: boolean;
863
865
  /**
864
- * 当前经办人是否已认证(false:未认证 true:已认证)
866
+ * 当前经办人是否已认证,true-是,false-否
867
+ 注意:
868
+ 1、经办人是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名
865
869
  */
866
870
  ProxyOperatorIsVerified?: boolean;
867
871
  /**
@@ -938,6 +942,14 @@ export interface SyncProxyOrganizationRequest {
938
942
  * @deprecated
939
943
  */
940
944
  Operator?: UserInfo;
945
+ /**
946
+ * 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型
947
+ */
948
+ ProxyLegalIdCardType?: string;
949
+ /**
950
+ * 第三方平台子客企业法人/负责人证件号
951
+ */
952
+ ProxyLegalIdCardNumber?: string;
941
953
  }
942
954
  /**
943
955
  * ChannelCreatePrepareFlow请求参数结构体
@@ -1097,7 +1109,7 @@ export interface ChannelCreateConvertTaskApiRequest {
1097
1109
  */
1098
1110
  ResourceName: string;
1099
1111
  /**
1100
- * 资源Id,通过UploadFiles获取
1112
+ * 文件Id,通过UploadFiles获取
1101
1113
  */
1102
1114
  ResourceId: string;
1103
1115
  /**
@@ -1351,6 +1363,10 @@ export interface ChannelCreateFlowGroupByFilesRequest {
1351
1363
  参数说明:若选择后者,未实名的个人签署方查看合同时,无需进行人脸识别实名认证(但签署合同时仍然需要人脸实名),该能力仅适用于个人签署方。
1352
1364
  */
1353
1365
  ApproverVerifyType?: string;
1366
+ /**
1367
+ * 合同组的配置项信息包括:在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。
1368
+ */
1369
+ FlowGroupOptions?: FlowGroupOptions;
1354
1370
  /**
1355
1371
  * 操作者的信息,此参数不用传
1356
1372
  * @deprecated
@@ -1803,38 +1819,76 @@ export interface CreateConsoleLoginUrlRequest {
1803
1819
  Agent: Agent;
1804
1820
  /**
1805
1821
  * 子客企业名称,最大长度64个字符
1822
+ 注意:
1823
+ 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
1824
+ 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
1806
1825
  */
1807
1826
  ProxyOrganizationName: string;
1827
+ /**
1828
+ * 子客企业统一社会信用代码,最大长度200个字符
1829
+ 注意:
1830
+ 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
1831
+ */
1832
+ UniformSocialCreditCode?: string;
1808
1833
  /**
1809
1834
  * 子客企业经办人的姓名,最大长度50个字符
1835
+ 注意:
1836
+ 1、若经办人已经实名,这里修改经办人名字传入将不会生效。
1837
+ 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
1810
1838
  */
1811
1839
  ProxyOperatorName?: string;
1812
1840
  /**
1813
- * PC控制台指定模块,文件/合同管理:"DOCUMENT",模板管理:"TEMPLATE",印章管理:"SEAL",组织架构/人员:"OPERATOR",空字符串:"账号信息"。 EndPoint为"CHANNEL"/"APP"只支持"SEAL"-印章管理
1841
+ * PC控制台登录后进入该参数指定的模块,如果不传递,将默认进入控制台首页。支持的模块包括:
1842
+ 1、DOCUMENT:合同管理模块,
1843
+ 2、TEMPLATE:企业模板管理模块,
1844
+ 3、SEAL:印章管理模块,
1845
+ 4、OPERATOR:组织管理模块,
1846
+ 默认将进入企业中心模块
1847
+ 注意:
1848
+ 1、如果EndPoint选择"CHANNEL"或"APP",该参数仅支持传递"SEAL",进入印章管理模块
1849
+ 2、该参数仅在企业和员工激活完成,登录控制台场景才生效。
1814
1850
  */
1815
1851
  Module?: string;
1816
1852
  /**
1817
- * 控制台指定模块Id
1853
+ * 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
1854
+ 根据Module参数的不同所代表的含义不同。当前支持:
1855
+ 1、如果Module="SEAL",ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。
1856
+ 2、如果Module="TEMPLATE",ModuleId代表模版Id,登录链接将直接查看指定模版的详情。
1857
+ 3、如果Module="1、DOCUMENT",ModuleId代表合同Id,登录链接将直接查看指定合同的详情。
1858
+ 注意:
1859
+ 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
1860
+ 2、ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到。
1818
1861
  */
1819
1862
  ModuleId?: string;
1820
1863
  /**
1821
- * 子客企业统一社会信用代码,最大长度200个字符
1822
- */
1823
- UniformSocialCreditCode?: string;
1824
- /**
1825
- * 是否展示左侧菜单栏 是:ENABLE(默认) 否:DISABLE
1864
+ * 是否展示左侧菜单栏
1865
+ "ENABLE": 是,展示
1866
+ “DISABLE”: 否,不展示
1867
+ 默认值为ENABLE
1868
+ 注意:
1869
+ 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
1826
1870
  */
1827
1871
  MenuStatus?: string;
1828
1872
  /**
1829
- * 链接跳转类型:"PC"-PC控制台,“CHANNEL”-H5跳转到电子签小程序;“APP”-第三方APP或小程序跳转电子签小程序,默认为PC控制台
1873
+ * 生成链接的类型:
1874
+ "PC":PC控制台链接
1875
+ "CHANNEL":H5跳转到电子签小程序链接
1876
+ "APP":第三方APP或小程序跳转电子签小程序链接
1877
+ 默认将生成PC控制台链接
1830
1878
  */
1831
1879
  Endpoint?: string;
1832
1880
  /**
1833
- * 触发自动跳转事件,仅对App类型有效,"VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
1881
+ * 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
1882
+ "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
1834
1883
  */
1835
1884
  AutoJumpBackEvent?: string;
1836
1885
  /**
1837
- * 支持的授权方式,授权方式: "1" - 上传授权书认证 "2" - 法定代表人认证
1886
+ * 可选的企业授权方式:
1887
+ 1:上传授权书
1888
+ 2:转法定代表人授权
1889
+ 4:企业实名认证(信任第三方认证源)(此项仅支持单选)
1890
+ 未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不生效;选择信任第三方认证源时,请先通过“同步企业信息”接口同步信息。
1891
+ 该参数仅在企业激活场景生效
1838
1892
  */
1839
1893
  AuthorizationTypes?: Array<number>;
1840
1894
  /**
@@ -2144,28 +2198,23 @@ export interface ChannelCancelMultiFlowSignQRCodeRequest {
2144
2198
  Operator?: UserInfo;
2145
2199
  }
2146
2200
  /**
2147
- * UploadFiles请求参数结构体
2201
+ * 合同组的配置项信息包括:在合同组签署过程中,是否需要对每个子合同进行独立的意愿确认。
2148
2202
  */
2149
- export interface UploadFilesRequest {
2203
+ export interface FlowGroupOptions {
2150
2204
  /**
2151
- * 应用相关信息,若是第三方应用集成调用 若是第三方应用集成调用,Agent.AppId 和 Agent.ProxyOrganizationOpenId 必填
2152
- */
2153
- Agent: Agent;
2154
- /**
2155
- * 文件对应业务类型
2156
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
2157
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
2205
+ * 发起方企业经办人(即签署人为发起方企业员工)是否需要对子合同进行独立的意愿确认:
2206
+ fasle:发起方企业经办人签署时对所有子合同进行统一的意愿确认
2207
+ true:发起方企业经办人签署时需要对子合同进行独立的意愿确认
2208
+ 默认为fasle。
2158
2209
  */
2159
- BusinessType: string;
2210
+ SelfOrganizationApproverSignEach?: boolean;
2160
2211
  /**
2161
- * 上传文件内容数组,最多支持20个文件
2212
+ * 非发起方企业经办人(即:签署人为个人或者不为发起方企业的员工)是否需要对子合同进行独立的意愿确认:
2213
+ fasle:非发起方企业经办人签署时对所有子合同进行统一的意愿确认
2214
+ true:非发起方企业经办人签署时需要对子合同进行独立的意愿确认
2215
+ 默认为false。
2162
2216
  */
2163
- FileInfos?: Array<UploadFile>;
2164
- /**
2165
- * 操作者的信息
2166
- * @deprecated
2167
- */
2168
- Operator?: UserInfo;
2217
+ OtherApproverSignEach?: boolean;
2169
2218
  }
2170
2219
  /**
2171
2220
  * ChannelDescribeOrganizationSeals请求参数结构体
@@ -4121,6 +4170,30 @@ export interface CreateFlowsByTemplatesRequest {
4121
4170
  */
4122
4171
  Operator?: UserInfo;
4123
4172
  }
4173
+ /**
4174
+ * UploadFiles请求参数结构体
4175
+ */
4176
+ export interface UploadFilesRequest {
4177
+ /**
4178
+ * 应用相关信息,若是第三方应用集成调用 若是第三方应用集成调用,Agent.AppId 和 Agent.ProxyOrganizationOpenId 必填
4179
+ */
4180
+ Agent: Agent;
4181
+ /**
4182
+ * 文件对应业务类型
4183
+ 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
4184
+ 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
4185
+ */
4186
+ BusinessType: string;
4187
+ /**
4188
+ * 上传文件内容数组,最多支持20个文件
4189
+ */
4190
+ FileInfos?: Array<UploadFile>;
4191
+ /**
4192
+ * 操作者的信息
4193
+ * @deprecated
4194
+ */
4195
+ Operator?: UserInfo;
4196
+ }
4124
4197
  /**
4125
4198
  * DescribeUsage返回参数结构体
4126
4199
  */