tencentcloud-sdk-ess 3.0.651 → 3.0.653

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a7d54e0e1ac0e63d73e3a7efce533e7fe8fe4a4c
-  data.tar.gz: d238bf2b7ffb5b6fecefe815c7e19257afd345cc
+  metadata.gz: f16eb3b5eeb13b67e62d57e989b56cd406ab7f11
+  data.tar.gz: 0461dadb9b6bf8779fd38ec36f235c9494a3db61
 SHA512:
-  metadata.gz: f0bd00accb3e13d37c66f38f376dfeb00e05371ba815aa0506c396e3ff4641a2cfdcdd3e5b0beb79496640cd484a3943f68760115111a7b4a2953ee3158560e3
-  data.tar.gz: 98456cfddb09350694be5d85ef059396bc1478f7acbd3e28674e0a2ec08055999349e0c4a27afe06139755191cbbd20591cda94a85c602dff67a928fc7ec0299
+  metadata.gz: 000b663298d001cacf6c24ab46f2719eb00991931c710f8e93c99b2fa7f448ce5927a9d7cb869f397d1d0204fc036914ccca8a0fab726ae5ad598a2cc5891612
+  data.tar.gz: f2becf9075c48f2a57720a3bc50268e7c65edbe6081b981d7961fb27140da1b0785d96860d28be1677aa97c0bf02e93938e8e886796aa97089c776fd6dc1b09e

data/lib/VERSION

@@ -1 +1 @@
-3.0.651
+3.0.653

data/lib/v20201111/client.rb

@@ -611,7 +611,8 @@ module TencentCloud
         end
 
         # 此接口（CreateMultiFlowSignQRCode）用于创建一码多扫流程签署二维码。
-        # 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
+        # 适用场景：无需填写签署人信息，可通过模板id生成签署二维码，签署人可通过扫描二维码补充签署信息进行实名签署。
+        # 常用于提前不知道签署人的身份信息场景，例如：劳务工招工、大批量员工入职等场景。
 
         # **本接口适用于发起方没有填写控件的 B2C或者单C模板**
 
@@ -769,17 +770,22 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 获取小程序签署链接
+        # 获取跳转至腾讯电子签小程序的签署链接
 
         # 适用场景：如果需要签署人在自己的APP、小程序、H5应用中签署，可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
 
-        # 注：如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署。
+        # 跳转到小程序的实现，参考微信官方文档（分为<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>
 
+        # 注：
+        # `1. 如果签署人是在PC端扫码签署，可以通过生成跳转链接自主转换成二维码，让签署人在PC端扫码签署`
+        # `2. 签署链接的有效期为90天，超过有效期链接不可用`
 
-        # 跳转到小程序的实现，参考官方文档（分为<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>两种方式）
+        # 其中小程序的原始Id如下，或者查看小程序信息自助获取。
 
-
-        # 如您需要自主配置小程序跳转链接，请参考: <a href="https://cloud.tencent.com/document/product/1323/74774">跳转小程序链接配置说明</a>
+        # | 小程序 | AppID | 原始ID |
+        # | ------------ | ------------ | ------------ |
+        # | 腾讯电子签（正式版） | wxa023b292fd19d41d | gh_da88f6188665 |
+        # | 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
 
         # @param request: Request instance for CreateSchemeUrl.
         # @type request: :class:`Tencentcloud::ess::V20201111::CreateSchemeUrlRequest`
@@ -998,7 +1004,12 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 查询企业扩展服务授权信息，目前支持查询：企业静默签，企业与港澳台居民签署合同，使用手机号验证签署方身份，骑缝章，批量签署能力是否已经开通
+        # 查询企业扩展服务的开通和授权情况，当前支持查询以下内容：
+        # 1. 企业静默签
+        # 2. 企业与港澳台居民签署合同
+        # 3. 使用手机号验证签署方身份
+        # 4. 骑缝章
+        # 5. 批量签署能力
 
         # @param request: Request instance for DescribeExtendedServiceAuthInfos.
         # @type request: :class:`Tencentcloud::ess::V20201111::DescribeExtendedServiceAuthInfosRequest`
