tencentcloud-sdk-ess 3.0.1062 → 3.0.1064

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5241e04c6939569a596f4bab7a914cd6967f4b84
-  data.tar.gz: 0811dbcf2151f172baf55601764cda8066049c84
+  metadata.gz: be688b764605e29938160169f977c8b587f27fc6
+  data.tar.gz: b3fd187e1200e8dbe6d2dd2c5665393939ecf019
 SHA512:
-  metadata.gz: 5e822bd343ff951bc2147d414774380587fc58edf64b4324c0f41b07c7ef9a330ba5507fc73b70783ddb9b3f1faeff7d0878fb81c6a7fe92b300074afdeca0af
-  data.tar.gz: 504202eee97a269cb8e89b44d0eb92c67704ba4ba3af0660cfea422b0c50a900896dcc60cd89ca669493e3c999266f37d100569c7054cf4b427fde4b2d311197
+  metadata.gz: 0cb2acff594bfced5f6c267a044526d2376136812233aeb69c5de148f6376e2238fe540213847e931ff3d80216abceb31ff378465d53e34a92cba530d5a64049
+  data.tar.gz: 46135774fca77af42634e43c02a53a4f5ca1635891cb8426b02fddc034be316fdb72f46626a4aedd948f7787f14028915c774878ebb660405ebca6a728c4ce63

data/lib/VERSION

@@ -1 +1 @@
-3.0.1062
+3.0.1064

data/lib/v20201111/client.rb

