tencentcloud-sdk-essbasic 3.0.696 → 3.0.698

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 3ea8e6ad5e15aace85688d1231f715b40a3fc00b
4
- data.tar.gz: e325aef8a281af1e089869641399fb5e0ea9f026
3
+ metadata.gz: 55c17d8204cba3e953037a671d3608bd984e309d
4
+ data.tar.gz: e55e33d5ea959c82891751b48745b0ddcefd332d
5
5
  SHA512:
6
- metadata.gz: 2e293fce82d53d64603943b7fe2050362ba00daea9e8c98d9bf03fdbec3ae1edc961687d5af196bb388ef5c8e233149e96f2b06ce4540608825a9222da2345fd
7
- data.tar.gz: 94435e3ac7f28bb7b617b79f4e2c8294cf3e6899f5926b1e928e80cdf6903e7fc2cdbf6f38e03bce45bd74952f8e29c8e4f77e3afc7b6b248b5c7a03d9e3341d
6
+ metadata.gz: 0b1c1173c373ace836d05d4a8b5cf4036a9d80b5d971e27a8c53253f8b0719385597f9243fc891d7805dcb64503183d1a9ff77c0d13df9963b9c293228e96a25
7
+ data.tar.gz: 9f2cf03e6704094efea399b4254f8043d77aa648ba260bbef3d2c3e935c7f545cc9fcd2e1f35f6918a5fa56eacdf175235d4812c09f1a61bcac4a7ef18eaa863
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.696
1
+ 3.0.698
@@ -177,14 +177,15 @@ module TencentCloud
177
177
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
178
178
  end
179
179
 
180
- # 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
181
- # `注意:`<br/>
182
- # `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
183
- # `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
184
- # `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
185
- # `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
186
- # `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
187
- # 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
180
+ # 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
181
+ # **注意**:
182
+ # 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)
183
+ # 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**,**不支持填写控件**
184
+ # 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
185
+ # 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接
186
+ # 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
187
+ # 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
188
+ # 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
188
189
 
189
190
  # @param request: Request instance for ChannelCreateBatchQuickSignUrl.
190
191
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBatchQuickSignUrlRequest`
@@ -238,7 +239,25 @@ module TencentCloud
238
239
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
239
240
  end
240
241
 
241
- # 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
242
+ # 此接口(ChannelCreateBoundFlows)用于子客企业领取未归属给员工的合同,将合同领取给当前员工,合同不能重复领取。
243
+
244
+
245
+ # **未归属合同发起方式**
246
+ # 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下
247
+ # ```
248
+ # FlowApprovers: []*essbasic.FlowApproverInfo{
249
+ # {
250
+ # ApproverType: common.StringPtr("ORGANIZATION"),
251
+ # OrganizationOpenId: common.StringPtr("org_dianziqian"),
252
+ # OrganizationName: common.StringPtr("典子谦示例企业"),
253
+ # }
254
+ # },
255
+ # ```
256
+
257
+ # 可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
258
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
259
+
260
+ # 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
242
261
 
243
262
  # @param request: Request instance for ChannelCreateBoundFlows.
244
263
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateBoundFlowsRequest`
@@ -600,7 +619,8 @@ module TencentCloud
600
619
  # 1. 合同中当前状态为 **待签署** 的签署人是催办的对象
601
620
  # 2. **每个合同只能催办一次**
602
621
 
603
- # **催办的效果**: 对方会受到如下的短信通知
622
+ # **催办的效果**: 对方会收到如下的短信通知
623
+
604
624
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
605
625
 
606
626
 
@@ -656,14 +676,15 @@ module TencentCloud
656
676
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
657
677
  end
658
678
 
659
- # 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
679
+ # 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
660
680
 
661
- # `注意:`<br/>
662
- # `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
663
- # `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
664
- # `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
665
- # `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
666
- # 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
681
+ # **注意**
682
+ # 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
683
+ # 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件**
684
+ # 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接
685
+ # 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
686
+ # 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
687
+ # 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
667
688
 
668
689
  # @param request: Request instance for ChannelCreateFlowSignUrl.
669
690
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowSignUrlRequest`
@@ -688,21 +709,21 @@ module TencentCloud
688
709
  end
689
710
 
690
711
  # 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
691
- # 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
692
- # 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
693
-
694
- # **本接口适用于发起方没有填写控件的 B2C或者单C模板**
695
712
 
696
- # **若是B2C模板,还要满足以下任意一个条件**
713
+ # **适用场景**:
714
+ # 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
697
715
 
698
- # - 模板中配置的签署顺序是无序
699
- # - B端企业的签署方式是静默签署
700
- # - B端企业是非首位签署
701
-
702
- # 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
716
+ # **注意**:
717
+ # 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
718
+ # - 模板中配置的签署顺序是无序
719
+ # - B端企业的签署方式是静默签署
720
+ # - B端企业是非首位签署
721
+ # 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
703
722
  # ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
723
+ # 3. 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
704
724
 
705
- # 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
725
+ # 二维码的样式如下图:
726
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
706
727
 
707
728
  # @param request: Request instance for ChannelCreateMultiFlowSignQRCode.
708
729
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateMultiFlowSignQRCodeRequest`
@@ -868,7 +889,7 @@ module TencentCloud
868
889
 