@@ -1426,9 +1437,10 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 新增/删除应用callbackinfo
-        # callbackinfo包含： 回调地址和签名key
-        # 操作：新增/删除
+        # 新增/删除企业应用集成中的回调配置。
+        # 新增回调配置只会增加不存在的CallbackUrl；删除操作将针对找到的相同CallbackUrl的配置进行删除。
+        # 请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。
+        # 更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
 
         # @param request: Request instance for ModifyApplicationCallbackInfo.
         # @type request: :class:`Tencentcloud::ess::V20201111::ModifyApplicationCallbackInfoRequest`
@@ -1509,9 +1521,9 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
-        # 此接口用于发起流程
-        # 适用场景：见创建签署流程接口。
-        # 注：该接口是“创建电子文档”接口的后置接口，用于激活包含完整合同信息（模板及内容信息）的流程。激活后的流程就是一份待签署的电子合同。
+        # 此接口用于启动流程。它是模板发起合同的最后一步。
+        # 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于激活包含完整合同信息（模板及内容信息）的流程。
+        # 流程激活后，将生成一份待签署的电子合同。
 
         # @param request: Request instance for StartFlow.
         # @type request: :class:`Tencentcloud::ess::V20201111::StartFlowRequest`

data/lib/v20201111/models.rb

@@ -415,15 +415,15 @@ module TencentCloud
         end
       end
 
-      # 应用回调信息
+      # 企业应用回调信息
       class CallbackInfo < TencentCloud::Common::AbstractModel
-        # @param CallbackUrl: 回调url
+        # @param CallbackUrl: 回调url,。请确保回调地址能够接收并处理 HTTP POST 请求，并返回状态码 200 以表示处理正常。
         # @type CallbackUrl: String
         # @param Token: 回调加密key，已废弃
         # @type Token: String
-        # @param CallbackKey: 回调加密key
+        # @param CallbackKey: 回调加密key，用于回调消息加解密。
         # @type CallbackKey: String
-        # @param CallbackToken: 回调验签token
+        # @param CallbackToken: 回调验签token，用于回调通知校验。
         # @type CallbackToken: String
 
         attr_accessor :CallbackUrl, :Token, :CallbackKey, :CallbackToken
@@ -2460,50 +2460,56 @@ module TencentCloud
 
       # CreateMultiFlowSignQRCode请求参数结构体
       class CreateMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 用户信息，其中UserId为必填参数
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param TemplateId: 模板ID
+        # @param TemplateId: 合同模板ID，为32位字符串。
+        # 可登录腾讯电子签控制台，在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
         # @type TemplateId: String
-        # @param FlowName: 签署流程名称，最大长度不超过200字符
+        # @param FlowName: 合同流程的名称（可自定义此名称），长度不能超过200，只能由中文、字母、数字和下划线组成。
+        # 该名称还将用于合同签署完成后的下载文件名。
         # @type FlowName: String
-        # @param MaxFlowNum: 最大可发起签署流程份数，默认5份
-        # <br/>发起流程数量超过此上限后二维码自动失效
+        # @param MaxFlowNum: 通过此二维码可发起的流程最大限额，如未明确指定，默认为5份。
+        # 一旦发起流程数超越该限制，该二维码将自动失效。
         # @type MaxFlowNum: Integer
-        # @param FlowEffectiveDay: 签署流程有效天数
-        # <br/>默认7天
-        # <br/>最高设置不超过30天
-        # @type FlowEffectiveDay: Integer
-        # @param QrEffectiveDay: 二维码有效天数 默认7天 最高设置不超过90天
+        # @param QrEffectiveDay: 二维码的有效期限，默认为7天，最高设定不得超过90天。
+        # 一旦超过二维码的有效期限，该二维码将自动失效。
         # @type QrEffectiveDay: Integer
-        # @param Restrictions: 指定的签署人信息
-        # <br/>指定后，则只允许指定的签署人扫码签署
+        # @param FlowEffectiveDay: 合同流程的签署有效期限，若未设定签署截止日期，则默认为自合同流程创建起的7天内截止。
+        # 若在签署截止日期前未完成签署，合同状态将变更为已过期，从而导致合同无效。
+        # 最长设定期限不得超过30天。
+        # @type FlowEffectiveDay: Integer
+        # @param Restrictions: 指定签署人信息。
+        # 在指定签署人后，仅允许特定签署人通过扫描二维码进行签署。
         # @type Restrictions: Array
