tencentcloud-sdk-essbasic 3.0.1036 → 3.0.1038

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f18325a05a456a03b930583791ecec8ae504ff1
-  data.tar.gz: dc9d5b132a790ebbaa1906f07dbe748fdaa8d641
+  metadata.gz: d4a141118aa51c0fe74e3792a3e80027de9f4b2d
+  data.tar.gz: bff021537a14b4f999594757d391a7c89596b172
 SHA512:
-  metadata.gz: eca24035e39e8a1df38782a0b4824f97ac347fc4b78842220acf7c11faa008c5fa52f10ed30844b36b18c1ed473e1dedfe4045cb41fab1ddf771ca502c56d2d7
-  data.tar.gz: 6cc468d7fb80925502ce0239eef8ae28223c8d4380a9434a20aeb89e3c03e7fba12c66861a1ba0e977d1ea395c3dfa60da8216be9da5b46e0c32aa354072298b
+  metadata.gz: afa3e05efff82a996c71be1d03957c470970fc75fee13456a639dbb4f6ceb02f4cab925ed8a12528a694471ee43fbb549a051ceb2701122b0b4420928e53210b
+  data.tar.gz: b4eb7482d367d85ec66851bcca25f569a42e6e67e8fab50256278d7eb574ba76bbb5bb584274141900535edae4e09aa1e1c3003bfe1125a95289de8a6f5ff893

data/lib/VERSION

@@ -1 +1 @@
-3.0.1036
+3.0.1038

data/lib/v20210526/client.rb