869
890
  # 适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
870
891
 
871
- # 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
892
+ # 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
872
893
 
873
894
  # @param request: Request instance for ChannelCreateRole.
874
895
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateRoleRequest`
@@ -1096,6 +1117,30 @@ module TencentCloud
1096
1117
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1097
1118
  end
1098
1119
 
1120
+ # 通过此接口(ChannelDescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1121
+
1122
+ # @param request: Request instance for ChannelDescribeBillUsageDetail.
1123
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeBillUsageDetailRequest`
1124
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeBillUsageDetailResponse`
1125
+ def ChannelDescribeBillUsageDetail(request)
1126
+ body = send_request('ChannelDescribeBillUsageDetail', request.serialize)
1127
+ response = JSON.parse(body)
1128
+ if response['Response'].key?('Error') == false
1129
+ model = ChannelDescribeBillUsageDetailResponse.new
1130
+ model.deserialize(response['Response'])
1131
+ model
1132
+ else
1133
+ code = response['Response']['Error']['Code']
1134
+ message = response['Response']['Error']['Message']
1135
+ reqid = response['Response']['RequestId']
1136
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1137
+ end
1138
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1139
+ raise e
1140
+ rescue StandardError => e
1141
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1142
+ end
1143
+
1099
1144
  # 获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息,支持设置过滤条件以筛选员工查询结果。
1100
1145
 
1101
1146
  # **注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
@@ -1122,7 +1167,21 @@ module TencentCloud
1122
1167
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1123
1168
  end
1124
1169
 
1125
- # 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
1170
+ # 用于获取合同中填写控件填写状态和填写的内容。
1171
+
1172
+ # **注意**: `附件控件不会出现在结果列表中`
1173
+
1174
+
1175
+ # **授权**:
1176
+ # 此接口需要授权, 有两种开通权限的途径
1177
+
1178
+ # **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
1179
+ # 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
1180
+
1181
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
1182
+
1183
+ # **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
1184
+ # ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
1126
1185
 
1127
1186
  # @param request: Request instance for ChannelDescribeFlowComponents.
1128
1187
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeFlowComponentsRequest`
@@ -1285,7 +1344,7 @@ module TencentCloud
1285
1344
 
1286
1345
  # 适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
1287
1346
 
1288
- # 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
1347
+ # 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
1289
1348
 
1290
1349
  # @param request: Request instance for ChannelModifyRole.
1291
1350
  # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelModifyRoleRequest`
@@ -1652,6 +1711,8 @@ module TencentCloud
1652
1711
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1653
1712
  end
1654
1713
 
1714
+ # 废弃接口
1715
+
1655
1716
  # 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1656
1717
 
1657
1718
  # @param request: Request instance for DescribeBillUsageDetail.
@@ -1823,6 +1884,7 @@ module TencentCloud
1823
1884
  # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
1824
1885
 
1825
1886
  # 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
1887
+
1826
1888
  # ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
1827
1889
 
1828
1890
 
@@ -1853,8 +1915,9 @@ module TencentCloud
1853
1915
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1854
1916
  end
1855
1917
 
1856
- # 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
1857
- # 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
1918
+ # 此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
1919
+
1920
+ # 注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
1858
1921
 
1859
1922
  # @param request: Request instance for DescribeUsage.
1860
1923
  # @type request: :class:`Tencentcloud::essbasic::V20210526::DescribeUsageRequest`
@@ -1883,8 +1946,8 @@ module TencentCloud
1883
1946
 
1884
1947
  # 注:
1885
1948
  # <ul>
1886
- # <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
1887
- # <li> **链接仅可使用一次**,不可重复使用</li>
1949
+ # <li>仅支持下载 <b>本企业</b> 下合同,链接会 <b>登录企业控制台</b> </li>
1950
+ # <li> <b>链接仅可使用一次</b>,不可重复使用</li>
1888
1951
  # </ul>
1889
1952
 
1890
1953
  # @param request: Request instance for GetDownloadFlowUrl.
@@ -2105,7 +2168,7 @@ module TencentCloud
2105
2168
 
2106
2169
  # 注:
2107
2170
  # 1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
