tencentcloud-sdk-essbasic 3.0.1168 → 3.0.1171

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a966d01b4b58737849a9793e366c8cb34670c4d5
-  data.tar.gz: 27afa69f19b3b11f032e92a78f25baa4795639c9
+  metadata.gz: 7de380baaf708983a48ee279237eb8905dd3bf79
+  data.tar.gz: f2900bafd02e227b16a8ff57075a870482f25399
 SHA512:
-  metadata.gz: 038578e55d8989189a5cf726b33e7b83ca04f3c614da3af1deb2ab1d5aca3ea47d7b2d30accfbbd2300bea18c40ee297163fb885783b940ea7acbaed4e5c9acc
-  data.tar.gz: a523f657ca9e2ea1334a87f1ea9edd00468c9883844cf7b68d9c7432edb47a0b50ed03b4e36356bdc95267cc72948fa418da078fb47699c3276dd9d9587244bd
+  metadata.gz: 7f79601946c73db955a9cb553a33dda72e69b7bfb1d598f782ceab0d8608ae6acda44368ee31803eca2b4083a639febc4d1a9f9b1b6ba893e0cb679fe0f82dc3
+  data.tar.gz: f4e913204f81fbaa017d2fff7d457e10bd9228f0a6f9b168c82f24249c4c70384c2b0fbb69701e3478f4b5413886820e8737f9a0aa65f8be970029d795711c7a

data/lib/VERSION

@@ -1 +1 @@
-3.0.1168
+3.0.1171

data/lib/v20210526/client.rb

@@ -258,7 +258,7 @@ module TencentCloud
         # - 个人参与方点击链接后需短信验证码才能查看合同内容。
         # - 个人用户批量签署，需要传Name，Mobile，IdCardNumber(IdCardType) 参数。
         # - saas企业员工用户批量签署，在传递了姓名等基本信息参数的情况下，还需要传OrganizationName（参与方所在企业名称）参数生成签署链接，<font color="red">请确保此企业已完成腾讯电子签企业认证</font>。
-        # - 子客企业员工用户批量签署，需要传递员工OpenId和子客企业的OrganizationOpenId。<font color="red">请确保此OrganizationOpenId对应子客已经认证，且OpenId对应员工此子客下已经实名</font>。Name，Mobile, IdCard等信息此时可以不传，系统会查询此OpenId实名信息自动补充。
+        # - 子客企业员工用户批量签署，需要传递员工OpenId和子客企业的OrganizationOpenId，以及该员工的Name，Mobile等信息。如果此子客企业未认证，则除了上述参数之外，需要传递OrganizationName（子客企业名称）。
         # - 生成批量签署链接时，合同目标参与方状态需为<font color="red">待签署</font>状态。
         # - 个人批量签署进行的合同的签名区， 全部变成<font color="red">手写签名</font>（不管合同里边设置的签名限制）来进行。
         # - 不支持签署方含有签批控件，或设置了签署方在签署时自行添加签署控件功能的合同进行批量签署。

data/lib/v20210526/models.rb

@@ -1311,7 +1311,7 @@ module TencentCloud
         # <li>请确认该名称与企业营业执照中注册的名称一致。</li>
         # <li>如果名称中包含英文括号()，请使用中文括号（）代替。</li>
         # <li>请确保此企业已完成腾讯电子签企业认证。</li>
-        # <li>**若为子客企业员工，请使用OpenId，OrganizationOpenId参数，此参数留空即可**</li>
+        # <li>**若为子客企业员工，请使用OpenId，OrganizationOpenId参数。如果此子客企业未认证，则此参数需要传子客企业名称**</li>
         # </ul>
         # @type OrganizationName: String
         # @param SignatureTypes: 指定批量签署合同的签名类型，可传递以下值：<ul><li>**0**：手写签名</li><li>**1**：OCR楷体</li><li>**2**：姓名印章</li><li>**3**：图片印章</li><li>**4**：系统签名</li><li>**5**：长效手写签名（包含手写签名）</li></ul>注：<ul><li>不传值的情况则计算所有合同中个人签署区的签名类型，规则如下：<ul><li>1.如果所有合同中所有的个人签署区方式包含多种则是手写</li><li>2.如果所有合同中所有个人签名区签名类型仅为一种则就是那一种签名方式（例如合同1有多个签署区都是指定OCR楷体，合同2中也是多个签署区都是指定OCR楷体...则使用OCR楷体）</li></ul></li><li>该参数会覆盖您合同中的签名类型，若您在发起合同时限定了签名类型(赋值签名类型给ComponentTypeLimit)，请将这些签名类型赋予此参数</li><li>若签署方为企业员工，此参数无效，签名方式将以合同中为准。</li></ul>