-        # @param UserData: 用户自定义字段
-        # <br/>回调的时候会进行透传，长度需要小于20480
+        # @param UserData: 调用方自定义的个性化字段(可自定义此字段的值)，并以base64方式编码，支持的最大数据大小为 20480长度。
+        # 在合同状态变更的回调信息等场景中，该字段的信息将原封不动地透传给贵方。
+        # 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
         # @type UserData: String
         # @param CallbackUrl: 已废弃，回调配置统一使用企业应用管理-应用集成-企业版应用中的配置
         # <br/> 通过一码多扫二维码发起的合同，回调消息可参考文档 https://qian.tencent.com/developers/company/callback_types_contracts_sign
         # <br/> 用户通过签署二维码发起合同时，因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档 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
         # @type CallbackUrl: String
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
         # @param ApproverRestrictions: 限制二维码用户条件（已弃用）
         # @type ApproverRestrictions: :class:`Tencentcloud::Ess.v20201111.models.ApproverRestriction`
 
-        attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :FlowEffectiveDay, :QrEffectiveDay, :Restrictions, :UserData, :CallbackUrl, :Agent, :ApproverRestrictions
+        attr_accessor :Operator, :TemplateId, :FlowName, :MaxFlowNum, :QrEffectiveDay, :FlowEffectiveDay, :Restrictions, :UserData, :CallbackUrl, :Agent, :ApproverRestrictions
         extend Gem::Deprecate
         deprecate :CallbackUrl, :none, 2023, 9
         deprecate :CallbackUrl=, :none, 2023, 9
         deprecate :ApproverRestrictions, :none, 2023, 9
         deprecate :ApproverRestrictions=, :none, 2023, 9
 
-        def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil, floweffectiveday=nil, qreffectiveday=nil, restrictions=nil, userdata=nil, callbackurl=nil, agent=nil, approverrestrictions=nil)
+        def initialize(operator=nil, templateid=nil, flowname=nil, maxflownum=nil, qreffectiveday=nil, floweffectiveday=nil, restrictions=nil, userdata=nil, callbackurl=nil, agent=nil, approverrestrictions=nil)
           @Operator = operator
           @TemplateId = templateid
           @FlowName = flowname
           @MaxFlowNum = maxflownum
-          @FlowEffectiveDay = floweffectiveday
           @QrEffectiveDay = qreffectiveday
+          @FlowEffectiveDay = floweffectiveday
           @Restrictions = restrictions
           @UserData = userdata
           @CallbackUrl = callbackurl
@@ -2519,8 +2525,8 @@ module TencentCloud
           @TemplateId = params['TemplateId']
           @FlowName = params['FlowName']
           @MaxFlowNum = params['MaxFlowNum']
-          @FlowEffectiveDay = params['FlowEffectiveDay']
           @QrEffectiveDay = params['QrEffectiveDay']
+          @FlowEffectiveDay = params['FlowEffectiveDay']
           unless params['Restrictions'].nil?
             @Restrictions = []
             params['Restrictions'].each do |i|
@@ -2544,9 +2550,9 @@ module TencentCloud
 
       # CreateMultiFlowSignQRCode返回参数结构体
       class CreateMultiFlowSignQRCodeResponse < TencentCloud::Common::AbstractModel
-        # @param QrCode: 签署二维码对象
+        # @param QrCode: 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
         # @type QrCode: :class:`Tencentcloud::Ess.v20201111.models.SignQrCode`
-        # @param SignUrls: 签署链接对象
+        # @param SignUrls: 流程签署二维码的签署信息，适用于客户系统整合二维码功能。通过链接，用户可直接访问电子签名小程序并签署合同。
         # @type SignUrls: :class:`Tencentcloud::Ess.v20201111.models.SignUrl`
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -3053,43 +3059,48 @@ module TencentCloud
 
       # CreateSchemeUrl请求参数结构体
       class CreateSchemeUrlRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息, userId 必填。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param OrganizationName: 企业名称
+        # @param OrganizationName: 合同流程签署方的组织机构名称。
+        # 如果名称中包含英文括号()，请使用中文括号（）代替。
         # @type OrganizationName: String