2108
- # 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
2171
+ # 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
2109
2172
  # ```
2110
2173
  # HttpProfile httpProfile = new HttpProfile();
2111
2174
  # httpProfile.setEndpoint("file.test.ess.tencent.cn");
@@ -582,6 +582,94 @@ module TencentCloud
582
582
  end
583
583
  end
584
584
 
585
+ # 用户计费使用情况详情
586
+ class ChannelBillUsageDetail < TencentCloud::Common::AbstractModel
587
+ # @param FlowId: 合同流程ID,为32位字符串。
588
+ # @type FlowId: String
589
+ # @param OperatorName: 合同经办人名称
590
+ # 如果有多个经办人用分号隔开。
591
+ # @type OperatorName: String
592
+ # @param CreateOrganizationName: 发起方组织机构名称
593
+ # @type CreateOrganizationName: String
594
+ # @param FlowName: 合同流程的名称。
595
+ # @type FlowName: String
596
+ # @param FlowStatus: 合同流程当前的签署状态, 会存在下列的状态值
597
+ # <ul>
598
+ # <li>**INIT**: 合同创建</li>
599
+ # <li>**PART**: 合同签署中(至少有一个签署方已经签署)</li>
600
+ # <li>**REJECT**: 合同拒签</li>
601
+ # <li>**ALL**: 合同签署完成</li>
602
+ # <li>**DEADLINE**: 合同流签(合同过期)</li>
603
+ # <li>**CANCEL**: 合同撤回</li>
604
+ # <li>**RELIEVED**: 解除协议(已解除)</li>
605
+ # <li>**WILLEXPIRE**: 合同即将过期</li>
606
+ # <li>**EXCEPTION**: 合同异常</li>
607
+ # </ul>
608
+ # @type FlowStatus: String
609
+ # @param QuotaType: 查询的套餐类型
610
+ # 对应关系如下:
611
+ # <ul>
612
+ # <li>**CloudEnterprise**: 企业版合同</li>
613
+ # <li>**SingleSignature**: 单方签章</li>
614
+ # <li>**CloudProve**: 签署报告</li>
615
+ # <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
616
+ # <li>**ChannelWeCard**: 微工卡</li>
617
+ # <li>**SignFlow**: 合同套餐</li>
618
+ # <li>**SignFace**: 签署意愿(人脸识别)</li>
619
+ # <li>**SignPassword**: 签署意愿(密码)</li>
620
+ # <li>**SignSMS**: 签署意愿(短信)</li>
621
+ # <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
622
+ # <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
623
+ # <li>**OrgEssAuth**: 签署企业实名</li>
624
+ # <li>**FlowNotify**: 短信通知</li>
625
+ # <li>**AuthService**: 企业工商信息查询</li>
626
+ # </ul>
627
+ # @type QuotaType: String
628
+ # @param UseCount: 合同使用量
629
+ # 注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
630
+ # @type UseCount: Integer
631
+ # @param CostTime: 消耗的时间戳,格式为Unix标准时间戳(秒)。
632
+ # @type CostTime: Integer
633
+ # @param QuotaName: 消耗的套餐名称
634
+ # @type QuotaName: String
635
+ # @param CostType: 消耗类型
636
+ # **1**.扣费
637
+ # **2**.撤销返还
638
+ # @type CostType: Integer
639
+ # @param Remark: 备注
640
+ # @type Remark: String
641
+
642
+ attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :FlowStatus, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark
643
+
644
+ def initialize(flowid=nil, operatorname=nil, createorganizationname=nil, flowname=nil, flowstatus=nil, quotatype=nil, usecount=nil, costtime=nil, quotaname=nil, costtype=nil, remark=nil)
645
+ @FlowId = flowid
646
+ @OperatorName = operatorname
647
+ @CreateOrganizationName = createorganizationname
648
+ @FlowName = flowname
649
+ @FlowStatus = flowstatus
650
+ @QuotaType = quotatype
651
+ @UseCount = usecount
652
+ @CostTime = costtime
653
+ @QuotaName = quotaname
654
+ @CostType = costtype
655
+ @Remark = remark
656
+ end
657
+
658
+ def deserialize(params)
659
+ @FlowId = params['FlowId']
660
+ @OperatorName = params['OperatorName']
661
+ @CreateOrganizationName = params['CreateOrganizationName']
662
+ @FlowName = params['FlowName']
663
+ @FlowStatus = params['FlowStatus']
664
+ @QuotaType = params['QuotaType']
665
+ @UseCount = params['UseCount']
666
+ @CostTime = params['CostTime']
667
+ @QuotaName = params['QuotaName']
668
+ @CostType = params['CostType']
669
+ @Remark = params['Remark']
670
+ end
671
+ end
672
+
585
673
  # ChannelCancelFlow请求参数结构体
