tencentcloud-sdk-essbasic 3.0.671 → 3.0.672

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: fd73384a67d20e787678cd8328056cd2bc27fc15
4
- data.tar.gz: 3c6b588a1853d5da8e2fd24f5a60ffe0fc931bdc
3
+ metadata.gz: 5774ef174066d9554a0d407d359b0be82c8af165
4
+ data.tar.gz: f04d4e87d1b3232a0863283eca9130f636ba6879
5
5
  SHA512:
6
- metadata.gz: 7ffcf2f211f89fdbee27089c37b076da44731537f00674aacda38cc1894826009fdec68eebc3d8c4a76264f36ac19d9260528013f655192b9d2e5c144ed647fb
7
- data.tar.gz: d16cdac377b857e63af339e6a96488afbf1a69bfac32539a2a4c54daecd778dddb449a4dbdb92cab62236471ca3e77f6b1c7e2f573f4a7fd9af48f1aa3c3aea4
6
+ metadata.gz: e6f4158110aeb737f194046cc82e875ce920cd5cfcbd4ad86e3bbfdc1ce5295ce08075b330bea8c892beea6de9411298f7a82cdc95a6123e13cf6f0030c59466
7
+ data.tar.gz: e1096057282b000b674ba9265718b05a67d8b6aced6f2e9021623a34d008607ed661a37d1b5133949e1bd91feb96d9712eb8b4757c68294a8add1bef16c26c70
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.671
1
+ 3.0.672
@@ -274,6 +274,35 @@ module TencentCloud
274
274
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
275
275
  end
276
276
 
277
+ # 适用场景:
278
+ # 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口动态补充签署人。同一签署人只允许补充一人,最终实际签署人取决于谁先领取合同完成签署。
279
+
280
+ # 限制条件:
281
+ # 1. 本企业(发起方企业)企业签署人仅支持通过企业名称+姓名+手机号进行补充。
282
+ # 2. 个人签署人仅支持通过姓名+手机号进行补充。
283
+
284
+ # @param request: Request instance for ChannelCreateFlowApprovers.
285
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowApproversRequest`
286
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateFlowApproversResponse`
287
+ def ChannelCreateFlowApprovers(request)
288
+ body = send_request('ChannelCreateFlowApprovers', request.serialize)
289
+ response = JSON.parse(body)
290
+ if response['Response'].key?('Error') == false
291
+ model = ChannelCreateFlowApproversResponse.new
292
+ model.deserialize(response['Response'])
293
+ model
294
+ else
295
+ code = response['Response']['Error']['Code']
296
+ message = response['Response']['Error']['Message']
297
+ reqid = response['Response']['RequestId']
298
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
299
+ end
300
+ rescue TencentCloud::Common::TencentCloudSDKException => e
301
+ raise e
302
+ rescue StandardError => e
303
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
304
+ end
305
+
277
306
  # 接口(ChannelCreateFlowByFiles)用于通过文件创建签署流程。此接口静默签能力不可直接使用,请联系客户经理申请使用
278
307
 
279
308
  # @param request: Request instance for ChannelCreateFlowByFiles.
@@ -466,6 +495,35 @@ module TencentCloud
466
495
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
467
496
  end
468
497
 
498
+ # 通过此接口,创建小程序批量签署链接,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
499
+
500
+ # 注:
501
+ # - 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
502
+ # - 仅支持传入待签署或者待领取的合同,待填写暂不支持。
503
+ # - 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章,暂不支持签批控件
504
+
505
+ # @param request: Request instance for ChannelCreateOrganizationBatchSignUrl.
506
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlRequest`
507
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelCreateOrganizationBatchSignUrlResponse`
508
+ def ChannelCreateOrganizationBatchSignUrl(request)
509
+ body = send_request('ChannelCreateOrganizationBatchSignUrl', request.serialize)
510
+ response = JSON.parse(body)
511
+ if response['Response'].key?('Error') == false
512
+ model = ChannelCreateOrganizationBatchSignUrlResponse.new
513
+ model.deserialize(response['Response'])
514
+ model
515
+ else
516
+ code = response['Response']['Error']['Code']
517
+ message = response['Response']['Error']['Message']
518
+ reqid = response['Response']['RequestId']
519
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
520
+ end
521
+ rescue TencentCloud::Common::TencentCloudSDKException => e
522
+ raise e
523
+ rescue StandardError => e
524
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
525
+ end
526
+
469
527
  # 生成渠道子客编辑企业信息二维码
