tencentcloud-sdk-ess 3.0.695 → 3.0.697

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1779d3f9f5b8bd80a71e30d34290351323196d66
-  data.tar.gz: b70d2e8acab83745d6b26613a66510e15576a134
+  metadata.gz: faedc709b784f76b54ee4699a1e59c90599a3559
+  data.tar.gz: 647b9ddbff7508d655c7492eea7ef9310cad7d23
 SHA512:
-  metadata.gz: 128f9bdb6a2b64893302789210b9d7377538a42f336acb0f1ba9c1bc0288a198e30e74c4ccb61ec8d4190315085a7eee1f4fa8b3c7d37d0281deb7cc9d3fbed9
-  data.tar.gz: d097a419e1a748d6e7c1ae662f7b16c00d28fab7a60a4d288bb1309bf593be111a41601c9c234e9a7dbbfbf9eebbbb5f05aa97794093cb218c503e5532e16e6a
+  metadata.gz: 7a7895272e7ad719a737d5da36d9c259856164a78fe0d9f8056c930abe785ed71addecddecc1231afe5cb4226c5f0a070e8d12ebcc76159f9538236f1b525986
+  data.tar.gz: 443bc38a4fe785e00d6e68db57dcdcb841e5dee471b249ab7df849003e5f35ca0c7917c69852737222c5fe98befe82893bf18e0267c26373d874d9369f322d0f

data/lib/VERSION

@@ -1 +1 @@
-3.0.695
+3.0.697

data/lib/v20201111/client.rb

@@ -707,19 +707,21 @@ module TencentCloud
         end
 
         # 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
-        # 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
-        # 常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
-        # **本接口适用于发起方没有填写控件的 B2C或者单C模板**
+        # **适用场景**:
+        # 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
-        # **若是B2C模板,还要满足以下任意一个条件**
-        # - 模板中配置的签署顺序是无序
-        # - B端企业的签署方式是静默签署
-        # - B端企业是非首位签署
+        # **注意**:
+        # 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**,  若是B2C模板,还要满足以下任意一个条件
+        #     - 模板中配置的签署顺序是无序
+        #     - B端企业的签署方式是静默签署
+        #     - B端企业是非首位签署
+        # 2. 通过一码多扫二维码发起的合同，合同涉及到的回调消息可参考文档[合同发起及签署相关回调
+        # ]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
+        # 3. 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/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)
 
-        #  通过一码多扫二维码发起的合同，涉及到的合同回调消息可参考文档[合同发起以及签署相关回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign)
-
-        # 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/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)
+        # 二维码的样式如下图:
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
 
         # @param request: Request instance for CreateMultiFlowSignQRCode.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateMultiFlowSignQRCodeRequest`
@@ -1247,7 +1249,7 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询企业使用情况
+        # 通过此接口（DescribeBillUsageDetail）查询该企业的套餐消耗详情。
 
         # @param request: Request instance for DescribeBillUsageDetail.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeBillUsageDetailRequest`
@@ -1436,21 +1438,24 @@ module TencentCloud
         end
 
         # 此接口（DescribeFlowTemplates）用于查询本企业模板列表信息。
-        # >  一个模板通常会包含以下结构信息
-        # >- 模板基本信息
-        # >- 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
-        # >- 填写控件 Components
-        # >- 签署控件 SignComponents
-        # >- 生成模板的文件基础信息 FileInfos
-
-        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
 
-        # 当模板较多或模板中的控件较多时，可以通过查询模板接口更方便的获取模板列表，以及每个模板内的控件信息。
 
-        # 适用场景：
+        # **适用场景**
         # 该接口常用来配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">模板发起合同-创建电子文档</a>接口，作为创建电子文档的前置接口使用。
         # 通过此接口查询到模板信息后，再通过调用创建电子文档接口，指定模板ID，指定模板中需要的填写控件内容等，完成电子文档的创建。
 
+        # **一个模板通常会包含以下结构信息**
+
+        # - 模板模版ID, 模板名字等基本信息
+        # - 发起方参与信息Promoter、签署参与方 Recipients，后者会在模板发起合同时用于指定参与方
+        # - 发起方和签署方的填写控件 Components
+        # - 签署方的签署控件 SignComponents
+
+        # ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
+
+        # 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
+        # ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
+
         # @param request: Request instance for DescribeFlowTemplates.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeFlowTemplatesResponse`