@@ -3028,6 +3028,40 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 <a href="https://qian.tencent.com/developers/partner/callback_types_templates" target="_blank">模板操作相关回调</a>
+
+        # # 支持的操作
+        # ## 1. 删除模板 (OperateType=DELETE)
+        # 此操作会从模板将企业自有模板中彻底删除，若要保留模板而不删除，可将将模板停用。
+
+        # ## 2. 启用模板 (OperateType=ENABLE)
+        # 此操作是将停用的模板启用，操作幂等，若模板已经启用，接口不报错。
+
+        # ## 3. 停用模板 (OperateType=DELETE)
+        # 此操作是将启用态的模板停用，操作幂等，若模板已经停用，接口不报错，停用后，无法通过此模板发起合同，已经发起的合同不受影响。
+
+        # @param request: Request instance for OperateTemplate.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::OperateTemplateRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::OperateTemplateResponse`
+        def OperateTemplate(request)
+          body = send_request('OperateTemplate', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = OperateTemplateResponse.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
+
         # 该接口 (PrepareFlows) 用于创建待发起文件
         # 用户通过该接口进入签署流程发起的确认页面，进行发起信息二次确认， 如果确认则进行正常发起。
         # 目前该接口只支持B2C，<font color='red'> **不建议使用，将会废弃**</font>。

data/lib/v20210526/models.rb

@@ -1096,10 +1096,12 @@ module TencentCloud
         # @type CacheApproverInfo: Boolean
         # @param CanBatchReject: 是否允许此链接中签署方批量拒签。 <ul><li>false (默认): 不允许批量拒签</li> <li>true : 允许批量拒签。</li></ul>注：`合同组暂不支持批量拒签功能。`
         # @type CanBatchReject: Boolean
+        # @param PresetApproverInfo: 预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。
+        # @type PresetApproverInfo: :class:`Tencentcloud::Essbasic.v20210526.models.PresetApproverInfo`
 
-        attr_accessor :FlowApproverInfo, :Agent, :FlowIds, :FlowGroupId, :JumpUrl, :SignatureTypes, :ApproverSignTypes, :SignTypeSelector, :FlowBatchUrlInfo, :Intention, :CacheApproverInfo, :CanBatchReject
+        attr_accessor :FlowApproverInfo, :Agent, :FlowIds, :FlowGroupId, :JumpUrl, :SignatureTypes, :ApproverSignTypes, :SignTypeSelector, :FlowBatchUrlInfo, :Intention, :CacheApproverInfo, :CanBatchReject, :PresetApproverInfo
 
-        def initialize(flowapproverinfo=nil, agent=nil, flowids=nil, flowgroupid=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil, signtypeselector=nil, flowbatchurlinfo=nil, intention=nil, cacheapproverinfo=nil, canbatchreject=nil)
+        def initialize(flowapproverinfo=nil, agent=nil, flowids=nil, flowgroupid=nil, jumpurl=nil, signaturetypes=nil, approversigntypes=nil, signtypeselector=nil, flowbatchurlinfo=nil, intention=nil, cacheapproverinfo=nil, canbatchreject=nil, presetapproverinfo=nil)
           @FlowApproverInfo = flowapproverinfo
           @Agent = agent
           @FlowIds = flowids
@@ -1112,6 +1114,7 @@ module TencentCloud
           @Intention = intention
           @CacheApproverInfo = cacheapproverinfo
           @CanBatchReject = canbatchreject
+          @PresetApproverInfo = presetapproverinfo
         end
 
         def deserialize(params)
@@ -1139,6 +1142,10 @@ module TencentCloud
           end
           @CacheApproverInfo = params['CacheApproverInfo']
           @CanBatchReject = params['CanBatchReject']
+          unless params['PresetApproverInfo'].nil?
+            @PresetApproverInfo = PresetApproverInfo.new
+            @PresetApproverInfo.deserialize(params['PresetApproverInfo'])
+          end
         end
       end
 
@@ -1180,12 +1187,19 @@ module TencentCloud
         # @param Name: 签署方经办人的姓名。
         # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
 
-        # 注：`请确保和合同中填入的一致`，`除动态签署人或子客员工经办人场景外，此参数必填`
+        # 注：
+        # <ul>
+        # <li>请确保和合同中填入的一致。</li>
+        # <li>在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。</li>
+        # </ul>
         # @type Name: String
         # @param Mobile: 手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
         # 请确认手机号所有方为此业务通知方。
 
-        # 注：`请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息`，`除动态签署人或子客员工经办人场景外，此参数必填`
+        # 注：
+        # <ul>
+        # <li>请确保和合同中填入的一致,  若无法保持一致，请确保在发起和生成批量签署链接时传入相同的参与方证件信息。</li><li>在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。 </li>
+        # </ul>
         # @type Mobile: String
         # @param Operator: 执行本接口操作的员工信息。
         # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
@@ -1195,14 +1209,18 @@ module TencentCloud
         # <li>**HONGKONG_AND_MACAO** : 中国港澳居民来往内地通行证</li>
         # <li>**HONGKONG_MACAO_AND_TAIWAN** : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
 
-        # 注：`请确保和合同中填入的一致`
+        # 注：
+        # 1. `请确保和合同中填入的一致`。
+        # 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
         # @type IdCardType: String
         # @param IdCardNumber: 证件号码，应符合以下规则
         # <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成（如存在X，请大写）。</li>
         # <li>中国港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
         # <li>中国港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
 
-        # 注：`请确保和合同中填入的一致`
+        # 注：
+        # 1. `请确保和合同中填入的一致`。
+        # 2. `在生成动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
         # @type IdCardNumber: String
         # @param NotifyType: 通知用户方式：
         # <ul>
@@ -7111,20 +7129,28 @@ module TencentCloud
         # @param OrganizationName: SaaS平台企业员工签署方的企业名称如果名称中包含英文括号()，请使用中文括号（）代替。  注:  `1.GenerateType为"NOT_CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
         # @type OrganizationName: String
         # @param Name: 合同流程里边参与方的姓名。
-        # 注: `GenerateType为"PERSON"(即个人签署方)时必填`
+        # 注:
+        # 1. `GenerateType为"PERSON"(即个人签署方)时必填`。
+        # 2. `在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
         # @type Name: String
         # @param Mobile: 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
-        # 注:  `GenerateType为"PERSON"或"FOLLOWER"时必填`
+        # 注:
+        # 1. `GenerateType为"PERSON"或"FOLLOWER"时必填。`
+        # 2. `在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
         # @type Mobile: String
         # @param IdCardType: 证件类型，支持以下类型
         # <ul><li>ID_CARD : 中国大陆居民身份证</li>
         # <li>HONGKONG_AND_MACAO : 中国港澳居民来往内地通行证</li>
         # <li>HONGKONG_MACAO_AND_TAIWAN : 中国港澳台居民居住证(格式同中国大陆居民身份证)</li></ul>
+
+        # `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件类型的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方，且需要和证件号参数一同传递，不能单独进行限制。`
         # @type IdCardType: String
         # @param IdCardNumber: 证件号码，应符合以下规则
         # <ul><li>居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li>
         # <li>港澳居民来往内地通行证号码共11位。第1位为字母，“H”字头签发给中国香港居民，“M”字头签发给中国澳门居民；第2位至第11位为数字。</li>
         # <li>港澳台居民居住证号码编码规则与中国大陆身份证相同，应为18位字符串。</li></ul>
+
+        # `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入证件号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
         # @type IdCardNumber: String
         # @param OrganizationOpenId: 第三方平台子客企业的企业的标识, 即OrganizationOpenId。 注:  `1.GenerateType为"CHANNEL"时必填` `2.获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的平台子客企业,预设后只能以该平台子客企业身份去领取合同并完成签署`
         # @type OrganizationOpenId: String
@@ -10555,6 +10581,61 @@ module TencentCloud
         end
       end
 
+      # OperateTemplate请求参数结构体
+      class OperateTemplateRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+
+        # 此接口下面信息必填。
+        # <ul>
+        # <li>渠道应用标识:  Agent.AppId</li>
+        # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId（模板的归属企业）</li>
+        # <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId （操作人）</li>
+        # </ul>
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param TemplateId: 模板ID，为32位字符串。
+        # @type TemplateId: String
+        # @param OperateType: 操作类型，可取值如下:
+        # <ul>
+        # <li>DELETE:  删除</li>
+        # <li>ENABLE: 启用</li>
+        # <li>DISABLE: 停用</li>
+        # </ul>
+        # @type OperateType: String
+
+        attr_accessor :Agent, :TemplateId, :OperateType
+
+        def initialize(agent=nil, templateid=nil, operatetype=nil)
+          @Agent = agent
+          @TemplateId = templateid
+          @OperateType = operatetype
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @TemplateId = params['TemplateId']
+          @OperateType = params['OperateType']
+        end
+      end
+
+      # OperateTemplate返回参数结构体
+      class OperateTemplateResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # 企业批量注册链接信息
       class OrganizationAuthUrl < TencentCloud::Common::AbstractModel
         # @param AuthUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
@@ -10955,6 +11036,40 @@ module TencentCloud
         end
       end
 
+      # 预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。
+      class PresetApproverInfo < TencentCloud::Common::AbstractModel
+        # @param Name: 预设参与方姓名。
+        # @type Name: String
+        # @param Mobile: 预设参与方手机号。
+        # @type Mobile: String
+        # @param IdCardNumber: 预设参与方证件号，需要和IdCardType同时传入。
+
+        # 证件号码，应符合以下规则
+        # <ul><li>中国大陆居民身份证号码应为18位字符串，由数字和大写字母X组成(如存在X，请大写)。</li></ul>
+        # @type IdCardNumber: String
+        # @param IdCardType: 预设参与方的证件类型，需要与IdCardNumber同时传入。
+
+        # 证件类型，支持以下类型
+        # <ul><li><b>ID_CARD</b>: 居民身份证</li></ul>
+        # @type IdCardType: String
+
+        attr_accessor :Name, :Mobile, :IdCardNumber, :IdCardType
+
+        def initialize(name=nil, mobile=nil, idcardnumber=nil, idcardtype=nil)
+          @Name = name
+          @Mobile = mobile
+          @IdCardNumber = idcardnumber
+          @IdCardType = idcardtype
+        end
+
+        def deserialize(params)
+          @Name = params['Name']
+          @Mobile = params['Mobile']
+          @IdCardNumber = params['IdCardNumber']
+          @IdCardType = params['IdCardType']
+        end
+      end
+
       # 同步的员工的信息
       class ProxyOrganizationOperator < TencentCloud::Common::AbstractModel
         # @param Id: 员工的唯一标识(即OpenId),  定义Agent中的OpenId一样, 可以参考<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#agent" target="_blank">Agent结构体</a>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-essbasic
 version: !ruby/object:Gem::Version
-  version: 3.0.1036
+  version: 3.0.1038
 platform: ruby
 authors:
 - Tencent Cloud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-07 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: tencentcloud-sdk-common