@@ -2905,7 +2905,9 @@ module TencentCloud
       class ChannelCreatePrepareFlowRequest < TencentCloud::Common::AbstractModel
         # @param ResourceType: 资源类型，取值有：
         # <ul><li> **1**：模板</li>
-        # <li> **2**：文件（默认值）</li></ul>
+        # <li> **2**：文件（默认值）</li>
+        # <li> **3**：草稿</li>
+        # </ul>
         # @type ResourceType: Integer
         # @param FlowInfo: 要创建的合同信息
         # @type FlowInfo: :class:`Tencentcloud::Essbasic.v20210526.models.BaseFlowInfo`
@@ -2923,6 +2925,7 @@ module TencentCloud
         # <ul>
         # <li>文件Id（通过UploadFiles获取文件资源Id）</li>
         # <li>模板Id（通过控制台创建模板后获取模板Id）</li>
+        # <li>草稿Id（通过嵌入页面保存草稿后获取草稿Id）</li>
         # </ul>
         # 注意：需要同时设置 ResourceType 参数指定资源类型
         # @type ResourceId: String
@@ -3020,15 +3023,18 @@ module TencentCloud
         # @type PreviewFlowUrl: String
         # @param FlowId: 发起的合同临时Id， 只有当点击进入链接，成功发起合同后， 此Id才有效
         # @type FlowId: String
+        # @param DraftId: 临时的草稿id（还未实际保存草稿），用户可以记录此字段对应后续页面保存的草稿，若在页面上未保存草稿，则此字段无效。
+        # @type DraftId: String
         # @param RequestId: 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。
         # @type RequestId: String
 
-        attr_accessor :PrepareFlowUrl, :PreviewFlowUrl, :FlowId, :RequestId
+        attr_accessor :PrepareFlowUrl, :PreviewFlowUrl, :FlowId, :DraftId, :RequestId
 
-        def initialize(prepareflowurl=nil, previewflowurl=nil, flowid=nil, requestid=nil)
+        def initialize(prepareflowurl=nil, previewflowurl=nil, flowid=nil, draftid=nil, requestid=nil)
           @PrepareFlowUrl = prepareflowurl
           @PreviewFlowUrl = previewflowurl
           @FlowId = flowid
+          @DraftId = draftid
           @RequestId = requestid
         end
 
@@ -3036,6 +3042,7 @@ module TencentCloud
           @PrepareFlowUrl = params['PrepareFlowUrl']
           @PreviewFlowUrl = params['PreviewFlowUrl']
           @FlowId = params['FlowId']
+          @DraftId = params['DraftId']
           @RequestId = params['RequestId']
         end
       end
@@ -6346,13 +6353,19 @@ module TencentCloud
         # p.s.Endpoint如果是APP 类型，请传递JumpUrl为<font color="red">"true" </font>
         # 如果 Endpoint 是 H5 类型，请参考文档跳转电子签H5 p.s. 如果Endpoint是 APP，传递的跳转地址无效，不会进行跳转，仅会进行回跳。
         # @type JumpEvents: Array
+        # @param ProxyOrganizationIdCardType: 企业证照类型：
+        # <ul>
+        # <li> **USCC** :(默认)工商组织营业执照</li>
+        # <li> **PRACTICELICENSEOFMEDICALINSTITUTION** :医疗机构执业许可证</li>
+        # </ul>
+        # @type ProxyOrganizationIdCardType: String
 
-        attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :ProxyOperatorMobile, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :ProxyOperatorIdCardNumber, :AutoJumpUrl, :TopNavigationStatus, :AutoActive, :BusinessLicense, :ProxyAddress, :ProxyLegalName, :PowerOfAttorneys, :OrganizationAuthorizationOptions, :BankAccountNumber, :Operator, :JumpEvents
+        attr_accessor :Agent, :ProxyOrganizationName, :UniformSocialCreditCode, :ProxyOperatorName, :ProxyOperatorMobile, :Module, :ModuleId, :MenuStatus, :Endpoint, :AutoJumpBackEvent, :AuthorizationTypes, :ProxyOperatorIdCardNumber, :AutoJumpUrl, :TopNavigationStatus, :AutoActive, :BusinessLicense, :ProxyAddress, :ProxyLegalName, :PowerOfAttorneys, :OrganizationAuthorizationOptions, :BankAccountNumber, :Operator, :JumpEvents, :ProxyOrganizationIdCardType
         extend Gem::Deprecate
         deprecate :Operator, :none, 2025, 11
         deprecate :Operator=, :none, 2025, 11
 
