tencentcloud-sdk-ess 3.0.1036 → 3.0.1038

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cc8302ce8548dc215e74c6be81277cf7f19b24e
-  data.tar.gz: f6e57513607f9ac10f1fb5976a12511b99e21b7e
+  metadata.gz: 218b040ec60e0672a1fd64886a1e36cf3cfbc34e
+  data.tar.gz: 94443b7bf1fc5e072191a8f4c6f34a1f19f435f0
 SHA512:
-  metadata.gz: bbf02517ce8018c52c407064e28b7f35f460a6ee272b3047777456592b3e3e8ce7bad283526e66d03b3d1b57e79f468d37a1b81434819a78653b66eac5280beb
-  data.tar.gz: db32b1b54eff7ef017008bc1f9e40eb93a3f0ced38bee1cf9b211a84fd604e1c3c4eeda8dbfed447cd60e1b79bbe7a5dd95e6de4e0b0cb8a60355b550ec97d58
+  metadata.gz: 2aa50932a24e58249886f6110450803e8a2553c251ef22d27622093125297427d3ff126c243bd2c74e0708cff33bb701442b339ab5569506d99e54ac7e3aed7a
+  data.tar.gz: 9505e3968506703b7d874f3b6f9cec1c464880a2597d139a3e82f1353a88f23ca916acebba12fef145037f8c2120bbb61ad6662e99587b8120b8be72501ddaa1

data/lib/VERSION

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

data/lib/v20201111/client.rb

@@ -526,8 +526,10 @@ module TencentCloud
         # 1. 创建印章
         # 2. 创建模板
         # 3. 修改模板
-        # 4. 预览模板
-        # 5. 预览合同流程
+        # 4. 创建起草合同
+        # 5. 预览模板
+        # 6. 预览合同流程
+
 
         # 预览模板的嵌入页面长相如下：
         # ![image](https://qcloudimg.tencent-cloud.cn/raw/57bdda4a884e3f5b2de12d5a282a3651.png)
@@ -3162,6 +3164,40 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 此接口（OperateTemplate）用于对企业自有模板进行管理操作，所有操作都会有对应的回调触发，具体参考回调文档 <a href="https://qian.tencent.com/developers/company/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::ess::V20201111::OperateTemplateRequest`
+        # @rtype: :class:`Tencentcloud::ess::V20201111::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
+
         # 给医疗个人自动签许可续期。续期成功后，可对医疗自动签许可追加一年有效期，只可续期一次。
 
         # 注意: `处方单等特殊场景专用，此接口为白名单功能，使用前请联系对接的客户经理沟通。`

data/lib/v20201111/models.rb

@@ -1924,10 +1924,12 @@ module TencentCloud
 
         # 注：`合同组暂不支持批量拒签功能。`
         # @type CanBatchReject: Boolean
+        # @param PresetApproverInfo: 	 预设的动态签署方的补充信息，仅匹配对应信息的签署方才能领取合同。暂时仅对个人参与方生效。
+        # @type PresetApproverInfo: :class:`Tencentcloud::Ess.v20201111.models.PresetApproverInfo`
 
-        attr_accessor :FlowApproverInfo, :Agent, :Operator, :FlowIds, :FlowGroupId, :JumpUrl, :SignatureTypes, :ApproverSignTypes, :SignTypeSelector, :FlowBatchUrlInfo, :Intention, :CacheApproverInfo, :CanBatchReject
+        attr_accessor :FlowApproverInfo, :Agent, :Operator, :FlowIds, :FlowGroupId, :JumpUrl, :SignatureTypes, :ApproverSignTypes, :SignTypeSelector, :FlowBatchUrlInfo, :Intention, :CacheApproverInfo, :CanBatchReject, :PresetApproverInfo
 