470
528
 
471
529
  # @param request: Request instance for ChannelCreateOrganizationModifyQrCode.
@@ -968,6 +968,74 @@ module TencentCloud
968
968
  end
969
969
  end
970
970
 
971
+ # ChannelCreateFlowApprovers请求参数结构体
972
+ class ChannelCreateFlowApproversRequest < TencentCloud::Common::AbstractModel
973
+ # @param Agent: 渠道应用相关信息
974
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
975
+ # @param FlowId: 合同唯一编号
976
+ # @type FlowId: String
977
+ # @param Approvers: 补充企业签署人信息。
978
+
979
+ # - 如果发起方指定的补充签署人是企业签署人,则需要提供企业名称或者企业OpenId;
980
+
981
+ # - 如果不指定,则使用姓名和手机号进行补充。
982
+ # @type Approvers: Array
983
+ # @param Operator: 操作人信息
984
+ # @type Operator: :class:`Tencentcloud::Essbasic.v20210526.models.UserInfo`
985
+ # @param FillApproverType: 签署人信息补充方式
986
+
987
+ # <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
988
+ # <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
989
+ # @type FillApproverType: Integer
990
+
991
+ attr_accessor :Agent, :FlowId, :Approvers, :Operator, :FillApproverType
992
+
993
+ def initialize(agent=nil, flowid=nil, approvers=nil, operator=nil, fillapprovertype=nil)
994
+ @Agent = agent
995
+ @FlowId = flowid
996
+ @Approvers = approvers
997
+ @Operator = operator
998
+ @FillApproverType = fillapprovertype
999
+ end
1000
+
1001
+ def deserialize(params)
1002
+ unless params['Agent'].nil?
1003
+ @Agent = Agent.new
1004
+ @Agent.deserialize(params['Agent'])
1005
+ end
1006
+ @FlowId = params['FlowId']
1007
+ unless params['Approvers'].nil?
1008
+ @Approvers = []
1009
+ params['Approvers'].each do |i|
1010
+ fillapproverinfo_tmp = FillApproverInfo.new
1011
+ fillapproverinfo_tmp.deserialize(i)
1012
+ @Approvers << fillapproverinfo_tmp
1013
+ end
1014
+ end
1015
+ unless params['Operator'].nil?
1016
+ @Operator = UserInfo.new
1017
+ @Operator.deserialize(params['Operator'])
1018
+ end
1019
+ @FillApproverType = params['FillApproverType']
1020
+ end
1021
+ end
1022
+
1023
+ # ChannelCreateFlowApprovers返回参数结构体
1024
+ class ChannelCreateFlowApproversResponse < TencentCloud::Common::AbstractModel
1025
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1026
+ # @type RequestId: String
1027
+
1028
+ attr_accessor :RequestId
1029
+
1030
+ def initialize(requestid=nil)
1031
+ @RequestId = requestid
1032
+ end
1033
+
1034
+ def deserialize(params)
1035
+ @RequestId = params['RequestId']
1036
+ end
1037
+ end
1038
+
971
1039
  # ChannelCreateFlowByFiles请求参数结构体
972
1040
  class ChannelCreateFlowByFilesRequest < TencentCloud::Common::AbstractModel
973
1041
  # @param Agent: 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
@@ -1607,6 +1675,68 @@ module TencentCloud
1607
1675
  end
1608
1676
  end