-        def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, proxyoperatorname=nil, proxyoperatormobile=nil, _module=nil, moduleid=nil, menustatus=nil, endpoint=nil, autojumpbackevent=nil, authorizationtypes=nil, proxyoperatoridcardnumber=nil, autojumpurl=nil, topnavigationstatus=nil, autoactive=nil, businesslicense=nil, proxyaddress=nil, proxylegalname=nil, powerofattorneys=nil, organizationauthorizationoptions=nil, bankaccountnumber=nil, operator=nil, jumpevents=nil)
+        def initialize(agent=nil, proxyorganizationname=nil, uniformsocialcreditcode=nil, proxyoperatorname=nil, proxyoperatormobile=nil, _module=nil, moduleid=nil, menustatus=nil, endpoint=nil, autojumpbackevent=nil, authorizationtypes=nil, proxyoperatoridcardnumber=nil, autojumpurl=nil, topnavigationstatus=nil, autoactive=nil, businesslicense=nil, proxyaddress=nil, proxylegalname=nil, powerofattorneys=nil, organizationauthorizationoptions=nil, bankaccountnumber=nil, operator=nil, jumpevents=nil, proxyorganizationidcardtype=nil)
           @Agent = agent
           @ProxyOrganizationName = proxyorganizationname
           @UniformSocialCreditCode = uniformsocialcreditcode
@@ -6376,6 +6389,7 @@ module TencentCloud
           @BankAccountNumber = bankaccountnumber
           @Operator = operator
           @JumpEvents = jumpevents
+          @ProxyOrganizationIdCardType = proxyorganizationidcardtype
         end
 
         def deserialize(params)
@@ -6418,6 +6432,7 @@ module TencentCloud
               @JumpEvents << jumpevent_tmp
             end
           end
+          @ProxyOrganizationIdCardType = params['ProxyOrganizationIdCardType']
         end
       end
 
@@ -6832,10 +6847,79 @@ module TencentCloud
         # @type SelfName: String
         # @param HideSignCodeAfterStart: 发起后签署码隐藏，默认false，注：仅对新版页面生效
         # @type HideSignCodeAfterStart: Boolean