-        # @param Name: 姓名,最大长度50个字符
+        # @param Name: 合同流程里边签署方经办人的姓名。
         # @type Name: String
-        # @param Mobile: 手机号，大陆手机号11位
+        # @param Mobile: 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
         # @type Mobile: String
         # @param EndPoint: 要跳转的链接类型
 
-        # - HTTP：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  (默认)，此时返回长链
-        # - HTTP_SHORT_URL：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链
-        # - APP： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型
+        # <ul><li> **HTTP**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型  ，此时返回长链 (默认类型)</li>
+        # <li>**HTTP_SHORT_URL**：跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型，此时返回短链</li>
+        # <li>**APP**： 第三方APP或小程序跳转电子签小程序的path,  APP或者小程序跳转适合此类型</li></ul>
         # @type EndPoint: String
-        # @param FlowId: 签署流程编号 (PathType=1时必传)
+        # @param FlowId: 合同流程ID
+        # 注: `如果准备跳转到合同流程签署的详情页面(即PathType=1时)必传,   跳转其他页面可不传`
         # @type FlowId: String
-        # @param FlowGroupId: 合同组ID
+        # @param FlowGroupId: 合同流程组的组ID, 在合同流程组场景下，生成合同流程组的签署链接时需要赋值
         # @type FlowGroupId: String
         # @param PathType: 要跳转到的页面类型
 
-        # - 0: 不传, 主页 (默认)
-        # - 1: 小程序合同详情
-        # - 2: 小程序合同列表页
+        # <ul><li> **0** : 腾讯电子签小程序个人首页 (默认)</li>
+        # <li> **1** : 腾讯电子签小程序流程合同的详情页 (即合同签署页面)</li>
+        # <li> **2** : 腾讯电子签小程序合同列表页</li></ul>
         # @type PathType: Integer
-        # @param AutoJumpBack: 是否自动回跳
-        # true：是，
-        # false：否。
-        # 该参数只针对"APP" 类型的签署链接有效
+        # @param AutoJumpBack: 签署完成后是否自动回跳
+        # <ul><li>**false**：否, 签署完成不会自动跳转回来(默认)</li><li>**true**：是, 签署完成会自动跳转回来</li></ul>
+        # 注:  ` 该参数只针对"APP" 类型的签署链接有效`
         # @type AutoJumpBack: Boolean
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param Hides: 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
+        # @param Hides: 生成的签署链接在签署页面隐藏的按钮列表，可设置如下：
+
+        # <ul><li> **0** :合同签署页面更多操作按钮</li>
+        # <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
+        # <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
+        # <li> **3** :签署成功页的查看详情按钮</li></ul>
 
-        # - 0:合同签署页面更多操作按钮
-        # - 1:合同签署页面更多操作的拒绝签署按钮
-        # - 2:合同签署页面更多操作的转他人处理按钮
-        # - 3:签署成功页的查看详情按钮
+        # 注:  `字段为数组, 可以传值隐藏多个按钮`
         # @type Hides: Array
 
         attr_accessor :Operator, :OrganizationName, :Name, :Mobile, :EndPoint, :FlowId, :FlowGroupId, :PathType, :AutoJumpBack, :Agent, :Hides
@@ -3131,7 +3142,11 @@ module TencentCloud
 
       # CreateSchemeUrl返回参数结构体
       class CreateSchemeUrlResponse < TencentCloud::Common::AbstractModel