@@ -1523,8 +1528,6 @@ module TencentCloud
 
         # 此接口（DescribeIntegrationRoles）用于分页查询企业角色列表，列表按照角色创建时间升序排列。
 
-        # 注：`法人角色是系统保留角色，因此返回列表中不含法人角色。`
-
         # @param request: Request instance for DescribeIntegrationRoles.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesRequest`
         # @rtype: :class:`Tencentcloud::ess::V20201111::DescribeIntegrationRolesResponse`

data/lib/v20201111/models.rb

@@ -463,40 +463,62 @@ module TencentCloud
       # 用户计费使用情况详情
       class BillUsageDetail < TencentCloud::Common::AbstractModel
         # @param FlowId: 合同流程ID，为32位字符串。
-        # 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
         # 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type FlowId: String
-        # @param OperatorName: 经办人名称
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param OperatorName: 合同经办人名称
+        # 如果有多个经办人用分号隔开。
         # @type OperatorName: String
         # @param CreateOrganizationName: 发起方组织机构名称
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type CreateOrganizationName: String
-        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
-        # 该名称还将用于合同签署完成后的下载文件名。
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param FlowName: 合同流程的名称。
         # @type FlowName: String
-        # @param Status: 0 还没有发起 1等待签署 2部分签署 3拒签 4已签署 5已过期 6已撤销 7还没有预发起 8等待填写 9部分填写 10拒填 11已解除
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param Status: 当前合同状态,如下是状态码对应的状态。
+        # <ul>
+        # <li>**0**: 还没有发起</li>
+        # <li>**1**: 等待签署</li>
+        # <li>**2**: 部分签署 </li>
+        # <li>**3**: 拒签</li>
+        # <li>**4**: 已签署 </li>
+        # <li>**5**: 已过期 </li>
+        # <li>**6**: 已撤销 </li>
+        # <li>**7**: 还没有预发起</li>
+        # <li>**8**: 等待填写</li>
+        # <li>**9**: 部分填写 </li>
+        # <li>**10**: 拒填</li>
+        # <li>**11**: 已解除</li>
+        # </ul>
         # @type Status: Integer
-        # @param QuotaType: 套餐类型
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param QuotaType: 查询的套餐类型
+        # 对应关系如下:
+        # <ul>
+        # <li>**CloudEnterprise**: 企业版合同</li>
+        # <li>**SingleSignature**: 单方签章</li>
+        # <li>**CloudProve**: 签署报告</li>
+        # <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
+        # <li>**ChannelWeCard**: 微工卡</li>
+        # <li>**SignFlow**: 合同套餐</li>
+        # <li>**SignFace**: 签署意愿（人脸识别）</li>
+        # <li>**SignPassword**: 签署意愿（密码）</li>
+        # <li>**SignSMS**: 签署意愿（短信）</li>
+        # <li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
+        # <li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
+        # <li>**OrgEssAuth**: 签署企业实名</li>
+        # <li>**FlowNotify**: 短信通知</li>
+        # <li>**AuthService**: 企业工商信息查询</li>
+        # </ul>
         # @type QuotaType: String
         # @param UseCount: 合同使用量
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # 注: `如果消耗类型是撤销返还，此值为负值代表返还的合同数量`
         # @type UseCount: Integer
-        # @param CostTime: 消耗的时间戳
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param CostTime: 消耗的时间戳，格式为Unix标准时间戳（秒）。
         # @type CostTime: Integer
-        # @param QuotaName: 套餐名称
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param QuotaName: 消耗的套餐名称
         # @type QuotaName: String
-        # @param CostType:  消耗类型	1.扣费 2.撤销返还
-        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @param CostType: 消耗类型
+        # **1**.扣费
+        # **2**.撤销返还
         # @type CostType: Integer
         # @param Remark: 备注
-        # 注意：此字段可能返回 null，表示取不到有效值。
         # @type Remark: String
 
         attr_accessor :FlowId, :OperatorName, :CreateOrganizationName, :FlowName, :Status, :QuotaType, :UseCount, :CostTime, :QuotaName, :CostType, :Remark