-        def initialize(flowapproverinfo=nil, agent=nil, operator=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, operator=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
           @Operator = operator
@@ -1941,6 +1943,7 @@ module TencentCloud
           @Intention = intention
           @CacheApproverInfo = cacheapproverinfo
           @CanBatchReject = canbatchreject
+          @PresetApproverInfo = presetapproverinfo
         end
 
         def deserialize(params)
@@ -1972,6 +1975,10 @@ module TencentCloud
           end
           @CacheApproverInfo = params['CacheApproverInfo']
           @CanBatchReject = params['CanBatchReject']
+          unless params['PresetApproverInfo'].nil?
+            @PresetApproverInfo = PresetApproverInfo.new
+            @PresetApproverInfo.deserialize(params['PresetApproverInfo'])
+          end
         end
       end
 
@@ -2006,12 +2013,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 Agent: 代理企业和员工的信息。
         # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -2021,14 +2035,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>
@@ -2445,12 +2463,36 @@ module TencentCloud
         # <ul><li>CREATE_SEAL: 生成创建印章的嵌入页面</li>
         # <li>CREATE_TEMPLATE：生成创建模板的嵌入页面</li>
         # <li>MODIFY_TEMPLATE：生成编辑模板的嵌入页面</li>
+        # <li>CREATE_CONTRACT_DRAFT_COOPEDIT：生成创建起草合同的嵌入页面</li>
         # <li>PREVIEW_TEMPLATE：生成预览模板的嵌入页面</li>
         # <li>PREVIEW_SEAL_LIST：生成预览印章列表的嵌入页面</li>
         # <li>PREVIEW_SEAL_DETAIL：生成预览印章详情的嵌入页面</li>
         # <li>EXTEND_SERVICE：生成拓展服务的嵌入页面</li>
         # <li>PREVIEW_FLOW：生成预览合同的嵌入页面（支持移动端）</li>
         # <li>PREVIEW_FLOW_DETAIL：生成查看合同详情的嵌入页面（仅支持PC端）</li></ul>
+
+        # 注意：
+        # 不同的嵌入类型，操作人需要的权限项不同（权限配置可参考[权限配置](https://qian.tencent.com/document/61355)）。
+        # <table  border="1">
+        # <thead>
+        # <tr><th>EmbedType</th><th>权限</th></tr>
+        # </thead>
+        # <tbody>
+        # <tr><th>CREATE_SEAL</th><th>印章管理-添加印章</th></tr>
+        # <tr><th>CREATE_TEMPLATE</th><th>模板管理-创建模板</th></tr>
+        # <tr><th>MODIFY_TEMPLATE</th><th>模板管理-编辑模板</th></tr>
+        # <tr><th>CREATE_CONTRACT_DRAFT_COOPEDIT</th><th>合同管理-起草合同</th></tr>
+        # <tr><th>PREVIEW_TEMPLATE</th><th>拥有下面三种权限的一种就行</br>
+        # 模板管理-查询模板（本企业全部模板）</br>
+        # 模板管理-查询模板（本部门全部模板）</br>
+        # 模板管理-查询模板（本人创建模板）</th></tr>
+        # <tr><th>PREVIEW_SEAL_LIST</th><th>印章管理</th></tr>
+        # <tr><th>PREVIEW_SEAL_DETAIL</th><th>印章管理</th></tr>
+        # <tr><th>EXTEND_SERVICE</th><th>无要求</th></tr>
+        # <tr><th>PREVIEW_FLOW</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr>
+        # <tr><th>PREVIEW_FLOW_DETAIL</th><th>是否是当前合同的参与方，或者发起方企业的法人、超管、合同管理员</th></tr>
+        # </tbody>
+        # </table>
         # @type EmbedType: String
         # @param BusinessId: WEB嵌入的业务资源ID
 
@@ -2459,12 +2501,14 @@ module TencentCloud
         # <li>为PREVIEW_SEAL_DETAIL，必填，取值为印章id。</li>
         # <li>为CREATE_TEMPLATE，非必填，取值为资源id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
         # <li>为MODIFY_TEMPLATE，PREVIEW_TEMPLATE，必填，取值为模板id。</li>
+        # <li>为CREATE_CONTRACT_DRAFT_COOPEDIT，非必填，取值为资源 id。*资源Id获取可使用接口[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)*</li>
         # <li>为PREVIEW_FLOW，PREVIEW_FLOW_DETAIL，必填，取值为合同id。</li>
         # </ul>
 
         # 注意：
         #  1. CREATE_TEMPLATE中的BusinessId仅支持PDF文件类型， 如果您的文件不是PDF， 请使用接口[创建文件转换任务
         # ](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi) 和[查询转换任务状态](https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi) 来进行转换成PDF资源。
+        #  2. CREATE_CONTRACT_DRAFT_COOPEDIT中的BusinessId仅支持DOC 和 DOCX 的文件，并且大小不能超过 10M。
         # @type BusinessId: String
         # @param Agent: 代理企业和员工的信息。
         # <br/>在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
@@ -2514,6 +2558,8 @@ module TencentCloud
       # CreateEmbedWebUrl返回参数结构体
       class CreateEmbedWebUrlResponse < TencentCloud::Common::AbstractModel
         # @param WebUrl: 嵌入的web链接，有效期：5分钟
+        # 链接仅能使用一次
+        # 建议：每次都用接口生成链接，保证链接的有效性
         # <br/>EmbedType=PREVIEW_CC_FLOW，该url为h5链接
         # @type WebUrl: String
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
@@ -5774,18 +5820,26 @@ module TencentCloud
         # @param OrganizationName: 合同流程签署方的组织机构名称。如果名称中包含英文括号()，请使用中文括号（）代替。注: `获取B端动态签署人领取链接时,可指定此字段来预先设定签署人的企业,预设后只能以该企业身份去领取合同并完成签署`
         # @type OrganizationName: String
         # @param Name: 合同流程里边签署方经办人的姓名。
+
+        # `注：在动态签署人补充链接场景中，可以通过传入这个值，对补充的个人参与方信息进行限制。仅匹配传入姓名的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
         # @type Name: String
         # @param Mobile: 合同流程里边签署方经办人手机号码， 支持国内手机号11位数字(无需加+86前缀或其他字符)。
+
+        # `注：在动态签署人补充链接场景中，可以通过传入此值，对补充的个人参与方信息进行限制。仅匹配传入手机号的参与方才能补充合同。此参数预设信息功能暂时仅支持个人动态参与方。`
         # @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 EndPoint: 要跳转的链接类型
 
@@ -9227,7 +9281,7 @@ module TencentCloud
         # - true: 不展示上传文件页
 
 
-        # 注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)有效**，
+        # 注意: 此参数仅针对**EmbedType=CREATE_TEMPLATE(创建模板)和EmbedType=CREATE_CONTRACT_DRAFT_COOPEDIT(创建起草合同)有效**，
         # @type SkipUploadFile: Boolean
 
         attr_accessor :ShowFlowDetailComponent, :ShowTemplateComponent, :SkipUploadFile
@@ -11677,6 +11731,63 @@ module TencentCloud
         end
       end
 
+      # OperateTemplate请求参数结构体
+      class OperateTemplateRequest < TencentCloud::Common::AbstractModel
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
+        # @param TemplateId: 模板ID，为32位字符串。
+        # @type TemplateId: String
+        # @param OperateType: 操作类型，可取值如下:
+        # <ul>
+        # <li>DELETE:  删除</li>
+        # <li>ENABLE: 启用</li>
+        # <li>DISABLE: 停用</li>
+        # </ul>
+        # @type OperateType: String
+        # @param Agent: 代理企业和员工的信息。
+        # 在集团企业代理子企业操作的场景中，需设置此参数。在此情境下，ProxyOrganizationId（子企业的组织ID）为必填项。
+        # @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
+
+        attr_accessor :Operator, :TemplateId, :OperateType, :Agent
+
+        def initialize(operator=nil, templateid=nil, operatetype=nil, agent=nil)
+          @Operator = operator
+          @TemplateId = templateid
+          @OperateType = operatetype
+          @Agent = agent
+        end
+
+        def deserialize(params)
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @TemplateId = params['TemplateId']
+          @OperateType = params['OperateType']
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+        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 OrgBillSummary < TencentCloud::Common::AbstractModel
         # @param Total: 套餐总数
@@ -12034,6 +12145,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 Recipient < TencentCloud::Common::AbstractModel
         # @param RecipientId: 签署参与者ID，唯一标识

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tencentcloud-sdk-ess
 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