tencentcloud-sdk-essbasic 3.0.671 → 3.0.673

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fd73384a67d20e787678cd8328056cd2bc27fc15
-  data.tar.gz: 3c6b588a1853d5da8e2fd24f5a60ffe0fc931bdc
+  metadata.gz: d0611f3edc45b9233e7fbd9808361ee663b253a1
+  data.tar.gz: 64c07a513636da8cf18498e2674e0eeb7ba01f5e
 SHA512:
-  metadata.gz: 7ffcf2f211f89fdbee27089c37b076da44731537f00674aacda38cc1894826009fdec68eebc3d8c4a76264f36ac19d9260528013f655192b9d2e5c144ed647fb
-  data.tar.gz: d16cdac377b857e63af339e6a96488afbf1a69bfac32539a2a4c54daecd778dddb449a4dbdb92cab62236471ca3e77f6b1c7e2f573f4a7fd9af48f1aa3c3aea4
+  metadata.gz: cf315ca493ebf72041ea2c39eeafd206824a04a6c96eef6c3ff4baf9862a5163c35f3f79c6f0a57cf709b9be43b3ad49866cafd339ae729439354bf671c72667
+  data.tar.gz: 334f65da43e243e57ab8dc23711f5df77ee907274a357d56ddf5a4c7096c7beaac14255e47cf650d1c9184dfec8110f61dc67131f39d747e376851d0cb25bb58

data/lib/VERSION

@@ -1 +1 @@
-3.0.671
+3.0.673

data/lib/v20210526/client.rb