586
674
  class ChannelCancelFlowRequest < TencentCloud::Common::AbstractModel
587
675
  # @param FlowId: 要撤销的合同流程ID
@@ -662,12 +750,13 @@ module TencentCloud
662
750
 
663
751
  # 此接口下面信息必填。
664
752
  # <ul>
665
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
666
- # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
667
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
753
+ # <li>渠道应用标识: Agent.AppId</li>
754
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
755
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
668
756
  # </ul>
757
+ # 第三方平台子客企业和员工必须已经经过实名认证
669
758
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
670
- # @param QrCodeId: 二维码ID,为32位字符串。
759
+ # @param QrCodeId: 需要取消签署的二维码ID,为32位字符串。由[创建一码多扫流程签署二维码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
671
760
  # @type QrCodeId: String
672
761
  # @param Operator: 暂未开放
673
762
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1040,10 +1129,17 @@ module TencentCloud
1040
1129
 
1041
1130
  # ChannelCreateBoundFlows请求参数结构体
1042
1131
  class ChannelCreateBoundFlowsRequest < TencentCloud::Common::AbstractModel
1043
- # @param Agent: 应用信息
1044
- # 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
1132
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1133
+
1134
+ # 此接口下面信息必填。
1135
+ # <ul>
1136
+ # <li>渠道应用标识: Agent.AppId</li>
1137
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1138
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1139
+ # </ul>
1140
+ # 第三方平台子客企业和员工必须已经经过实名认证, 合同会领取给对应的Agent.ProxyOperator.OpenId指定的员工来处理
1045
1141
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1046
- # @param FlowIds: 领取的合同id列表
1142
+ # @param FlowIds: 需要领取的合同流程的ID列表
1047
1143
  # @type FlowIds: Array
1048
1144
  # @param Operator: 暂未开放
1049
1145
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -1257,9 +1353,17 @@ module TencentCloud
1257
1353
 
1258
1354
  # ChannelCreateFlowApprovers请求参数结构体
1259
1355
  class ChannelCreateFlowApproversRequest < TencentCloud::Common::AbstractModel
1260
- # @param Agent: 渠道应用相关信息
1356
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1357
+
1358
+ # 此接口下面信息必填。
1359
+ # <ul>
1360
+ # <li>渠道应用标识: Agent.AppId</li>
1361
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1362
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1363
+ # </ul>
1364
+ # 第三方平台子客企业和员工必须已经经过实名认证
1261
1365
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1262
- # @param FlowId: 合同唯一编号
1366
+ # @param FlowId: 合同流程ID,为32位字符串。 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
1263
1367
  # @type FlowId: String
1264
1368
  # @param Approvers: 补充企业签署人信息。
1265
1369
 
@@ -1948,13 +2052,13 @@ module TencentCloud
1948
2052
 
1949
2053
  # 此接口下面信息必填。
1950
2054
  # <ul>
1951
- # <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1952
- # <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1953
- # <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2055
+ # <li>渠道应用标识: Agent.AppId</li>
2056
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2057
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
1954
2058
  # </ul>
2059
+ # 第三方平台子客企业和员工必须已经经过实名认证
1955
2060
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1956
2061
  # @param TemplateId: 合同模板ID,为32位字符串。
1957
- # 建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
1958
2062
  # @type TemplateId: String
1959
2063
  # @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。 该名称还将用于合同签署完成后的下载文件名。
1960
2064
  # @type FlowName: String
@@ -2132,7 +2236,14 @@ module TencentCloud
2132
2236
 
2133
2237
  # ChannelCreateOrganizationModifyQrCode请求参数结构体
2134
2238
  class ChannelCreateOrganizationModifyQrCodeRequest < TencentCloud::Common::AbstractModel
2135
- # @param Agent: 应用相关信息。 此接口Agent.AppId 必填。
2239
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2240
+
2241
+ # 此接口下面信息必填。
2242
+
2243
+ # 渠道应用标识: Agent.AppId
2244
+ # 第三方平台子客企业标识: Agent.ProxyOrganizationOpenId
2245
+ # 第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId
2246
+ # 第三方平台子客企业和员工必须已经经过实名认证
2136
2247
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2137
2248
 
2138
2249
  attr_accessor :Agent
@@ -2492,7 +2603,15 @@ module TencentCloud
2492
2603
  class ChannelCreateRoleRequest < TencentCloud::Common::AbstractModel
2493
2604
  # @param Name: 角色名称,最大长度为20个字符,仅限中文、字母、数字和下划线组成。
2494
2605
  # @type Name: String