-        # @param SchemeUrl: 小程序链接地址，有效期90天。如果EndPoint是App，得到的链接Path如’weixin://dl/business/?t= *TICKET*‘，用于客户APP、小程序直接拉起电子签小程序；其他EndPoint得到的https链接如'https://essurl.cn/xxx'，点击链接会打开一个H5页面，然后拉起电子签小程序。
+        # @param SchemeUrl: 腾讯电子签小程序的签署链接。
+
+        # <ul><li>如果EndPoint是**APP**，得到的链接类似于`pages/guide?from=default&where=mini&id=yDwJSUUirqauh***7jNSxwdirTSGuH&to=CONTRACT_DETAIL&name=&phone=&shortKey=yDw***k1xFc5`, 用法可以参加接口描述中的"跳转到小程序的实现"</li>
+        # <li>如果EndPoint是**HTTP**，得到的链接类似于 `https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?where=mini&from=SFY&id=yDwfEUUw**4rV6Avz&to=MVP_CONTRACT_COVER&name=%E9%83%**5%86%9B`，点击后会跳转到腾讯电子签小程序进行签署</li>
+        # <li>如果EndPoint是**HTTP_SHORT_URL**，得到的链接类似于 `https://essurl.cn/2n**42Nd`，点击后会跳转到腾讯电子签小程序进行签署</li></ul>
         # @type SchemeUrl: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -3819,24 +3834,28 @@ module TencentCloud
 
       # DescribeExtendedServiceAuthInfos请求参数结构体
       class DescribeExtendedServiceAuthInfosRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 操作人信息
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作
-        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param ExtendServiceType: 扩展服务类型，默认为空，查询目前支持的所有扩展服务信息，单个指定则查询单个扩展服务开通信息，取值：
-        # OPEN_SERVER_SIGN：开通企业静默签署
-        # OVERSEA_SIGN：企业与港澳台居民签署合同
-        # MOBILE_CHECK_APPROVER：使用手机号验证签署方身份
-        # PAGING_SEAL：骑缝章
-        # BATCH_SIGN：批量签署
+        # @param ExtendServiceType: 要查询的扩展服务类型。
+        # 默认为空，即查询当前支持的所有扩展服务信息。
+        # 若需查询单个扩展服务的开通情况，请传递相应的值，如下所示：
+        # <ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
+        # <li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
+        # <li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
+        # <li>PAGING_SEAL：骑缝章</li>
+        # <li>BATCH_SIGN：批量签署</li></ul>
         # @type ExtendServiceType: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
-        attr_accessor :Operator, :Agent, :ExtendServiceType
+        attr_accessor :Operator, :ExtendServiceType, :Agent
 
-        def initialize(operator=nil, agent=nil, extendservicetype=nil)
+        def initialize(operator=nil, extendservicetype=nil, agent=nil)
           @Operator = operator
-          @Agent = agent
           @ExtendServiceType = extendservicetype
+          @Agent = agent
         end
 
         def deserialize(params)
@@ -3844,17 +3863,17 @@ module TencentCloud
             @Operator = UserInfo.new
             @Operator.deserialize(params['Operator'])
           end
+          @ExtendServiceType = params['ExtendServiceType']
           unless params['Agent'].nil?
             @Agent = Agent.new
             @Agent.deserialize(params['Agent'])
           end
-          @ExtendServiceType = params['ExtendServiceType']
         end
       end
 
       # DescribeExtendedServiceAuthInfos返回参数结构体
       class DescribeExtendedServiceAuthInfosResponse < TencentCloud::Common::AbstractModel
-        # @param AuthInfoList: 授权服务信息列表
+        # @param AuthInfoList: 服务开通和授权的信息列表，根据查询类型返回所有支持的扩展服务开通和授权状况，或者返回特定扩展服务的开通和授权状况。
         # @type AuthInfoList: Array
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
@@ -5031,27 +5050,28 @@ module TencentCloud
         end
       end
 
-      # 授权服务信息
+      # 扩展服务开通和授权的详细信息
       class ExtendAuthInfo < TencentCloud::Common::AbstractModel
-        # @param Type: 授权服务类型
-        # OPEN_SERVER_SIGN：开通企业静默签署
-        # OVERSEA_SIGN：企业与港澳台居民签署合同
-        # MOBILE_CHECK_APPROVER：使用手机号验证签署方身份
-        # PAGING_SEAL：骑缝章
-        # BATCH_SIGN：批量签署
+        # @param Type: 扩展服务的类型，可能是以下值：
+        # <ul><li>OPEN_SERVER_SIGN：企业静默签署</li>
+        # <li>OVERSEA_SIGN：企业与港澳台居民签署合同</li>
+        # <li>MOBILE_CHECK_APPROVER：使用手机号验证签署方身份</li>
+        # <li>PAGING_SEAL：骑缝章</li>
+        # <li>BATCH_SIGN：批量签署</li></ul>
         # @type Type: String
-        # @param Name: 授权服务名称
+        # @param Name: 扩展服务的名称
         # @type Name: String