-
-        attr_accessor :CanEditFlow, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :ForbidEditApprover, :CustomCreateFlowDescription, :ForbidEditFillComponent, :SkipUploadFile, :SignComponentConfig, :ForbidEditWatermark, :PreviewAfterStart, :SignAfterStart, :HideOperationSteps, :SelfName, :HideSignCodeAfterStart
-
-        def initialize(caneditflow=nil, hideshowflowname=nil, hideshowflowtype=nil, hideshowdeadline=nil, canskipaddapprover=nil, forbideditapprover=nil, customcreateflowdescription=nil, forbideditfillcomponent=nil, skipuploadfile=nil, signcomponentconfig=nil, forbideditwatermark=nil, previewafterstart=nil, signafterstart=nil, hideoperationsteps=nil, selfname=nil, hidesigncodeafterstart=nil)
+        # @param NeedFlowDraft: 发起过程中是否保存草稿
+        # @type NeedFlowDraft: Boolean
+        # @param HideComponentTypes: 在发起流程的可嵌入页面要隐藏的控件列表，和 ShowComponentTypes 参数 只能二选一使用（注:
+        # <font color='red'>空数组代表未指定</font>），具体的控件类型如下
+
+        # <ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
+        # <li>SIGN_SEAL : 企业印章</li>
+        # <li>SIGN_PAGING_SEAL : 骑缝章</li>
+        # <li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
+        # <li>SIGN_APPROVE : 签批</li>
+        # <li>SIGN_OPINION : 签署意见</li>
+        # <li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li>
+        # <li>BUSI-FULL-NAME  : 企业全称</li>
+        # <li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
+        # <li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
+        # <li>PERSONAL-NAME : 签署人姓名</li>
+        # <li>PERSONAL-MOBILE : 签署人手机号</li>
+        # <li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
+        # <li>PERSONAL-IDCARD : 签署人证件号</li>
+        # <li>TEXT : 单行文本</li>
+        # <li>MULTI_LINE_TEXT : 多行文本</li>
+        # <li>CHECK_BOX : 勾选框</li>
+        # <li>SELECTOR : 选择器</li>
+        # <li>DIGIT : 数字</li>
+        # <li>DATE : 日期</li>
+        # <li>FILL_IMAGE : 图片</li>
+        # <li>ATTACHMENT : 附件</li>
+        # <li>EMAIL : 邮箱</li>
+        # <li>LOCATION : 地址</li>
+        # <li>EDUCATION : 学历</li>
+        # <li>GENDER : 性别</li>
+        # <li>DISTRICT : 省市区</li></ul>
+        # @type HideComponentTypes: Array
+        # @param ShowComponentTypes: 在发起流程的可嵌入页面要显示的控件列表，和 HideComponentTypes 参数 只能二选一使用（注:
+        # <font color='red'>空数组代表未指定</font>），具体的控件类型如下
+        # <ul><li>SIGN_SIGNATURE : 个人签名/印章</li>
+        # <li>SIGN_SEAL : 企业印章</li>
+        # <li>SIGN_PAGING_SEAL : 骑缝章</li>
+        # <li>SIGN_LEGAL_PERSON_SEAL : 法定代表人章</li>
+        # <li>SIGN_APPROVE : 签批</li>
+        # <li>SIGN_OPINION : 签署意见</li>
+        # <li>SIGN_PAGING_SIGNATURE : 手写签名骑缝控件</li>
+        # <li>BUSI-FULL-NAME  : 企业全称</li>
+        # <li>BUSI-CREDIT-CODE : 统一社会信用代码</li>
+        # <li>BUSI-LEGAL-NAME : 法人/经营者姓名</li>
+        # <li>PERSONAL-NAME : 签署人姓名</li>
+        # <li>PERSONAL-MOBILE : 签署人手机号</li>
+        # <li>PERSONAL-IDCARD-TYPE : 签署人证件类型</li>
+        # <li>PERSONAL-IDCARD : 签署人证件号</li>
+        # <li>TEXT : 单行文本</li>
+        # <li>MULTI_LINE_TEXT : 多行文本</li>
+        # <li>CHECK_BOX : 勾选框</li>
+        # <li>SELECTOR : 选择器</li>
+        # <li>DIGIT : 数字</li>
+        # <li>DATE : 日期</li>
+        # <li>FILL_IMAGE : 图片</li>
+        # <li>ATTACHMENT : 附件</li>
+        # <li>EMAIL : 邮箱</li>
+        # <li>LOCATION : 地址</li>
+        # <li>EDUCATION : 学历</li>
+        # <li>GENDER : 性别</li>
+        # <li>DISTRICT : 省市区</li></ul>
+        # @type ShowComponentTypes: Array
+        # @param ForbidAddApprover:  禁止添加签署方，若为true则在发起流程的可嵌入页面隐藏“添加签署人按钮”
+        # @type ForbidAddApprover: Boolean
+        # @param ForbidEditFlowProperties:   禁止设置签署流程属性 (顺序、合同签署认证方式等)，若为true则在发起流程的可嵌入页面隐藏签署流程设置面板
+        # @type ForbidEditFlowProperties: Boolean
+        # @param ResultPageConfig: 发起流程的可嵌入页面结果页配置
+        # @type ResultPageConfig: :class:`Tencentcloud::Essbasic.v20210526.models.CreateResultPageConfig`
+
+        attr_accessor :CanEditFlow, :HideShowFlowName, :HideShowFlowType, :HideShowDeadline, :CanSkipAddApprover, :ForbidEditApprover, :CustomCreateFlowDescription, :ForbidEditFillComponent, :SkipUploadFile, :SignComponentConfig, :ForbidEditWatermark, :PreviewAfterStart, :SignAfterStart, :HideOperationSteps, :SelfName, :HideSignCodeAfterStart, :NeedFlowDraft, :HideComponentTypes, :ShowComponentTypes, :ForbidAddApprover, :ForbidEditFlowProperties, :ResultPageConfig
+
+        def initialize(caneditflow=nil, hideshowflowname=nil, hideshowflowtype=nil, hideshowdeadline=nil, canskipaddapprover=nil, forbideditapprover=nil, customcreateflowdescription=nil, forbideditfillcomponent=nil, skipuploadfile=nil, signcomponentconfig=nil, forbideditwatermark=nil, previewafterstart=nil, signafterstart=nil, hideoperationsteps=nil, selfname=nil, hidesigncodeafterstart=nil, needflowdraft=nil, hidecomponenttypes=nil, showcomponenttypes=nil, forbidaddapprover=nil, forbideditflowproperties=nil, resultpageconfig=nil)
           @CanEditFlow = caneditflow
           @HideShowFlowName = hideshowflowname
           @HideShowFlowType = hideshowflowtype