2495
- # @param Agent: 代理企业和员工的信息。
2606
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2607
+
2608
+ # 此接口下面信息必填。
2609
+ # <ul>
2610
+ # <li>渠道应用标识: Agent.AppId</li>
2611
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2612
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2613
+ # </ul>
2614
+ # 第三方平台子客企业和员工必须已经经过实名认证
2496
2615
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2497
2616
  # @param Description: 角色描述,最大长度为50个字符
2498
2617
  # @type Description: String
@@ -2936,7 +3055,15 @@ module TencentCloud
2936
3055
 
2937
3056
  # ChannelDeleteRole请求参数结构体
2938
3057
  class ChannelDeleteRoleRequest < TencentCloud::Common::AbstractModel
2939
- # @param Agent: 代理企业和员工的信息。
3058
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3059
+
3060
+ # 此接口下面信息必填。
3061
+ # <ul>
3062
+ # <li>渠道应用标识: Agent.AppId</li>
3063
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3064
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3065
+ # </ul>
3066
+ # 第三方平台子客企业和员工必须已经经过实名认证
2940
3067
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
2941
3068
  # @param RoleIds: 角色id,最多20个
2942
3069
  # @type RoleIds: Array
@@ -3097,6 +3224,101 @@ module TencentCloud
3097
3224
  end
3098
3225
  end
3099
3226
 
3227
+ # ChannelDescribeBillUsageDetail请求参数结构体
3228
+ class ChannelDescribeBillUsageDetailRequest < TencentCloud::Common::AbstractModel
3229
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3230
+
3231
+ # 此接口下面信息必填。
3232
+ # <ul>
3233
+ # <li>渠道应用标识: Agent.AppId</li>
3234
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3235
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3236
+ # </ul>
3237
+ # 第三方平台子客企业和员工必须已经经过实名认证
3238
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3239
+ # @param StartTime: 查询开始时间字符串,格式为yyyymmdd,时间跨度不能大于31天
3240
+ # @type StartTime: String
3241
+ # @param EndTime: 查询结束时间字符串,格式为yyyymmdd,时间跨度不能大于31天
3242
+ # @type EndTime: String
3243
+ # @param QuotaType: 查询的套餐类型 (选填 )不传则查询所有套餐;
3244
+ # 目前支持:
3245
+ # <ul>
3246
+ # <li>**CloudEnterprise**: 企业版合同</li>
3247
+ # <li>**SingleSignature**: 单方签章</li>
3248
+ # <li>**CloudProve**: 签署报告</li>
3249
+ # <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
3250
+ # <li>**ChannelWeCard**: 微工卡</li>
3251
+ # <li>**SignFlow**: 合同套餐</li>
3252
+ # <li>**SignFace**: 签署意愿(人脸识别)</li>
3253
+ # <li>**SignPassword**: 签署意愿(密码)</li>
3254
+ # <li>**SignSMS**: 签署意愿(短信)</li>
3255
+ # <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
3256
+ # <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
3257
+ # <li>**OrgEssAuth**: 签署企业实名</li>
3258
+ # <li>**FlowNotify**: 短信通知</li>
3259
+ # <li>**AuthService**: 企业工商信息查询</li>
3260
+ # </ul>
3261
+ # @type QuotaType: String
3262
+ # @param Offset: 指定分页返回第几页的数据,如果不传默认返回第一页,页码从 0 开始,即首页为 0
3263
+ # @type Offset: Integer
3264
+ # @param Limit: 指定分页每页返回的数据条数,如果不传默认为 50,单页最大支持 50。
3265
+ # @type Limit: Integer
3266
+
3267
+ attr_accessor :Agent, :StartTime, :EndTime, :QuotaType, :Offset, :Limit
3268
+
3269
+ def initialize(agent=nil, starttime=nil, endtime=nil, quotatype=nil, offset=nil, limit=nil)
3270
+ @Agent = agent
3271
+ @StartTime = starttime
3272
+ @EndTime = endtime
3273
+ @QuotaType = quotatype
3274
+ @Offset = offset
3275
+ @Limit = limit
3276
+ end
3277
+
3278
+ def deserialize(params)
3279
+ unless params['Agent'].nil?
3280
+ @Agent = Agent.new
3281
+ @Agent.deserialize(params['Agent'])
3282
+ end
3283
+ @StartTime = params['StartTime']
3284
+ @EndTime = params['EndTime']
3285
+ @QuotaType = params['QuotaType']
3286
+ @Offset = params['Offset']
3287
+ @Limit = params['Limit']
3288
+ end
3289
+ end
3290
+
3291
+ # ChannelDescribeBillUsageDetail返回参数结构体
3292
+ class ChannelDescribeBillUsageDetailResponse < TencentCloud::Common::AbstractModel
3293
+ # @param Total: 返回查询记录总数
3294
+ # @type Total: Integer
3295
+ # @param Details: 消耗记录详情
3296
+ # @type Details: Array
3297
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3298
+ # @type RequestId: String
3299
+
3300
+ attr_accessor :Total, :Details, :RequestId
3301
+
3302
+ def initialize(total=nil, details=nil, requestid=nil)
3303
+ @Total = total
3304
+ @Details = details
3305
+ @RequestId = requestid
3306
+ end
3307
+
3308
+ def deserialize(params)
3309
+ @Total = params['Total']
3310
+ unless params['Details'].nil?
3311
+ @Details = []
3312
+ params['Details'].each do |i|
3313
+ channelbillusagedetail_tmp = ChannelBillUsageDetail.new
3314
+ channelbillusagedetail_tmp.deserialize(i)
3315
+ @Details << channelbillusagedetail_tmp
3316
+ end
3317
+ end
3318
+ @RequestId = params['RequestId']
3319
+ end
3320
+ end
3321
+
3100
3322
  # ChannelDescribeEmployees请求参数结构体