-        # @param Status: 授权服务状态，ENABLE：开通
+        # @param Status: 扩展服务的开通状态：
+        # ENABLE：开通
         # DISABLE：未开通
         # @type Status: String
-        # @param OperatorUserId: 授权人用户id
+        # @param OperatorUserId: 操作扩展服务的操作人UserId，员工在腾讯电子签平台的唯一身份标识，为32位字符串。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OperatorUserId: String
-        # @param OperateOn: 授权时间戳，单位秒
+        # @param OperateOn: 扩展服务的操作时间，格式为Unix标准时间戳（秒）。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OperateOn: Integer
-        # @param HasAuthUserList: 被授权用户列表
+        # @param HasAuthUserList: 该扩展服务若可以授权，此参数对应授权人员的列表
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type HasAuthUserList: Array
 
@@ -5388,10 +5408,13 @@ module TencentCloud
         # @param OrganizationName: 签署方企业名称
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type OrganizationName: String
+        # @param SignId: 签署参与人在本流程中的编号ID（每个流程不同），可用此ID来定位签署参与人在本流程的签署节点，也可用于后续创建签署链接等操作。
+        # 注意：此字段可能返回 null，表示取不到有效值。
+        # @type SignId: String
 
-        attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName
+        attr_accessor :ApproveMessage, :ApproveName, :ApproveStatus, :ReceiptId, :CustomUserId, :Mobile, :SignOrder, :ApproveTime, :ApproveType, :ApproverSource, :CustomApproverTag, :OrganizationId, :OrganizationName, :SignId
 
-        def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil)
+        def initialize(approvemessage=nil, approvename=nil, approvestatus=nil, receiptid=nil, customuserid=nil, mobile=nil, signorder=nil, approvetime=nil, approvetype=nil, approversource=nil, customapprovertag=nil, organizationid=nil, organizationname=nil, signid=nil)
           @ApproveMessage = approvemessage
           @ApproveName = approvename
           @ApproveStatus = approvestatus
@@ -5405,6 +5428,7 @@ module TencentCloud
           @CustomApproverTag = customapprovertag
           @OrganizationId = organizationid
           @OrganizationName = organizationname
+          @SignId = signid
         end
 
         def deserialize(params)
@@ -5421,6 +5445,7 @@ module TencentCloud
           @CustomApproverTag = params['CustomApproverTag']
           @OrganizationId = params['OrganizationId']
           @OrganizationName = params['OrganizationName']
+          @SignId = params['SignId']
         end
       end
 
@@ -6259,14 +6284,14 @@ module TencentCloud
         end
       end
 
-      # 被授权用户信息
+      # 被授权的用户信息
       class HasAuthUser < TencentCloud::Common::AbstractModel
-        # @param UserId: 用户id
+        # @param UserId: 员工在腾讯电子签平台的唯一身份标识，为32位字符串。
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type UserId: String
-        # @param BelongTo: 用户归属
-        # MainOrg：主企业
-        # CurrentOrg：当前企业
+        # @param BelongTo: 当前员工的归属情况，可能值是：
+        # MainOrg：在集团企业的场景下，返回此值代表是归属主企业
+        # CurrentOrg：在普通企业场景下返回此值；或者在集团企业的场景下，返回此值代表归属子企业
         # 注意：此字段可能返回 null，表示取不到有效值。
         # @type BelongTo: String
 
@@ -6398,13 +6423,17 @@ module TencentCloud
 
       # ModifyApplicationCallbackInfo请求参数结构体
       class ModifyApplicationCallbackInfoRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param OperateType: 操作类型：1-新增，2-删除
+        # @param OperateType: 操作类型：
+        # 1-新增
+        # 2-删除
         # @type OperateType: Integer
-        # @param CallbackInfo: 回调信息
+        # @param CallbackInfo: 企业应用回调信息
         # @type CallbackInfo: :class:`Tencentcloud::Ess.v20201111.models.CallbackInfo`
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
 
         attr_accessor :Operator, :OperateType, :CallbackInfo, :Agent
@@ -7168,13 +7197,14 @@ module TencentCloud
         end
       end
 
-      # 一码多扫签署二维码对象
+      # 签署二维码的基本信息，用于创建二维码，用户可扫描该二维码进行签署操作。
       class SignQrCode < TencentCloud::Common::AbstractModel