@@ -6852,6 +6936,12 @@ module TencentCloud
           @HideOperationSteps = hideoperationsteps
           @SelfName = selfname
           @HideSignCodeAfterStart = hidesigncodeafterstart
+          @NeedFlowDraft = needflowdraft
+          @HideComponentTypes = hidecomponenttypes
+          @ShowComponentTypes = showcomponenttypes
+          @ForbidAddApprover = forbidaddapprover
+          @ForbidEditFlowProperties = forbideditflowproperties
+          @ResultPageConfig = resultpageconfig
         end
 
         def deserialize(params)
@@ -6874,6 +6964,15 @@ module TencentCloud
           @HideOperationSteps = params['HideOperationSteps']
           @SelfName = params['SelfName']
           @HideSignCodeAfterStart = params['HideSignCodeAfterStart']
+          @NeedFlowDraft = params['NeedFlowDraft']
+          @HideComponentTypes = params['HideComponentTypes']
+          @ShowComponentTypes = params['ShowComponentTypes']
+          @ForbidAddApprover = params['ForbidAddApprover']
+          @ForbidEditFlowProperties = params['ForbidEditFlowProperties']
+          unless params['ResultPageConfig'].nil?
+            @ResultPageConfig = CreateResultPageConfig.new
+            @ResultPageConfig.deserialize(params['ResultPageConfig'])
+          end
         end
       end
 
@@ -7369,6 +7468,32 @@ module TencentCloud
         end
       end
 
+      # 发起流程的可嵌入页面操作结果页配置
+      class CreateResultPageConfig < TencentCloud::Common::AbstractModel
+        # @param Type: <ul>
+        #   <li>0 : 发起审批成功页面（通过接口<a href="https://qian.tencent.com/developers/partnerApis/embedPages/ChannelCreatePrepareFlow" target="_blank">创建发起流程web页面</a>发起时设置了NeedCreateReview参数为true）</li>
+        # </ul>
+        # @type Type: Integer
+        # @param Title: 结果页标题，不超过50字
+        # @type Title: String
+        # @param Description: 结果页描述，不超过200字
+        # @type Description: String
+
+        attr_accessor :Type, :Title, :Description
+
+        def initialize(type=nil, title=nil, description=nil)
+          @Type = type
+          @Title = title
+          @Description = description
+        end
+
+        def deserialize(params)
+          @Type = params['Type']
+          @Title = params['Title']
+          @Description = params['Description']
+        end
+      end
+
       # CreateSealByImage请求参数结构体
       class CreateSealByImageRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 关于渠道应用的相关信息，包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -8882,7 +9007,10 @@ module TencentCloud
 
       # 动态合同信息
       class DynamicFlowInfo < TencentCloud::Common::AbstractModel
-        # @param FlowId: 合同流程ID，为32位字符串。 - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。 - 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。 - <font color="red">不建议继续使用</font>，请使用<a href="https://qian.tencent.com/developers/partnerApis/dataTypes/#fillapproverinfo/" target="_blank">补充签署人结构体</a>中的FlowId指定合同
+        # @param FlowId: 合同流程ID，为32位字符串。
+        # - FlowId 在通过[ChannelCreateFlowByFiles](https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowByFiles) 发起，可以在返回参数FlowId中获取。
+        # - 建议开发者妥善保存此流程ID，以便于顺利进行后续操作。
+        # - 可登录腾讯电子签控制台，在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
         # @type FlowId: String
         # @param FlowApprovers: 合同流程的参与方列表, 最多可支持50个参与方，可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息，不同类型的签署方传参方式可以参考文档 [签署方入参指引](https://qian.tencent.com/developers/partner/flow_approver)。 如果合同流程是有序签署，Approvers列表中参与人的顺序就是默认的签署顺序, 请确保列表中参与人的顺序符合实际签署顺序。
         # @type FlowApprovers: Array

metadata

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