@@ -274,6 +274,35 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 适用场景：
+        # 当通过模板或文件发起合同时，若未指定企业签署人信息，则可调用此接口动态补充签署人。同一签署人只允许补充一人，最终实际签署人取决于谁先领取合同完成签署。
+
+        # 限制条件：
+        # 1. 本企业（发起方企业）企业签署人仅支持通过企业名称+姓名+手机号进行补充。
+        # 2. 个人签署人仅支持通过姓名+手机号进行补充。
+
+        # @param request: Request instance for ChannelCreateFlowApprovers.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowApproversRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowApproversResponse`
+        def ChannelCreateFlowApprovers(request)
+          body = send_request('ChannelCreateFlowApprovers', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCreateFlowApproversResponse.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
+
         # 接口（ChannelCreateFlowByFiles）用于通过文件创建签署流程。此接口静默签能力不可直接使用，请联系客户经理申请使用
 
         # @param request: Request instance for ChannelCreateFlowByFiles.
@@ -466,6 +495,35 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 通过此接口，创建小程序批量签署链接，可以创建企业批量签署链接，员工只需点击链接即可跳转至控制台进行批量签署。
+
+        # 注：
+        # - 员工必须在企业下完成实名认证，且需作为批量签署合同的签署方或者领取方。
+        # - 仅支持传入待签署或者待领取的合同，待填写暂不支持。
+        # - 员工批量签署，支持多种签名方式，包括手写签名、临摹签名、系统签名、个人印章，暂不支持签批控件
+
+        # @param request: Request instance for ChannelCreateOrganizationBatchSignUrl.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlResponse`
+        def ChannelCreateOrganizationBatchSignUrl(request)
+          body = send_request('ChannelCreateOrganizationBatchSignUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCreateOrganizationBatchSignUrlResponse.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
+
         # 生成渠道子客编辑企业信息二维码
 
         # @param request: Request instance for ChannelCreateOrganizationModifyQrCode.
@@ -643,6 +701,37 @@ module TencentCloud
           raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
         end
 
+        # 获取设置自动签印章小程序链接。
+
+        # 注意：
+        # <ul><li>需要<code>企业开通自动签</code>后使用。</li>
+        # <li>仅支持<code>已经开通了自动签的个人</code>更换自动签印章。</li>
+        # <li>链接有效期默认7天，<code>最多30天</code>。</li>
+        # <li>该接口的链接适用于<code>小程序</code>端。</li>
+        # <li>该接口不会扣除您的合同套餐，暂不参与计费。</li></ul>
+
+        # @param request: Request instance for ChannelCreateUserAutoSignSealUrl.
+        # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserAutoSignSealUrlRequest`
+        # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateUserAutoSignSealUrlResponse`
+        def ChannelCreateUserAutoSignSealUrl(request)
+          body = send_request('ChannelCreateUserAutoSignSealUrl', request.serialize)
+          response = JSON.parse(body)
+          if response['Response'].key?('Error') == false
+            model = ChannelCreateUserAutoSignSealUrlResponse.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
+
         # 通过此接口，绑定员工角色，支持以电子签userId、客户系统userId两种方式调用。
 
         # @param request: Request instance for ChannelCreateUserRoles.

data/lib/v20210526/models.rb

@@ -968,6 +968,74 @@ module TencentCloud
         end
       end
 
+      # ChannelCreateFlowApprovers请求参数结构体
+      class ChannelCreateFlowApproversRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 渠道应用相关信息
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param FlowId: 合同唯一编号
+        # @type FlowId: String
+        # @param Approvers: 补充企业签署人信息。
+
+        # - 如果发起方指定的补充签署人是企业签署人，则需要提供企业名称或者企业OpenId；
+
+        # - 如果不指定，则使用姓名和手机号进行补充。
+        # @type Approvers: Array
+        # @param Operator: 操作人信息
+        # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param FillApproverType: 签署人信息补充方式
+
+        # <ul><li>**0**: 补充或签人，支持补充多个企业经办签署人（默认）注: `不可补充个人签署人`</li>
+        # <li>**1**: 补充动态签署人，可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的，一个节点只支持传入一个签署人信息`</li></ul>
+        # @type FillApproverType: Integer
+
+        attr_accessor :Agent, :FlowId, :Approvers, :Operator, :FillApproverType
+
+        def initialize(agent=nil, flowid=nil, approvers=nil, operator=nil, fillapprovertype=nil)
+          @Agent = agent
+          @FlowId = flowid
+          @Approvers = approvers
+          @Operator = operator
+          @FillApproverType = fillapprovertype
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @FlowId = params['FlowId']
+          unless params['Approvers'].nil?
+            @Approvers = []
+            params['Approvers'].each do |i|
+              fillapproverinfo_tmp = FillApproverInfo.new
+              fillapproverinfo_tmp.deserialize(i)
+              @Approvers << fillapproverinfo_tmp
+            end
+          end
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @FillApproverType = params['FillApproverType']
+        end
+      end
+
+      # ChannelCreateFlowApprovers返回参数结构体
+      class ChannelCreateFlowApproversResponse < TencentCloud::Common::AbstractModel
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :RequestId
+
+        def initialize(requestid=nil)
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCreateFlowByFiles请求参数结构体
       class ChannelCreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
@@ -1607,6 +1675,68 @@ module TencentCloud
         end
       end
 
+      # ChannelCreateOrganizationBatchSignUrl请求参数结构体
+      class ChannelCreateOrganizationBatchSignUrlRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 关于渠道应用的相关信息，包括子客企业及应用编、号等详细内容，您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param FlowIds: 请指定需执行批量签署的流程ID，数量范围为1-100。 您可登录腾讯电子签控制台，浏览 "合同"->"合同中心" 以查阅某一合同的FlowId（在页面中显示为合同ID）。 用户将利用链接对这些合同实施批量操作。
+        # @type FlowIds: Array
+        # @param OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台，在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同（FlowId）中的签署人。 - 1. 若OpenId为空，Name和Mobile 必须提供。 - 2. 若OpenId 与 Name，Mobile均存在，将优先采用OpenId对应的员工。
+        # @type OpenId: String
+        # @param Name: 签署方经办人的姓名。
+        # 经办人的姓名将用于身份认证和电子签名，请确保填写的姓名为签署方的真实姓名，而非昵称等代名。
+
+        # 注：`请确保和合同中填入的一致`
+        # @type Name: String
+        # @param Mobile: 员工手机号，必须与姓名一起使用。 如果OpenId为空，则此字段不能为空。同时，姓名和手机号码必须与传入合同（FlowId）中的签署人信息一致。
+        # @type Mobile: String
+
+        attr_accessor :Agent, :FlowIds, :OpenId, :Name, :Mobile
+
+        def initialize(agent=nil, flowids=nil, openid=nil, name=nil, mobile=nil)
+          @Agent = agent
+          @FlowIds = flowids
+          @OpenId = openid
+          @Name = name
+          @Mobile = mobile
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @FlowIds = params['FlowIds']
+          @OpenId = params['OpenId']
+          @Name = params['Name']
+          @Mobile = params['Mobile']
+        end
+      end
+
+      # ChannelCreateOrganizationBatchSignUrl返回参数结构体
+      class ChannelCreateOrganizationBatchSignUrlResponse < TencentCloud::Common::AbstractModel
+        # @param SignUrl: 批量签署入口链接，用户可使用这个链接跳转到控制台页面对合同进行签署操作。
+        # @type SignUrl: String
+        # @param ExpiredTime: 链接过期时间以 Unix 时间戳格式表示，从生成链接时间起，往后7天有效期。过期后短链将失效，无法打开。
+        # @type ExpiredTime: Integer
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :SignUrl, :ExpiredTime, :RequestId
+
+        def initialize(signurl=nil, expiredtime=nil, requestid=nil)
+          @SignUrl = signurl
+          @ExpiredTime = expiredtime
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @SignUrl = params['SignUrl']
+          @ExpiredTime = params['ExpiredTime']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCreateOrganizationModifyQrCode请求参数结构体
       class ChannelCreateOrganizationModifyQrCodeRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 应用相关信息。 此接口Agent.AppId 必填。
@@ -2145,6 +2275,87 @@ module TencentCloud
         end
       end
 
+      # ChannelCreateUserAutoSignSealUrl请求参数结构体
+      class ChannelCreateUserAutoSignSealUrlRequest < TencentCloud::Common::AbstractModel
+        # @param Agent: 渠道应用相关信息。
+        # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
+        # @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
+        # <ul><li> **E_PRESCRIPTION_AUTO_SIGN** :  电子处方场景</li></ul>
+
+        # 注: `现在仅支持电子处方场景`
+        # @type SceneKey: String
+        # @param UserInfo: 自动签开通个人用户信息，包括名字，身份证等。
+        # @type UserInfo: :class:`Tencentcloud::Essbasic.v20210526.models.UserThreeFactor`
+        # @param Operator: 执行本接口操作的员工信息。
+        # 注: `在调用此接口时，请确保指定的员工已获得所需的接口调用权限，并具备接口传入的相应资源的数据权限。`
+        # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
+        # @param ExpiredTime: 链接的过期时间，格式为Unix时间戳，不能早于当前时间，且最大为当前时间往后30天。`如果不传，默认过期时间为当前时间往后7天。`
+        # @type ExpiredTime: Integer
+
+        attr_accessor :Agent, :SceneKey, :UserInfo, :Operator, :ExpiredTime
+
+        def initialize(agent=nil, scenekey=nil, userinfo=nil, operator=nil, expiredtime=nil)
+          @Agent = agent
+          @SceneKey = scenekey
+          @UserInfo = userinfo
+          @Operator = operator
+          @ExpiredTime = expiredtime
+        end
+
+        def deserialize(params)
+          unless params['Agent'].nil?
+            @Agent = Agent.new
+            @Agent.deserialize(params['Agent'])
+          end
+          @SceneKey = params['SceneKey']
+          unless params['UserInfo'].nil?
+            @UserInfo = UserThreeFactor.new
+            @UserInfo.deserialize(params['UserInfo'])
+          end
+          unless params['Operator'].nil?
+            @Operator = UserInfo.new
+            @Operator.deserialize(params['Operator'])
+          end
+          @ExpiredTime = params['ExpiredTime']
+        end
+      end
+
+      # ChannelCreateUserAutoSignSealUrl返回参数结构体
+      class ChannelCreateUserAutoSignSealUrlResponse < TencentCloud::Common::AbstractModel
+        # @param AppId: 腾讯电子签小程序的AppId，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
+        # @type AppId: String
+        # @param AppOriginalId: 腾讯电子签小程序的原始Id，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
+        # @type AppOriginalId: String
+        # @param Url: 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
+        # @type Url: String
+        # @param Path: 腾讯电子签小程序的跳转路径，用于其他小程序/APP等应用跳转至腾讯电子签小程序使用。
+        # @type Path: String
+        # @param QrCode: base64格式的跳转二维码图片，可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
+        # @type QrCode: String
+        # @param RequestId: 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
+        # @type RequestId: String
+
+        attr_accessor :AppId, :AppOriginalId, :Url, :Path, :QrCode, :RequestId
+
+        def initialize(appid=nil, apporiginalid=nil, url=nil, path=nil, qrcode=nil, requestid=nil)
+          @AppId = appid
+          @AppOriginalId = apporiginalid
+          @Url = url
+          @Path = path
+          @QrCode = qrcode
+          @RequestId = requestid
+        end
+
+        def deserialize(params)
+          @AppId = params['AppId']
+          @AppOriginalId = params['AppOriginalId']
+          @Url = params['Url']
+          @Path = params['Path']
+          @QrCode = params['QrCode']
+          @RequestId = params['RequestId']
+        end
+      end
+
       # ChannelCreateUserRoles请求参数结构体
       class ChannelCreateUserRolesRequest < TencentCloud::Common::AbstractModel
         # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
@@ -4126,6 +4337,7 @@ module TencentCloud
         # - NOT_CHANNEL：非第三方平台子客企业企业
         # - PERSON：个人
         # - FOLLOWER：关注方，目前是合同抄送方
+        # - RECIPIENT：获取RecipientId对应的签署链接，可用于生成动态签署人补充链接
         # @type GenerateType: String
         # @param OrganizationName: 非第三方平台子客企业参与方的企业名称，GenerateType为"NOT_CHANNEL"时必填
         # @type OrganizationName: String
@@ -4152,7 +4364,7 @@ module TencentCloud
         # - 2:合同签署页面更多操作的转他人处理按钮
         # - 3:签署成功页的查看详情按钮
         # @type Hides: Array
-        # @param RecipientIds: 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致
+        # @param RecipientIds: 签署节点ID，用于补充动态签署人，使用此参数需要与flow_ids数量一致并且一一对应
         # @type RecipientIds: Array
 
         attr_accessor :Agent, :FlowIds, :FlowGroupId, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :Hides, :RecipientIds
@@ -4799,6 +5011,47 @@ module TencentCloud
         end
       end
 
+      # 指定补充签署人信息
+      # - RecipientId 必须指定
+      class FillApproverInfo < TencentCloud::Common::AbstractModel
+        # @param RecipientId: 签署方经办人在模板中配置的参与方ID，与控件绑定，是控件的归属方，ID为32位字符串。
+        # @type RecipientId: String
+        # @param OpenId: 指定企业经办签署人OpenId
+        # @type OpenId: String
+        # @param ApproverName: 签署人姓名
+        # @type ApproverName: String
+        # @param ApproverMobile: 签署人手机号码
+        # @type ApproverMobile: String
+        # @param OrganizationName: 企业名称
+        # @type OrganizationName: String
+        # @param OrganizationOpenId: 企业OpenId
+        # @type OrganizationOpenId: String
+        # @param NotChannelOrganization: 签署企业非渠道子客，默认为false，即表示同一渠道下的企业；如果为true，则目前表示接收方企业为SaaS企业, 为渠道子客时，organization_open_id+open_id 必传
+        # @type NotChannelOrganization: String
+
+        attr_accessor :RecipientId, :OpenId, :ApproverName, :ApproverMobile, :OrganizationName, :OrganizationOpenId, :NotChannelOrganization
+
+        def initialize(recipientid=nil, openid=nil, approvername=nil, approvermobile=nil, organizationname=nil, organizationopenid=nil, notchannelorganization=nil)
+          @RecipientId = recipientid
+          @OpenId = openid
+          @ApproverName = approvername
+          @ApproverMobile = approvermobile
+          @OrganizationName = organizationname
+          @OrganizationOpenId = organizationopenid
+          @NotChannelOrganization = notchannelorganization
+        end
+
+        def deserialize(params)
+          @RecipientId = params['RecipientId']
+          @OpenId = params['OpenId']
+          @ApproverName = params['ApproverName']
+          @ApproverMobile = params['ApproverMobile']
+          @OrganizationName = params['OrganizationName']
+          @OrganizationOpenId = params['OrganizationOpenId']
+          @NotChannelOrganization = params['NotChannelOrganization']
+        end
+      end
+
       # 文档内的填充控件返回结构体，返回控件的基本信息和填写内容值
       class FilledComponent < TencentCloud::Common::AbstractModel
         # @param ComponentId: 控件Id

metadata

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