3101
3323
  class ChannelDescribeEmployeesRequest < TencentCloud::Common::AbstractModel
3102
3324
  # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -3203,9 +3425,17 @@ module TencentCloud
3203
3425
 
3204
3426
  # ChannelDescribeFlowComponents请求参数结构体
3205
3427
  class ChannelDescribeFlowComponentsRequest < TencentCloud::Common::AbstractModel
3206
- # @param Agent: 应用相关信息。此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
3428
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3429
+
3430
+ # 此接口下面信息必填。
3431
+ # <ul>
3432
+ # <li>渠道应用标识: Agent.AppId</li>
3433
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3434
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3435
+ # </ul>
3436
+ # 第三方平台子客企业和员工必须已经经过实名认证
3207
3437
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3208
- # @param FlowId: 电子签流程的Id
3438
+ # @param FlowId: 需要获取填写控件填写内容的合同流程ID
3209
3439
  # @type FlowId: String
3210
3440
 
3211
3441
  attr_accessor :Agent, :FlowId
@@ -3226,8 +3456,7 @@ module TencentCloud
3226
3456
 
3227
3457
  # ChannelDescribeFlowComponents返回参数结构体
3228
3458
  class ChannelDescribeFlowComponentsResponse < TencentCloud::Common::AbstractModel
3229
- # @param RecipientComponentInfos: 流程关联的填写控件信息,控件会按照参与方进行分类。
3230
- # 注意:此字段可能返回 null,表示取不到有效值。
3459
+ # @param RecipientComponentInfos: 合同填写控件信息列表,填写控件会按照参与方角色进行分类。
3231
3460
  # @type RecipientComponentInfos: Array
3232
3461
  # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3233
3462
  # @type RequestId: String
@@ -3330,7 +3559,15 @@ module TencentCloud
3330
3559
 
3331
3560
  # ChannelDescribeRoles请求参数结构体
3332
3561
  class ChannelDescribeRolesRequest < TencentCloud::Common::AbstractModel
3333
- # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3562
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3563
+
3564
+ # 此接口下面信息必填。
3565
+ # <ul>
3566
+ # <li>渠道应用标识: Agent.AppId</li>
3567
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3568
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3569
+ # </ul>
3570
+ # 第三方平台子客企业和员工必须已经经过实名认证
3334
3571
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3335
3572
  # @param Limit: 指定每页多少条数据,单页最大200
3336
3573
  # @type Limit: String
@@ -3727,7 +3964,6 @@ module TencentCloud
3727
3964
  # 注意:此字段可能返回 null,表示取不到有效值。
3728
3965
  # @type RoleName: String
3729
3966
  # @param RoleStatus: 角色状态:1-启用;2-禁用
3730
- # 注意:此字段可能返回 null,表示取不到有效值。
3731
3967
  # @type RoleStatus: Integer
3732
3968
  # @param PermissionGroups: 权限树
3733
3969
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -5588,20 +5824,32 @@ module TencentCloud
5588
5824
 
5589
5825
  # DescribeUsage请求参数结构体
5590
5826
  class DescribeUsageRequest < TencentCloud::Common::AbstractModel
5591
- # @param Agent: 应用信息,此接口Agent.AppId必填
5827
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5828
+
5829
+ # 此接口下面信息必填。
5830
+ # <ul>
5831
+ # <li>渠道应用标识: Agent.AppId</li>
5832
+ # </ul>
5592
5833
  # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
5593
- # @param StartDate: 开始时间,例如:2021-03-21
5834
+ # @param StartDate: 查询日期范围的开始时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-03-21)
5835
+
5836
+ # 注: `查询日期范围区间长度大于90天`。
5594
5837
  # @type StartDate: String