@@ -2002,6 +2002,32 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 生成个人用户实名更名链接，个人用户点击此链接进入更名流程（若用户未完成实名认证，则直接进入实名页面实名后再进行更名）。此链接为通用链接，任何点击生成链接的用户将会被引导至小程序个人更名页面完成更名。
+
+        # 注： 调用此接口需要购买<font color="red"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。
+
+        # @param request: Request instance for CreateUserNameChangeUrl.
+        # @type request: :class:`Tencentcloud::ess::V20201111::CreateUserNameChangeUrlRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::CreateUserNameChangeUrlResponse`
+        def CreateUserNameChangeUrl(request)
+          body = send_request('CreateUserNameChangeUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = CreateUserNameChangeUrlResponse.new
+            model.deserialize(response['Response'])
+            model
+          else
+            code = response['Response']['Error']['Code']
+            message = response['Response']['Error']['Message']
+            reqid = response['Response']['RequestId']
+            raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
+          end
+        rescue TencentCloud::Common::TencentCloudSDKException => e
+          raise e
+        rescue StandardError => e
+          raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
+        end
+
         # 生成个人用户实名认证链接，个人用户点击此链接进入实名流程（若用户已完成实名认证，则直接进入成功页面）。
 
         # 注： 调用此接口需要购买<font color="red"><b>单独的实名套餐包</b></font>。使用前请联系对接的客户经理沟通。

data/lib/v20201111/models.rb

@@ -162,9 +162,9 @@ module TencentCloud
 
         # 注: `如果是用模板发起, 优先使用此处上传的, 如果不传则用模板的配置的`
         # @type ApproverRoleName: String
-        # @param VerifyChannel: <font coloe="red">【已废弃】</font>签署意愿确认渠道，默认为WEIXINAPP:人脸识别
+        # @param VerifyChannel: <font color="red">【已不再使用】</font>签署意愿确认渠道，默认为WEIXINAPP:人脸识别
 
-        # 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
+        # 注: 该字段已不再使用, 请用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
         # @type VerifyChannel: Array
         # @param PreReadTime: 签署方在签署合同之前，需要强制阅读合同的时长，可指定为3秒至300秒之间的任意值。
 
@@ -2299,7 +2299,7 @@ module TencentCloud
         # @param Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
         # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
-        # @param ClientToken: 已废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
+        # @param ClientToken: 该字段已不再使用
         # @type ClientToken: String
 
         attr_accessor :Operator, :TemplateId, :FlowId, :FileNames, :FormFields, :NeedPreview, :PreviewType, :Agent, :ClientToken
@@ -3743,10 +3743,13 @@ module TencentCloud
         # @param SignComponentConfig: 签署控件的配置信息，用在嵌入式发起的页面配置，包括
         #  - 签署控件 是否默认展示日期.
         # @type SignComponentConfig: :class:`Tencentcloud::Ess.v20201111.models.SignComponentConfig`
+        # @param ForbidEditWatermark: 是否禁止编辑（展示）水印控件属性
+        # <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+        # @type ForbidEditWatermark: Boolean
 
-        attr_accessor :CanEditFlow, :CanEditFormField, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :SkipUploadFile, :ForbidEditFillComponent, :CustomCreateFlowDescription, :ForbidAddApprover, :ForbidEditApprover, :ForbidEditFlowProperties, :HideComponentTypes, :ShowComponentTypes, :ResultPageConfig, :SignComponentConfig
+        attr_accessor :CanEditFlow, :CanEditFormField, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :SkipUploadFile, :ForbidEditFillComponent, :CustomCreateFlowDescription, :ForbidAddApprover, :ForbidEditApprover, :ForbidEditFlowProperties, :HideComponentTypes, :ShowComponentTypes, :ResultPageConfig, :SignComponentConfig, :ForbidEditWatermark
 
-        def initialize(caneditflow=nil, caneditformfield=nil, hideshowflowname=nil, hideshowflowtype=nil, hideshowdeadline=nil, canskipaddapprover=nil, skipuploadfile=nil, forbideditfillcomponent=nil, customcreateflowdescription=nil, forbidaddapprover=nil, forbideditapprover=nil, forbideditflowproperties=nil, hidecomponenttypes=nil, showcomponenttypes=nil, resultpageconfig=nil, signcomponentconfig=nil)
+        def initialize(caneditflow=nil, caneditformfield=nil, hideshowflowname=nil, hideshowflowtype=nil, hideshowdeadline=nil, canskipaddapprover=nil, skipuploadfile=nil, forbideditfillcomponent=nil, customcreateflowdescription=nil, forbidaddapprover=nil, forbideditapprover=nil, forbideditflowproperties=nil, hidecomponenttypes=nil, showcomponenttypes=nil, resultpageconfig=nil, signcomponentconfig=nil, forbideditwatermark=nil)
           @CanEditFlow = caneditflow
           @CanEditFormField = caneditformfield
           @HideShowFlowName = hideshowflowname
@@ -3763,6 +3766,7 @@ module TencentCloud
           @ShowComponentTypes = showcomponenttypes
           @ResultPageConfig = resultpageconfig
           @SignComponentConfig = signcomponentconfig
+          @ForbidEditWatermark = forbideditwatermark
         end
 
         def deserialize(params)
@@ -3792,6 +3796,7 @@ module TencentCloud
             @SignComponentConfig = SignComponentConfig.new
             @SignComponentConfig.deserialize(params['SignComponentConfig'])
           end
+          @ForbidEditWatermark = params['ForbidEditWatermark']
         end
       end
 
@@ -3877,7 +3882,7 @@ module TencentCloud
         # @param FlowType: 合同流程的类别分类（可自定义名称，如销售合同/入职合同等），最大长度为200个字符，仅限中文、字母、数字和下划线组成。
         # 此合同类型需要跟模板配置的合同类型保持一致。
         # @type FlowType: String
-        # @param ClientToken: 已经废弃字段，客户端Token，保持接口幂等性,最大长度64个字符
+        # @param ClientToken: 该字段已不再使用
         # @type ClientToken: String
         # @param DeadLine: 合同流程的签署截止时间，格式为Unix标准时间戳（秒），如果未设置签署截止时间，则默认为合同流程创建后的365天时截止。
         # 如果在签署截止时间前未完成签署，则合同状态会变为已过期，导致合同作废。
@@ -5497,7 +5502,7 @@ module TencentCloud
         # <ul><li> **OPEN**：开启（默认值）</li>
         # <li> **CLOSE**：关闭</li></ul>
         # @type IntelligentStatus: String
-        # @param Components: 该字段已废弃，请使用InitiatorComponents
+        # @param Components: 该字段已不再使用，请使用InitiatorComponents
         # @type Components: :class:`Tencentcloud::Ess.v20201111.models.Component`
         # @param FlowOption: 发起合同个性化参数
         # 用于满足创建及页面操作过程中的个性化要求
@@ -5532,7 +5537,7 @@ module TencentCloud
         # @type InitiatorComponents: Array
         # @param FlowDisplayType: 在短信通知、填写、签署流程中，若标题、按钮、合同详情等地方存在“合同”字样时，可根据此配置指定文案，可选文案如下：  <ul><li> <b>0</b> :合同（默认值）</li> <li> <b>1</b> :文件</li> <li> <b>2</b> :协议</li><li> <b>3</b> :文书</li></ul>效果如下:![FlowDisplayType](https://qcloudimg.tencent-cloud.cn/raw/e4a2c4d638717cc901d3dbd5137c9bbc.png)
         # @type FlowDisplayType: Integer
-        # @param SignComponentConfig: <font color="red">此参数已经废弃，请使用 CreateFlowOption 里面的 SignComponentConfig</font>
+        # @param SignComponentConfig: <font color="red">此字段已不再使用，请使用 CreateFlowOption 里面的 SignComponentConfig</font>
         # 签署控件的配置信息，用在嵌入式发起的页面配置，
         # 包括
 
@@ -5672,15 +5677,13 @@ module TencentCloud
         # <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
         # <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同 中国大陆居民身份证)</li></ul>
         # @type IdCardType: String
-        # @param SealImage: 印章图片的base64
-        # 注：已废弃
-        # 请先通过UploadFiles接口上传文件，获取 FileId
+        # @param SealImage: 该字段已不再使用
         # @type SealImage: String
         # @param SealImageCompress: 是否开启印章图片压缩处理，默认不开启，如需开启请设置为 true。当印章超过 2M 时建议开启，开启后图片的 hash 将发生变化。
         # @type SealImageCompress: Boolean
         # @param Mobile: 手机号码；当需要开通自动签时，该参数必传
         # @type Mobile: String
-        # @param EnableAutoSign: 此字段已废弃，请勿继续使用。
+        # @param EnableAutoSign: 该字段已不再使用
         # @type EnableAutoSign: Boolean
         # @param SealColor: 印章颜色（参数ProcessSeal=true时生效）
         # 默认值：BLACK黑色
@@ -6611,6 +6614,82 @@ module TencentCloud
         end
       end
 
+      # CreateUserNameChangeUrl请求参数结构体
+      class CreateUserNameChangeUrlRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 操作人信息
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param Endpoint: 要跳转的链接类型
+
+        # <ul>
+        # <li><strong>HTTP</strong>：适用于短信通知或H5跳转的电子签小程序HTTP长链接</li>
+        # <li><strong>HTTP_SHORT_URL</strong>：适用于短信通知或H5跳转的电子签小程序HTTP短链接</li>
+        # <li><strong>APP</strong>：（默认类型）适用于第三方APP或小程序跳转的电子签小程序路径</li>
+        # </ul>
+
+        # 注：如果不传递，默认值是 <font color="red"> HTTP </font>
+        # @type Endpoint: String
+        # @param UserData: 在用户完成改名后，其自定义数据将通过[企业引导个人更名后回调](https://qian.tencent.com/developers/company/callback_types_staffs#%E5%8D%81%E5%85%AB-%E4%BC%81%E4%B8%9A%E5%BC%95%E5%AF%BC%E4%B8%AA%E4%BA%BA%E6%9B%B4%E5%90%8D%E5%90%8E%E5%9B%9E%E8%B0%83)返回，以便用户确认其个人数据信息。请注意，自定义数据的字符长度上限为1000，且必须采用base64编码格式。
+        # @type UserData: String
+
+        attr_accessor :Operator, :Endpoint, :UserData
+
+        def initialize(operator=nil, endpoint=nil, userdata=nil)
+          @Operator = operator
+          @Endpoint = endpoint
+          @UserData = userdata
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @Endpoint = params['Endpoint']
+          @UserData = params['UserData']
+        end
+      end
+
+      # CreateUserNameChangeUrl返回参数结构体
+      class CreateUserNameChangeUrlResponse < TencentCloud::Common::AbstractModel
+        # @param UserVerifyUrl: 腾讯电子签小程序的个人更名链接。
+        # 如果没有传递，默认值是 HTTP。 链接的有效期均是 7 天。
+
+        # <strong>1.如果EndPoint是APP</strong>：
+        # 得到的链接类似于<a href="">pages/guide/index?to=MP_PERSONAL_VERIFY&shortKey=yDCZHUyOcExAlcOvNod0</a>, 用法可以参考描述中的"跳转到小程序的实现"
+
+        # <strong>2.如果EndPoint是HTTP</strong>：
+        # 得到的链接类似于 <a href="">https://res.ess.tencent.cn/cdn/h5-activity/jump-mp.html?to=TAG_VERIFY&shortKey=yDCZHUyOcChrfpaswT0d</a>，点击后会跳转到腾讯电子签小程序进行签署
+
+        # <strong>3.如果EndPoint是HTTP_SHORT_URL</strong>：
+        # 得到的链接类似于<a href="">https://essurl.cn/2n**42Nd</a>，点击后会跳转到腾讯电子签小程序进行签署
+
+
+        # `注：` <font color="red">生成的链路后面不能再增加参数，防止出错重复参数覆盖原有的参数</font>
+        # @type UserVerifyUrl: String
+        # @param ExpireTime: 链接过期时间，为Unix时间戳（单位为秒）。
+        # @type ExpireTime: Integer
+        # @param MiniAppId: 小程序appid，用于半屏拉起电子签小程序， 仅在 Endpoint 设置为 APP 的时候返回
+        # @type MiniAppId: String
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :UserVerifyUrl, :ExpireTime, :MiniAppId, :RequestId
+
+        def initialize(userverifyurl=nil, expiretime=nil, miniappid=nil, requestid=nil)
+          @UserVerifyUrl = userverifyurl
+          @ExpireTime = expiretime
+          @MiniAppId = miniappid
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @UserVerifyUrl = params['UserVerifyUrl']
+          @ExpireTime = params['ExpireTime']
+          @MiniAppId = params['MiniAppId']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # CreateUserVerifyUrl请求参数结构体
       class CreateUserVerifyUrlRequest < TencentCloud::Common::AbstractModel
         # @param Operator: 操作人信息
@@ -9367,19 +9446,24 @@ module TencentCloud
 
         # 注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**，
         # @type SkipUploadFile: Boolean
+        # @param ForbidEditWatermark: 是否禁止编辑（展示）水印控件属性
+        # <ul><li>（默认） false -否</li> <li> true - 禁止编辑</li></ul>
+        # @type ForbidEditWatermark: Boolean
 
-        attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent, :SkipUploadFile
+        attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent, :SkipUploadFile, :ForbidEditWatermark
 
-        def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil, skipuploadfile=nil)
+        def initialize(showflowdetailcomponent=nil, showtemplatecomponent=nil, skipuploadfile=nil, forbideditwatermark=nil)
           @ShowFlowDetailComponent = showflowdetailcomponent
           @ShowTemplateComponent = showtemplatecomponent
           @SkipUploadFile = skipuploadfile
+          @ForbidEditWatermark = forbideditwatermark
         end
 
         def deserialize(params)
           @ShowFlowDetailComponent = params['ShowFlowDetailComponent']
           @ShowTemplateComponent = params['ShowTemplateComponent']
           @SkipUploadFile = params['SkipUploadFile']
+          @ForbidEditWatermark = params['ForbidEditWatermark']
         end
       end
 
@@ -13853,9 +13937,7 @@ module TencentCloud
 
         # 注: `该参数仅在关键字定位时，需要去除关键字所在的灰框场景下使用。`
         # @type CoverRect: Boolean
-        # @param CustomIds: 用户自定义ID数组，与上传文件一一对应
-
-        # 注: `历史遗留问题，已经废弃，调用接口时不用赋值`
+        # @param CustomIds: 该字段已不再使用
         # @type CustomIds: Array
         # @param FileUrls: 不再使用，上传文件链接数组，最多支持20个URL
         # @type FileUrls: String

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 version: !ruby/object:Gem::Version
-  version: 3.0.1062
+  version: 3.0.1064
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-05-19 00:00:00.000000000 Z
+date: 2025-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common