1609
1677
 
1678
+ # ChannelCreateOrganizationBatchSignUrl请求参数结构体
1679
+ class ChannelCreateOrganizationBatchSignUrlRequest < TencentCloud::Common::AbstractModel
1680
+ # @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1681
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
1682
+ # @param FlowIds: 请指定需执行批量签署的流程ID,数量范围为1-100。 您可登录腾讯电子签控制台,浏览 "合同"->"合同中心" 以查阅某一合同的FlowId(在页面中显示为合同ID)。 用户将利用链接对这些合同实施批量操作。
1683
+ # @type FlowIds: Array
1684
+ # @param OpenId: 第三方应用平台的用户openid。 您可登录腾讯电子签控制台,在 "更多能力"->"组织管理" 中查阅某位员工的OpenId。 OpenId必须是传入合同(FlowId)中的签署人。 - 1. 若OpenId为空,Name和Mobile 必须提供。 - 2. 若OpenId 与 Name,Mobile均存在,将优先采用OpenId对应的员工。
1685
+ # @type OpenId: String
1686
+ # @param Name: 签署方经办人的姓名。
1687
+ # 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
1688
+
1689
+ # 注:`请确保和合同中填入的一致`
1690
+ # @type Name: String
1691
+ # @param Mobile: 员工手机号,必须与姓名一起使用。 如果OpenId为空,则此字段不能为空。同时,姓名和手机号码必须与传入合同(FlowId)中的签署人信息一致。
1692
+ # @type Mobile: String
1693
+
1694
+ attr_accessor :Agent, :FlowIds, :OpenId, :Name, :Mobile
1695
+
1696
+ def initialize(agent=nil, flowids=nil, openid=nil, name=nil, mobile=nil)
1697
+ @Agent = agent
1698
+ @FlowIds = flowids
1699
+ @OpenId = openid
1700
+ @Name = name
1701
+ @Mobile = mobile
1702
+ end
1703
+
1704
+ def deserialize(params)
1705
+ unless params['Agent'].nil?
1706
+ @Agent = Agent.new
1707
+ @Agent.deserialize(params['Agent'])
1708
+ end
1709
+ @FlowIds = params['FlowIds']
1710
+ @OpenId = params['OpenId']
1711
+ @Name = params['Name']
1712
+ @Mobile = params['Mobile']
1713
+ end
1714
+ end
1715
+
1716
+ # ChannelCreateOrganizationBatchSignUrl返回参数结构体
1717
+ class ChannelCreateOrganizationBatchSignUrlResponse < TencentCloud::Common::AbstractModel
1718
+ # @param SignUrl: 批量签署入口链接,用户可使用这个链接跳转到控制台页面对合同进行签署操作。
1719
+ # @type SignUrl: String
1720
+ # @param ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
1721
+ # @type ExpiredTime: Integer
1722
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1723
+ # @type RequestId: String
1724
+
1725
+ attr_accessor :SignUrl, :ExpiredTime, :RequestId
1726
+
1727
+ def initialize(signurl=nil, expiredtime=nil, requestid=nil)
1728
+ @SignUrl = signurl
1729
+ @ExpiredTime = expiredtime
1730
+ @RequestId = requestid
1731
+ end
1732
+
1733
+ def deserialize(params)
1734
+ @SignUrl = params['SignUrl']
1735
+ @ExpiredTime = params['ExpiredTime']
1736
+ @RequestId = params['RequestId']
1737
+ end
1738
+ end
1739
+
1610
1740
  # ChannelCreateOrganizationModifyQrCode请求参数结构体
1611
1741
  class ChannelCreateOrganizationModifyQrCodeRequest < TencentCloud::Common::AbstractModel
1612
1742
  # @param Agent: 应用相关信息。 此接口Agent.AppId 必填。
@@ -4126,6 +4256,7 @@ module TencentCloud
4126
4256
  # - NOT_CHANNEL:非第三方平台子客企业企业