@@ -3570,18 +3592,22 @@ module TencentCloud
       class CreatePrepareFlowResponse < TencentCloud::Common::AbstractModel
         # @param Url: 发起流程的web页面链接，有效期5分钟
         # @type Url: String
+        # @param FlowId: 创建的合同id（还未实际发起），每次调用会生成新的id，用户可以记录此字段对应后续页面发起的合同，若在页面上未成功发起，则此字段无效。
+        # @type FlowId: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :Url, :RequestId
+        attr_accessor :Url, :FlowId, :RequestId
 
-        def initialize(url=nil, requestid=nil)
+        def initialize(url=nil, flowid=nil, requestid=nil)
           @Url = url
+          @FlowId = flowid
           @RequestId = requestid
         end
 
         def deserialize(params)
           @Url = params['Url']
+          @FlowId = params['FlowId']
           @RequestId = params['RequestId']
         end
       end
@@ -4762,33 +4788,35 @@ module TencentCloud
 
       # DescribeBillUsageDetail请求参数结构体
       class DescribeBillUsageDetailRequest < TencentCloud::Common::AbstractModel
-        # @param StartTime: 查询开始时间，时间跨度不能大于31天
+        # @param StartTime: 查询开始时间字符串，格式为yyyymmdd,时间跨度不能大于31天
         # @type StartTime: String
-        # @param EndTime: 查询结束时间，时间跨度不能大于31天
+        # @param EndTime: 查询结束时间字符串，格式为yyyymmdd,时间跨度不能大于31天
         # @type EndTime: String
         # @param Offset: 指定分页返回第几页的数据，如果不传默认返回第一页，页码从 0 开始，即首页为 0
         # @type Offset: Integer
         # @param Limit: 指定分页每页返回的数据条数，如果不传默认为 50，单页最大支持 50。
         # @type Limit: Integer
         # @param QuotaType: 查询的套餐类型 （选填 ）不传则查询所有套餐；
-        # 对应关系如下
-        # CloudEnterprise-企业版合同
-        # SingleSignature-单方签章
-        # CloudProve-签署报告
-        # CloudOnlineSign-腾讯会议在线签约
-        # ChannelWeCard-微工卡
-        # SignFlow-合同套餐
-        # SignFace-签署意愿（人脸识别）
-        # SignPassword-签署意愿（密码）
-        # SignSMS-签署意愿（短信）
-        # PersonalEssAuth-签署人实名（腾讯电子签认证）
-        # PersonalThirdAuth-签署人实名（信任第三方认证）
-        # OrgEssAuth-签署企业实名
-        # FlowNotify-短信通知
-        # AuthService-企业工商信息查询
+        # 目前支持:
+        # <ul>
+        # <li>**CloudEnterprise**: 企业版合同</li>
+        # <li>**SingleSignature**: 单方签章</li>
+        # <li>**CloudProve**: 签署报告</li>
+        # <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
+        # <li>**ChannelWeCard**: 微工卡</li>
+        # <li>**SignFlow**: 合同套餐</li>
+        # <li>**SignFace**: 签署意愿（人脸识别）</li>
+        # <li>**SignPassword**: 签署意愿（密码）</li>
+        # <li>**SignSMS**: 签署意愿（短信）</li>
+        # <li>**PersonalEssAuth**: 签署人实名（腾讯电子签认证）</li>
+        # <li>**PersonalThirdAuth**: 签署人实名（信任第三方认证）</li>
+        # <li>**OrgEssAuth**: 签署企业实名</li>
+        # <li>**FlowNotify**: 短信通知</li>
+        # <li>**AuthService**: 企业工商信息查询</li>
+        # </ul>
         # @type QuotaType: String
-        # @param Agent: 非必填，查询某个渠道企业的消耗情况。
-        # 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :StartTime, :EndTime, :Offset, :Limit, :QuotaType, :Agent

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.695
+  version: 3.0.697
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-11-07 00:00:00.000000000 Z
+date: 2023-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common
@@ -33,8 +33,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/v20201111/models.rb
 - lib/v20201111/client.rb
+- lib/v20201111/models.rb
 - lib/tencentcloud-sdk-ess.rb
 - lib/VERSION
 homepage: https://github.com/TencentCloud/tencentcloud-sdk-ruby