5595
- # @param EndDate: 结束时间,例如:2021-06-21
5596
- # 开始时间到结束时间的区间长度小于等于90天。
5838
+ # @param EndDate: 查询日期范围的结束时间, 查询会包含此日期的数据 , 格式为yyyy-mm-dd (例如:2021-04-21)
5839
+
5840
+ # 注: `查询日期范围区间长度大于90天`。
5597
5841
  # @type EndDate: String
5598
5842
  # @param NeedAggregate: 是否汇总数据,默认不汇总。
5599
- # 不汇总:返回在统计区间内第三方平台下所有企业的每日明细,即每个企业N条数据,N为统计天数;
5600
- # 汇总:返回在统计区间内第三方平台下所有企业的汇总后数据,即每个企业一条数据;
5843
+ # <ul><li> **true** : 汇总数据, 即每个企业一条数据, 对日志范围内的数据相加</li>
5844
+ # <li> **false** : 不会总数据, 返回企业每日明细, 按日期返回每个企业的数据(如果企业对应天数没有操作则无此企业此日期的数据)</li></ul>
5601
5845
  # @type NeedAggregate: Boolean
5602
- # @param Limit: 单次返回的最多条目数量。默认为1000,且不能超过1000。
5846
+ # @param Limit: 指定每页返回的数据条数,和Offset参数配合使用。
5847
+
5848
+ # 注: `默认值为1000,单页做大值为1000`
5603
5849
  # @type Limit: Integer
5604
- # @param Offset: 偏移量,默认是0。
5850
+ # @param Offset: 查询结果分页返回,指定从第几页返回数据,和Limit参数配合使用。
5851
+
5852
+ # 注:`offset从0开始,即第一页为0。`
5605
5853
  # @type Offset: Integer
5606
5854
  # @param Operator: 暂未开放
5607
5855
  # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
@@ -5694,17 +5942,19 @@ module TencentCloud
5694
5942
  class ExtentServiceAuthInfo < TencentCloud::Common::AbstractModel
5695
5943
  # @param Type: 扩展服务类型
5696
5944
  # <ul>
5697
- # <li>AUTO_SIGN 企业自动签(自动签署)</li>
5945
+ # <li>AUTO_SIGN 企业自动签(自动签署)</li>
5698
5946
  # <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
5699
5947
  # <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
5700
- # <li> PAGING_SEAL 骑缝章</li>
5701
- # <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
5948
+ # <li> PAGING_SEAL 骑缝章</li>
5949
+ # <li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
5702
5950
  # <li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
5703
5951
  # </ul>
5704
5952
  # @type Type: String
5705
5953
  # @param Name: 扩展服务名称
5706
5954
  # @type Name: String
5707
- # @param Status: 扩展服务的开通状态: ENABLE:开通 DISABLE:未开通
5955
+ # @param Status: 扩展服务的开通状态
5956
+ # **ENABLE**:开通
5957
+ # **DISABLE**:未开通
5708
5958
  # @type Status: String
5709
5959
  # @param OperatorOpenId: 操作扩展服务的操作人第三方应用平台的用户openid
5710
5960
  # 注意:此字段可能返回 null,表示取不到有效值。
@@ -5819,20 +6069,19 @@ module TencentCloud
5819
6069
 
5820
6070
  # 文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
5821
6071
  class FilledComponent < TencentCloud::Common::AbstractModel
5822
- # @param ComponentId: 控件Id
5823
- # 注意:此字段可能返回 null,表示取不到有效值。
6072
+ # @param ComponentId: 填写控件ID
5824
6073
  # @type ComponentId: String
5825
6074
  # @param ComponentName: 控件名称
5826
- # 注意:此字段可能返回 null,表示取不到有效值。
5827
6075
  # @type ComponentName: String
5828
- # @param ComponentFillStatus: 控件填写状态;0-未填写;1-已填写
5829
- # 注意:此字段可能返回 null,表示取不到有效值。
6076
+ # @param ComponentFillStatus: 此填写控件的填写状态
6077
+ # **0** : 此填写控件**未填写**
6078
+ # **1** : 此填写控件**已填写**
5830
6079
  # @type ComponentFillStatus: String
5831
6080
  # @param ComponentValue: 控件填写内容
5832
- # 注意:此字段可能返回 null,表示取不到有效值。
5833
6081
  # @type ComponentValue: String
5834
6082
  # @param ImageUrl: 图片填充控件下载链接,如果是图片填充控件时,这里返回图片的下载链接。
5835
- # 注意:此字段可能返回 null,表示取不到有效值。
6083
+
6084
+ # 注: `链接不是永久链接, 默认有效期5分钟后, 到期后链接失效`
5836
6085
  # @type ImageUrl: String