4127
4257
  # - PERSON:个人
4128
4258
  # - FOLLOWER:关注方,目前是合同抄送方
4259
+ # - RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
4129
4260
  # @type GenerateType: String
4130
4261
  # @param OrganizationName: 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
4131
4262
  # @type OrganizationName: String
@@ -4152,7 +4283,7 @@ module TencentCloud
4152
4283
  # - 2:合同签署页面更多操作的转他人处理按钮
4153
4284
  # - 3:签署成功页的查看详情按钮
4154
4285
  # @type Hides: Array
4155
- # @param RecipientIds: 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致
4286
+ # @param RecipientIds: 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
4156
4287
  # @type RecipientIds: Array
4157
4288
 
4158
4289
  attr_accessor :Agent, :FlowIds, :FlowGroupId, :Endpoint, :GenerateType, :OrganizationName, :Name, :Mobile, :OrganizationOpenId, :OpenId, :AutoJumpBack, :JumpUrl, :Operator, :Hides, :RecipientIds
@@ -4799,6 +4930,47 @@ module TencentCloud
4799
4930
  end
4800
4931
  end
4801
4932
 
4933
+ # 指定补充签署人信息
4934
+ # - RecipientId 必须指定
4935
+ class FillApproverInfo < TencentCloud::Common::AbstractModel
4936
+ # @param RecipientId: 签署方经办人在模板中配置的参与方ID,与控件绑定,是控件的归属方,ID为32位字符串。
4937
+ # @type RecipientId: String
4938
+ # @param OpenId: 指定企业经办签署人OpenId
4939
+ # @type OpenId: String
4940
+ # @param ApproverName: 签署人姓名
4941
+ # @type ApproverName: String
4942
+ # @param ApproverMobile: 签署人手机号码
4943
+ # @type ApproverMobile: String
4944
+ # @param OrganizationName: 企业名称
4945
+ # @type OrganizationName: String
4946
+ # @param OrganizationOpenId: 企业OpenId
4947
+ # @type OrganizationOpenId: String
4948
+ # @param NotChannelOrganization: 签署企业非渠道子客,默认为false,即表示同一渠道下的企业;如果为true,则目前表示接收方企业为SaaS企业, 为渠道子客时,organization_open_id+open_id 必传
4949
+ # @type NotChannelOrganization: String
4950
+
4951
+ attr_accessor :RecipientId, :OpenId, :ApproverName, :ApproverMobile, :OrganizationName, :OrganizationOpenId, :NotChannelOrganization
4952
+
4953
+ def initialize(recipientid=nil, openid=nil, approvername=nil, approvermobile=nil, organizationname=nil, organizationopenid=nil, notchannelorganization=nil)
4954
+ @RecipientId = recipientid
4955
+ @OpenId = openid
4956
+ @ApproverName = approvername
4957
+ @ApproverMobile = approvermobile
4958
+ @OrganizationName = organizationname
4959
+ @OrganizationOpenId = organizationopenid
4960
+ @NotChannelOrganization = notchannelorganization
4961
+ end
4962
+
4963
+ def deserialize(params)
4964
+ @RecipientId = params['RecipientId']
4965
+ @OpenId = params['OpenId']
4966
+ @ApproverName = params['ApproverName']
4967
+ @ApproverMobile = params['ApproverMobile']
4968
+ @OrganizationName = params['OrganizationName']
4969
+ @OrganizationOpenId = params['OrganizationOpenId']
4970
+ @NotChannelOrganization = params['NotChannelOrganization']
4971
+ end
4972
+ end
4973
+
4802
4974
  # 文档内的填充控件返回结构体,返回控件的基本信息和填写内容值
4803
4975
  class FilledComponent < TencentCloud::Common::AbstractModel
4804
4976
  # @param ComponentId: 控件Id
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.671
4
+ version: 3.0.672
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-10-07 00:00:00.000000000 Z
11
+ date: 2023-10-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common