-        # @param QrCodeId: 二维码id
+        # @param QrCodeId: 二维码ID，为32位字符串。
         # @type QrCodeId: String
-        # @param QrCodeUrl: 二维码url
+        # @param QrCodeUrl: 二维码URL，可通过转换二维码的工具或代码组件将此URL转化为二维码，以便用户扫描进行流程签署。
         # @type QrCodeUrl: String
-        # @param ExpiredTime: 二维码过期时间戳，单位秒
+        # @param ExpiredTime: 二维码的有截止时间，格式为Unix标准时间戳（秒）。
+        # 一旦超过二维码的有效期限，该二维码将自动失效。
         # @type ExpiredTime: Integer
 
         attr_accessor :QrCodeId, :QrCodeUrl, :ExpiredTime
@@ -7192,13 +7222,16 @@ module TencentCloud
         end
       end
 
-      # 一码多扫签署二维码签署信息
+      # 流程签署二维码的签署信息，适用于客户系统整合二维码功能。
+      # 通过链接，用户可直接访问电子签名小程序并签署合同。
       class SignUrl < TencentCloud::Common::AbstractModel
-        # @param AppSignUrl: 小程序签署链接
+        # @param AppSignUrl: 跳转至电子签名小程序签署的链接地址。
+        # 适用于客户端APP及小程序直接唤起电子签名小程序。
         # @type AppSignUrl: String
-        # @param EffectiveTime: 签署链接有效时间
+        # @param EffectiveTime: 签署链接有效时间，格式类似"2022-08-05 15:55:01"
         # @type EffectiveTime: String
-        # @param HttpSignUrl: 移动端签署链接
+        # @param HttpSignUrl: 跳转至电子签名小程序签署的链接地址，格式类似于https://essurl.cn/xxx。
+        # 打开此链接将会展示H5中间页面，随后唤起电子签名小程序以进行合同签署。
         # @type HttpSignUrl: String
 
         attr_accessor :AppSignUrl, :EffectiveTime, :HttpSignUrl
@@ -7334,22 +7367,26 @@ module TencentCloud
 
       # StartFlow请求参数结构体
       class StartFlowRequest < TencentCloud::Common::AbstractModel
-        # @param Operator: 调用方用户信息，userId 必填。支持填入集团子公司经办人 userId代发合同。
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
         # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
-        # @param FlowId: 签署流程编号，由CreateFlow接口返回
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # 此处需要传入[创建签署流程接口](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)得到的FlowId。
         # @type FlowId: String
         # @param ClientToken: 客户端Token，保持接口幂等性,最大长度64个字符
         # @type ClientToken: String
-        # @param Agent: 代理相关应用信息，如集团主企业代子企业操作的场景中ProxyOrganizationId必填
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param CcNotifyType: 给关注人发送短信通知的类型，
-
-        # 0-合同发起时通知
-
-        # 1-签署完成后通知
+        # @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos，此参数可设定向关注人发送短信通知的类型：
+        # 0 - 合同发起时通知（默认）
+        # 1 - 签署完成后通知
         # @type CcNotifyType: Integer
 
         attr_accessor :Operator, :FlowId, :ClientToken, :Agent, :CcNotifyType
+        extend Gem::Deprecate
+        deprecate :ClientToken, :none, 2023, 9
+        deprecate :ClientToken=, :none, 2023, 9
 
         def initialize(operator=nil, flowid=nil, clienttoken=nil, agent=nil, ccnotifytype=nil)
           @Operator = operator
@@ -7376,13 +7413,10 @@ module TencentCloud
 
       # StartFlow返回参数结构体
       class StartFlowResponse < TencentCloud::Common::AbstractModel
-        # @param Status: 发起成功之后返回状态，
-
-        # START-发起成功，
-
-        # REVIEW-提交审核成功，
-
-        # EXECUTING-已提交发起任务
+        # @param Status: 发起成功后返回的状态，根据合同流程的不同，返回不同状态：
+        # START - 发起成功
+        # REVIEW - 提交审核成功
+        # EXECUTING - 已提交发起任务
         # @type Status: String
         # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.651
+  version: 3.0.653
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-09-01 00:00:00.000000000 Z
+date: 2023-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common