5837
6086
 
5838
6087
  attr_accessor :ComponentId, :ComponentName, :ComponentFillStatus, :ComponentValue, :ImageUrl
@@ -7685,16 +7934,20 @@ module TencentCloud
7685
7934
 
7686
7935
  # 参与方填写控件信息
7687
7936
  class RecipientComponentInfo < TencentCloud::Common::AbstractModel
7688
- # @param RecipientId: 参与方Id
7689
- # 注意:此字段可能返回 null,表示取不到有效值。
7937
+ # @param RecipientId: 参与方的角色ID
7690
7938
  # @type RecipientId: String
7691
7939
  # @param RecipientFillStatus: 参与方填写状态
7692
- # 注意:此字段可能返回 null,表示取不到有效值。
7940
+
7941
+ # <ul><li> **0** : 还没有填写</li>
7942
+ # <li> **1** : 已经填写</li></ul>
7693
7943
  # @type RecipientFillStatus: String
7694
- # @param IsPromoter: 是否发起方
7944
+ # @param IsPromoter: 此角色是否是发起方角色
7945
+
7946
+ # <ul><li> **true** : 是发起方角色</li>
7947
+ # <li> **false** : 不是发起方角色</li></ul>
7695
7948
  # 注意:此字段可能返回 null,表示取不到有效值。
7696
7949
  # @type IsPromoter: Boolean
7697
- # @param Components: 填写控件内容
7950
+ # @param Components: 此角色的填写控件列表
7698
7951
  # 注意:此字段可能返回 null,表示取不到有效值。
7699
7952
  # @type Components: Array
7700
7953
 
@@ -7891,10 +8144,13 @@ module TencentCloud
7891
8144
  # 签署二维码的基本信息,用于创建二维码,用户可扫描该二维码进行签署操作。
7892
8145
  class SignQrCode < TencentCloud::Common::AbstractModel
7893
8146
  # @param QrCodeId: 二维码ID,为32位字符串。
8147
+
8148
+ # 注: 需要保留此二维码ID, 用于后序通过<a href="https://qian.tencent.com/developers/partnerApis/templates/ChannelCancelMultiFlowSignQRCode" target="_blank">取消一码多扫二维码</a>关闭这个二维码的签署功能。
7894
8149
  # @type QrCodeId: String
7895
8150
  # @param QrCodeUrl: 二维码URL,可通过转换二维码的工具或代码组件将此URL转化为二维码,以便用户扫描进行流程签署。
7896
8151
  # @type QrCodeUrl: String
7897
- # @param ExpiredTime: 二维码的有截止时间,格式为Unix标准时间戳(秒)。 一旦超过二维码的有效期限,该二维码将自动失效。
8152
+ # @param ExpiredTime: 二维码的有截止时间,格式为Unix标准时间戳(秒),可以通过入参的QrEffectiveDay来设置有效期,默认为7天有效期。
8153
+ # 一旦超过二维码的有效期限,该二维码将自动失效。
7898
8154
  # @type ExpiredTime: Integer
7899
8155
 
7900
8156
  attr_accessor :QrCodeId, :QrCodeUrl, :ExpiredTime
@@ -8566,17 +8822,17 @@ module TencentCloud
8566
8822
 
8567
8823
  # 用量明细
8568
8824
  class UsageDetail < TencentCloud::Common::AbstractModel
8569
- # @param ProxyOrganizationOpenId: 子客企业唯一标识
8825
+ # @param ProxyOrganizationOpenId: 子客企业标识
8570
8826
  # @type ProxyOrganizationOpenId: String
8571
8827
  # @param ProxyOrganizationName: 子客企业名
8572
8828
  # 注意:此字段可能返回 null,表示取不到有效值。
8573
8829
  # @type ProxyOrganizationName: String
8574
- # @param Date: 日期,当需要汇总数据时日期为空
8830
+ # @param Date: 对应的消耗日期, **如果是汇总数据则为1970-01-01**
8575
8831
  # 注意:此字段可能返回 null,表示取不到有效值。
8576
8832
  # @type Date: String
8577
- # @param Usage: 消耗数量
8833
+ # @param Usage: 消耗合同数量
8578
8834
  # @type Usage: Integer
8579
- # @param Cancel: 撤回数量
8835
+ # @param Cancel: 撤回合同数量
8580
8836
  # 注意:此字段可能返回 null,表示取不到有效值。
8581
8837
  # @type Cancel: Integer
8582
8838
  # @param FlowChannel: 消耗渠道
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.696
4
+ version: 3.0.698
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-11-08 00:00:00.000000000 Z
11
+ date: 2023-11-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common